feat(abc:avatar-list): set deprecated (#1848)

ng-alain · Nov 13, 2024 · 4041611 · 4041611
1 parent d28a8ad
commit 4041611
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/packages/abc/avatar-list/avatar-list.component.ts b/packages/abc/avatar-list/avatar-list.component.ts
@@ -22,6 +22,9 @@ import { NzTooltipDirective } from 'ng-zorro-antd/tooltip';
 
 import { AvatarListItemComponent } from './avatar-list-item.component';
 
+/**
+ * @deprecated Will be removed in v20, Please use `nz-avatar-group` instead.
+ */
 @Component({
   selector: 'avatar-list',
   exportAs: 'avatarList',

diff --git a/packages/abc/avatar-list/avatar-list.module.ts b/packages/abc/avatar-list/avatar-list.module.ts
@@ -9,6 +9,9 @@ import { AvatarListComponent } from './avatar-list.component';
 
 const COMPONENTS = [AvatarListComponent, AvatarListItemComponent];
 
+/**
+ * @deprecated Will be removed in v20, Please use `nz-avatar-group` instead.
+ */
 @NgModule({
   imports: [CommonModule, NzAvatarModule, NzToolTipModule, ...COMPONENTS],
   exports: COMPONENTS

diff --git a/packages/abc/avatar-list/index.en-US.md b/packages/abc/avatar-list/index.en-US.md
@@ -4,6 +4,7 @@ title: avatar-list
 subtitle: AvatarList
 cols: 1
 module: import { AvatarListModule } from '@delon/abc/avatar-list';
+deprecated: 20.0.0
 ---
 
 A list of user's avatar for project or group member list frequently. If a large or small avatar-list is desired, set the `size` property to either `large` or `small` and `mini` respectively. Omit the `size` property for a avatar-list with the default size.

diff --git a/packages/abc/avatar-list/index.zh-CN.md b/packages/abc/avatar-list/index.zh-CN.md
@@ -4,6 +4,7 @@ title: avatar-list
 subtitle: 用户头像列表
 cols: 1
 module: import { AvatarListModule } from '@delon/abc/avatar-list';
+deprecated: 20.0.0
 ---
 
 一组用户头像，常用在项目/团队成员列表。可通过设置 `size` 属性来指定头像大小。