Skip to content

Commit

Permalink
docs: remove standalone label (#8884)
Browse files Browse the repository at this point in the history
  • Loading branch information
HyperLife1119 authored Nov 26, 2024
1 parent c3ab3ba commit 99d56a6
Show file tree
Hide file tree
Showing 146 changed files with 1,181 additions and 1,207 deletions.
16 changes: 8 additions & 8 deletions components/affix/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ import { NzAffixModule } from 'ng-zorro-antd/affix';

## API

### nz-affix:standalone

| Property | Description | Type | Default | Global Config |
| -------- | ----------- | ---- | ------- | ------------- |
| `[nzOffsetBottom]` | Pixels to offset from bottom when calculating position of scroll | `number` | - ||
| `[nzOffsetTop]` | Pixels to offset from top when calculating position of scroll | `number` | `0` ||
| `[nzTarget]` | specifies the scrollable area dom node | `string \| HTMLElement` | `window` |
| `(nzChange)` | Callback for when affix state is changed | `EventEmitter<boolean>` | - |
### nz-affix

| Property | Description | Type | Default | Global Config |
| ------------------ | ---------------------------------------------------------------- | ----------------------- | -------- | ------------- |
| `[nzOffsetBottom]` | Pixels to offset from bottom when calculating position of scroll | `number` | - | |
| `[nzOffsetTop]` | Pixels to offset from top when calculating position of scroll | `number` | `0` | |
| `[nzTarget]` | specifies the scrollable area dom node | `string \| HTMLElement` | `window` |
| `(nzChange)` | Callback for when affix state is changed | `EventEmitter<boolean>` | - |

**Note:** Children of `nz-affix` can not be `position: absolute`, but you can set `nz-affix` as `position: absolute`:

Expand Down
16 changes: 8 additions & 8 deletions components/affix/doc/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ import { NzAffixModule } from 'ng-zorro-antd/affix';
## API


### nz-affix:standalone

| 成员 | 说明 | 类型 | 默认值 | 全局配置 |
| --- | --- | --- | --- | --- |
| `[nzOffsetBottom]` | 距离窗口底部达到指定偏移量后触发 | `number` | - ||
| `[nzOffsetTop]` | 距离窗口顶部达到指定偏移量后触发 | `number` | `0` ||
| `[nzTarget]` | 设置 `nz-affix` 需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数 | `string \| HTMLElement` | `window` |
| `(nzChange)` | 固定状态改变时触发的回调函数 | `EventEmitter<boolean>` | - |
### nz-affix

| 成员 | 说明 | 类型 | 默认值 | 全局配置 |
| ------------------ | ------------------------------------------------------------------------- | ----------------------- | -------- | -------- |
| `[nzOffsetBottom]` | 距离窗口底部达到指定偏移量后触发 | `number` | - | |
| `[nzOffsetTop]` | 距离窗口顶部达到指定偏移量后触发 | `number` | `0` | |
| `[nzTarget]` | 设置 `nz-affix` 需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数 | `string \| HTMLElement` | `window` |
| `(nzChange)` | 固定状态改变时触发的回调函数 | `EventEmitter<boolean>` | - |

**注意:**`nz-affix` 内的元素不要使用绝对定位,如需要绝对定位的效果,可以直接设置 `nz-affix` 为绝对定位:

Expand Down
28 changes: 14 additions & 14 deletions components/alert/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@ import { NzAlertModule } from 'ng-zorro-antd/alert';

## API

### nz-alert:standalone
### nz-alert

| Property | Description | Type | Default | Global Config |
| -------- | ----------- | ---- | ------- | ------------- |
| `[nzBanner]` | Whether to show as banner | `boolean` | `false` |
| `[nzAction]` | Customized alert's action | `string \| TemplateRef<void>` | - |
| `[nzCloseable]` | Whether Alert can be closed | `boolean` | - ||
| `[nzCloseText]` | Close text to show | `string \| TemplateRef<void>` | - |
| `[nzDescription]` | Additional content of Alert | `string \| TemplateRef<void>` | - |
| `[nzMessage]` | Content of Alert | `string \| TemplateRef<void>` | - |
| `[nzShowIcon]` | Whether to show icon, in `nzBanner` mode default is `true` | `boolean` | `false` ||
| `[nzIconType]` | Icon type, effective when `nzShowIcon` is `true` | `string` | - |
| `[nzType]` | Type of Alert styles, in `nzBanner` mode default is `'warning'` | `'success' \| 'info' \| 'warning' \| 'error'` | `'info'` |
| `[nzIcon]` | Custom icon, effective when showIcon is true | `string \| TemplateRef<void>` | - |
| `(nzOnClose)` | Callback when Alert is closed | `EventEmitter<void>` | - |
| Property | Description | Type | Default | Global Config |
| ----------------- | --------------------------------------------------------------- | --------------------------------------------- | -------- | ------------- |
| `[nzBanner]` | Whether to show as banner | `boolean` | `false` |
| `[nzAction]` | Customized alert's action | `string \| TemplateRef<void>` | - |
| `[nzCloseable]` | Whether Alert can be closed | `boolean` | - | |
| `[nzCloseText]` | Close text to show | `string \| TemplateRef<void>` | - |
| `[nzDescription]` | Additional content of Alert | `string \| TemplateRef<void>` | - |
| `[nzMessage]` | Content of Alert | `string \| TemplateRef<void>` | - |
| `[nzShowIcon]` | Whether to show icon, in `nzBanner` mode default is `true` | `boolean` | `false` | |
| `[nzIconType]` | Icon type, effective when `nzShowIcon` is `true` | `string` | - |
| `[nzType]` | Type of Alert styles, in `nzBanner` mode default is `'warning'` | `'success' \| 'info' \| 'warning' \| 'error'` | `'info'` |
| `[nzIcon]` | Custom icon, effective when showIcon is true | `string \| TemplateRef<void>` | - |
| `(nzOnClose)` | Callback when Alert is closed | `EventEmitter<void>` | - |
28 changes: 14 additions & 14 deletions components/alert/doc/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,18 @@ import { NzAlertModule } from 'ng-zorro-antd/alert';

## API

### nz-alert:standalone
### nz-alert

| 参数 | 说明 | 类型 | 默认值 | 全局配置 |
| --- | --- | --- | --- | --- |
| `[nzBanner]` | 是否用作顶部公告 | `boolean` | `false` |
| `[nzAction]` | 自定义操作项 | `string \| TemplateRef<void>` | - |
| `[nzCloseable]` | 默认不显示关闭按钮 | `boolean` | - ||
| `[nzCloseText]` | 自定义关闭按钮 | `string \| TemplateRef<void>` | - |
| `[nzDescription]` | 警告提示的辅助性文字介绍 | `string \| TemplateRef<void>` | - |
| `[nzMessage]` | 警告提示内容 | `string \| TemplateRef<void>` | - |
| `[nzShowIcon]` | 是否显示辅助图标,`nzBanner` 模式下默认值为 `true` | `boolean` | `false` ||
| `[nzIconType]` | 自定义图标类型,`nzShowIcon``true` 时有效 | `string` | - |
| `[nzType]` | 指定警告提示的样式,`nzBanner` 模式下默认值为 `'warning'` | `'success' \| 'info' \| 'warning' \| 'error'` | `'info'` |
| `[nzIcon]` | 自定义图标,showIcon 为 true 时有效 | `string \| TemplateRef<void>` | - |
| `(nzOnClose)` | 关闭时触发的回调函数 | `EventEmitter<void>` | - |
| 参数 | 说明 | 类型 | 默认值 | 全局配置 |
| ----------------- | --------------------------------------------------------- | --------------------------------------------- | -------- | -------- |
| `[nzBanner]` | 是否用作顶部公告 | `boolean` | `false` |
| `[nzAction]` | 自定义操作项 | `string \| TemplateRef<void>` | - |
| `[nzCloseable]` | 默认不显示关闭按钮 | `boolean` | - | |
| `[nzCloseText]` | 自定义关闭按钮 | `string \| TemplateRef<void>` | - |
| `[nzDescription]` | 警告提示的辅助性文字介绍 | `string \| TemplateRef<void>` | - |
| `[nzMessage]` | 警告提示内容 | `string \| TemplateRef<void>` | - |
| `[nzShowIcon]` | 是否显示辅助图标,`nzBanner` 模式下默认值为 `true` | `boolean` | `false` | |
| `[nzIconType]` | 自定义图标类型,`nzShowIcon``true` 时有效 | `string` | - |
| `[nzType]` | 指定警告提示的样式,`nzBanner` 模式下默认值为 `'warning'` | `'success' \| 'info' \| 'warning' \| 'error'` | `'info'` |
| `[nzIcon]` | 自定义图标,showIcon 为 true 时有效 | `string \| TemplateRef<void>` | - |
| `(nzOnClose)` | 关闭时触发的回调函数 | `EventEmitter<void>` | - |
10 changes: 5 additions & 5 deletions components/anchor/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ import { NzAnchorModule } from 'ng-zorro-antd/anchor';

## API

### nz-anchor:standalone
### nz-anchor

| Property | Description | Type | Default | Global Config |
| -------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------- | ------------ | ------------- |
| `[nzAffix]` | Fixed mode of Anchor | `boolean` | `true` |
| `[nzBounds]` | Bounding distance of anchor area, unit: px | `number` | `5` ||
| `[nzOffsetTop]` | Pixels to offset from top when calculating position of scroll | `number` | `0` ||
| `[nzShowInkInFixed]` | Whether show ink-balls in Fixed mode | `boolean` | `false` ||
| `[nzBounds]` | Bounding distance of anchor area, unit: px | `number` | `5` | |
| `[nzOffsetTop]` | Pixels to offset from top when calculating position of scroll | `number` | `0` | |
| `[nzShowInkInFixed]` | Whether show ink-balls in Fixed mode | `boolean` | `false` | |
| `[nzTargetOffset]` | Anchor scroll offset, default as `offsetTop`, [example](#components-anchor-demo-targetOffset) | `number` | - | |
| `[nzContainer]` | Scrolling container | `string \| HTMLElement` | `window` |
| `[nzCurrentAnchor]` | Customize the anchor highlight | `string` | - | |
Expand All @@ -33,7 +33,7 @@ import { NzAnchorModule } from 'ng-zorro-antd/anchor';
| `(nzChange)` | Listening for anchor link change | `EventEmitter<string>` | - | |
| `(nzScroll)` | The scroll function that is triggered when scrolling to an anchor. | `EventEmitter<NzAnchorLinkComponent>` | - |

### nz-link:standalone
### nz-link

| Property | Description | Type |
| ------------ | ----------------------------------------- | ----------------------------- |
Expand Down
10 changes: 5 additions & 5 deletions components/anchor/doc/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ import { NzAnchorModule } from 'ng-zorro-antd/anchor';

## API

### nz-anchor:standalone
### nz-anchor

| 成员 | 说明 | 类型 | 默认值 | 全局配置 |
| -------------------- | ----------------------------------------------------------------------------------- | ------------------------------------- | ------------ | -------- |
| `[nzAffix]` | 固定模式 | `boolean` | `true` |
| `[nzBounds]` | 锚点区域边界,单位:px | `number` | `5` ||
| `[nzOffsetTop]` | 距离窗口顶部达到指定偏移量后触发 | `number` | - ||
| `[nzShowInkInFixed]` | 固定模式是否显示小圆点 | `boolean` | `false` ||
| `[nzBounds]` | 锚点区域边界,单位:px | `number` | `5` | |
| `[nzOffsetTop]` | 距离窗口顶部达到指定偏移量后触发 | `number` | - | |
| `[nzShowInkInFixed]` | 固定模式是否显示小圆点 | `boolean` | `false` | |
| `[nzTargetOffset]` | 锚点滚动偏移量,默认与 offsetTop 相同,[例子](#components-anchor-demo-targetOffset) | number | - | |
| `[nzContainer]` | 指定滚动的容器 | `string \| HTMLElement` | `window` |
| `[nzCurrentAnchor]` | 自定义高亮的锚点 | string | - | |
Expand All @@ -34,7 +34,7 @@ import { NzAnchorModule } from 'ng-zorro-antd/anchor';
| `(nzChange)` | 监听锚点链接改变 | `EventEmitter<string>` | - | |
| `(nzScroll)` | 滚动至某锚点时触发 | `EventEmitter<NzAnchorLinkComponent>` | - |

### nz-link:standalone
### nz-link

| 成员 | 说明 | 类型 |
| ------------ | -------------------------------- | ----------------------------- |
Expand Down
14 changes: 7 additions & 7 deletions components/auto-complete/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,16 @@ import { NzAutocompleteModule } from 'ng-zorro-antd/auto-complete';
</nz-autocomplete>
```

### [nzAutocomplete]:standalone
### [nzAutocomplete]

| Property | Description | Type | Default |
|--------------------|------------------------------------------|---------------------------|---------|
| ------------------ | ---------------------------------------- | ------------------------- | ------- |
| `[nzAutocomplete]` | used to bind `nzAutocomplete` components | `NzAutocompleteComponent` | - |

### nz-autocomplete:standalone
### nz-autocomplete

| Property | Description | Type | Default |
|--------------------------------|------------------------------------------------------------------------------------------------|---------------------------------|---------------------------------|
| ------------------------------ | ---------------------------------------------------------------------------------------------- | ------------------------------- | ------------------------------- |
| `[nzBackfill]` | backfill selected item the input when using keyboard | `boolean` | `false` |
| `[nzDataSource]` | Data source for autocomplete | `AutocompleteDataSource` | - |
| `[nzDefaultActiveFirstOption]` | Whether active first option by default | `boolean` | `true` |
Expand All @@ -49,10 +49,10 @@ import { NzAutocompleteModule } from 'ng-zorro-antd/auto-complete';
| `[nzOverlayStyle]` | Style of the dropdown root element | `object` | - |
| `[compareWith]` | Same as [SelectControlValueAccessor](https://angular.dev/api/forms/SelectControlValueAccessor) | `(o1: any, o2: any) => boolean` | `(o1: any, o2: any) => o1===o2` |

### nz-auto-option:standalone
### nz-auto-option

| Property | Description | Type | Default |
|----------------|--------------------------------------|-----------|---------|
| -------------- | ------------------------------------ | --------- | ------- |
| `[nzValue]` | bind ngModel of the trigger element | `any` | - |
| `[nzLabel]` | display value of the trigger element | `string` | - |
| `[nzDisabled]` | disabled option | `boolean` | `false` |
| `[nzDisabled]` | disabled option | `boolean` | `false` |
Loading

0 comments on commit 99d56a6

Please sign in to comment.