Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: upgrade signal #1889

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/abc/auto-focus/demo/simple.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ order: 0
Simplest of usage.

```ts
import { Component } from '@angular/core';
import { Component, signal } from '@angular/core';

import { AutoFocusDirective } from '@delon/abc/auto-focus';
import { NzButtonModule } from 'ng-zorro-antd/button';
Expand All @@ -23,8 +23,8 @@ import { NzInputModule } from 'ng-zorro-antd/input';
@Component({
selector: 'app-demo',
template: `
<button nz-button (click)="showInput = !showInput">Toggle Input</button>
@if (showInput) {
<button nz-button (click)="showInput.set(!showInput())">Toggle Input</button>
@if (showInput()) {
<div class="mt-md">
<input nz-input auto-focus />
</div>
Expand All @@ -33,6 +33,6 @@ import { NzInputModule } from 'ng-zorro-antd/input';
imports: [NzButtonModule, NzInputModule, AutoFocusDirective]
})
export class DemoComponent {
showInput = false;
showInput = signal(false);
}
```
75 changes: 30 additions & 45 deletions packages/abc/cell/demo/simple.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Simplest of usage.

```ts
import { JsonPipe } from '@angular/common';
import { ChangeDetectionStrategy, ChangeDetectorRef, Component, OnInit, inject } from '@angular/core';
import { ChangeDetectionStrategy, Component, OnInit, inject, signal } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { DomSanitizer } from '@angular/platform-browser';
import { delay, finalize, of, take } from 'rxjs';
Expand All @@ -38,8 +38,8 @@ import { NzGridModule } from 'ng-zorro-antd/grid';
<div nz-col nzSpan="8"> currency => <cell value="100000" [options]="{ unit: '$' }" /> </div>
<div nz-col nzSpan="8"> cny => <cell value="100000" [options]="{ type: 'cny' }" /> </div>
<div nz-col nzSpan="8">
yn => <cell [value]="yn" [options]="{ type: 'boolean' }" />
<a (click)="yn = !yn">Change Value</a>
yn => <cell [value]="yn()" [options]="{ type: 'boolean' }" />
<a (click)="yn.set(!yn())">Change Value</a>
</div>
<div nz-col nzSpan="8">
img =>
Expand All @@ -64,16 +64,16 @@ import { NzGridModule } from 'ng-zorro-antd/grid';
</div>
<div nz-col nzSpan="8">
link =>
<cell value="Link" [options]="{ link: { url: 'https://ng-alain.com' } }" [disabled]="disabled" />
<a (click)="disabled = !disabled" class="ml-sm">Change Disabled</a>
<cell value="Link" [options]="{ link: { url: 'https://ng-alain.com' } }" [disabled]="disabled()" />
<a (click)="disabled.set(!disabled())" class="ml-sm">Change Disabled</a>
</div>
<div nz-col nzSpan="8">
html =>
<cell [value]="HTML" [options]="{ type: 'html' }" />
</div>
<div nz-col nzSpan="8">
SafeHtml =>
<cell [value]="safeHtml" />
<cell [value]="safeHtml()" />
<a (click)="updateSafeHtml()" class="ml-sm">updateSafeHtml</a>
</div>
<div nz-col nzSpan="8">
Expand All @@ -89,20 +89,21 @@ import { NzGridModule } from 'ng-zorro-antd/grid';
<cell
[(value)]="checkbox"
[options]="{ type: 'checkbox', tooltip: 'Tooltip', checkbox: { label: 'Label' } }"
[disabled]="disabled"
[disabled]="disabled()"
/>
{{ checkbox }}
<a (click)="disabled = !disabled" class="ml-sm">Change Disabled</a>
{{ checkbox() }}
<a (click)="disabled.set(!disabled())" class="ml-sm">Change Disabled</a>
</div>
<div nz-col nzSpan="8">
radio =>
<cell
[(value)]="radio"
[options]="{ type: 'radio', tooltip: 'Tooltip', radio: { label: 'Radio' } }"
[disabled]="disabled"
[disabled]="disabled()"
/>
<a (click)="radio = !radio">Change Value</a>
<a (click)="disabled = !disabled" class="ml-sm">Change Disabled</a>
{{ radio() }}
<a (click)="radio.set(!radio())">Change Value</a>
<a (click)="disabled.set(!disabled())" class="ml-sm">Change Disabled</a>
</div>
<div nz-col nzSpan="8">
enum =>
Expand Down Expand Up @@ -130,21 +131,21 @@ import { NzGridModule } from 'ng-zorro-antd/grid';
</div>
<div nz-col nzSpan="8">
loading =>
<cell value="Done" [loading]="loading" />
<a (click)="loading = !loading" class="ml-md">Change</a>
<cell value="Done" [loading]="loading()" />
<a (click)="loading.set(!loading())" class="ml-md">Change</a>
</div>
<div nz-col nzSpan="8">
Async =>
<cell [value]="async" [loading]="asyncLoading" />
@if (!asyncLoading) {
<cell [value]="async" [loading]="asyncLoading()" />
@if (!asyncLoading()) {
<a (click)="again()" class="ml-md">Again</a>
}
</div>
<div nz-col nzSpan="8"> Unit => <cell value="3" [options]="{ unit: '人' }" /> </div>
<div nz-col nzSpan="8"> Text Unit => <cell [value]="{ text: '100', unit: '元' }" /> </div>
<div nz-col nzSpan="8">
custom widget =>
<cell [value]="imageValue" [options]="{ widget: { key: 'test', data: 'new url' } }" />
<cell [value]="imageValue()" [options]="{ widget: { key: 'test', data: 'new url' } }" />
<a (click)="refreshImage()">Refresh Image</a>
</div>
</div>
Expand All @@ -161,29 +162,24 @@ import { NzGridModule } from 'ng-zorro-antd/grid';
})
export class DemoComponent implements OnInit {
private readonly ds = inject(DomSanitizer);
private readonly cdr = inject(ChangeDetectorRef);
value: unknown = 'string';
imageValue = 'https://randomuser.me/api/portraits/thumb/women/47.jpg';
checkbox = false;
radio = true;
disabled = false;
yn = true;
imageValue = signal('https://randomuser.me/api/portraits/thumb/women/47.jpg');
checkbox = signal(false);
radio = signal(true);
disabled = signal(false);
yn = signal(true);
loading = signal(true);
default: string = '-';
defaultCondition: unknown = '*';
options?: CellOptions;
baseList = ['string', true, false, 100, 1000000, new Date()];
typeList: CellRenderType[] = ['primary', 'success', 'danger', 'warning'];
now = new Date();
day3 = subDays(new Date(), 3);
HTML = `<strong>Strong</string>`;
status: CellBadge = {
WAIT: { text: 'Wait', tooltip: 'Refers to waiting for the user to ship' },
FINISHED: { text: 'Done', color: 'success' }
};
loading = true;
asyncLoading = true;
asyncLoading = signal(true);
async?: CellFuValue;
safeHtml = this.ds.bypassSecurityTrustHtml(`<strong>Strong Html</strong>`);
safeHtml = signal(this.ds.bypassSecurityTrustHtml(`<strong>Strong Html</strong>`));
enum = { 1: 'Success', 2: 'Error' };
enumValue = 1;
bigImg: CellOptions = {
Expand All @@ -197,33 +193,22 @@ export class DemoComponent implements OnInit {
this.again();
}

refresh(): void {
this.value = new Date();
this.cdr.detectChanges();
}

again(): void {
this.asyncLoading = true;
this.asyncLoading.set(true);
this.async = (() =>
of({ text: `${+new Date()}` }).pipe(
take(1),
delay(1000 * 1),
finalize(() => {
this.asyncLoading = false;
this.cdr.detectChanges();
})
finalize(() => this.asyncLoading.set(false))
)) as CellFuValue;
this.cdr.detectChanges();
}

updateSafeHtml(): void {
this.safeHtml = this.ds.bypassSecurityTrustHtml(`alert('a');<script>alert('a')</script>`);
this.cdr.detectChanges();
this.safeHtml.set(this.ds.bypassSecurityTrustHtml(`alert('a');<script>alert('a')</script>`));
}

refreshImage(): void {
this.imageValue = `https://randomuser.me/api/portraits/thumb/women/${Math.floor(Math.random() * 50) + 10}.jpg`;
this.cdr.detectChanges();
this.imageValue.set(`https://randomuser.me/api/portraits/thumb/women/${Math.floor(Math.random() * 50) + 10}.jpg`);
}
}
```
2 changes: 1 addition & 1 deletion packages/abc/notice-icon/demo/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { NoticeIconComponent } from '@delon/abc/notice-icon';

@Component({
selector: 'app-demo',
template: ` <notice-icon count="5" /> `,
template: `<notice-icon count="5" />`,
imports: [NoticeIconComponent]
})
export class DemoComponent {}
Expand Down
Loading
Loading