Skip to content

Commit 64ec76a

Browse files
ParsaArvanehPAParsaArvanehPA
authored
feat(module:tree-select): support standalone component (#8206)
* feat(module:tree-select): support standalone component * feat(module:tree-select): add bidi module in import section * feat(module:tree-select): support standalone component
1 parent 5e611e7 commit 64ec76a

File tree

4 files changed

+119
-126
lines changed

4 files changed

+119
-126
lines changed

‎components/tree-select/doc/index.en-US.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -18,52 +18,52 @@ import { NzTreeSelectModule } from 'ng-zorro-antd/tree-select';
1818

1919
## API
2020

21-
### nz-tree-select
21+
### nz-tree-select:standalone
2222

23-
| Property | Description | Type | Default | Global Config |
24-
| -------- | ----------- | ---- | ------- | ------------- |
25-
| `[nzId]` | input id attribute inside the component| `string` | - |
26-
| `[nzAllowClear]` | Whether allow clear | `boolean` | `false` |
27-
| `[nzPlaceHolder]` | Placeholder of the select input | `string` | - |
28-
| `[nzPlacement]` | The position where the selection box pops up | `bottomLeft` `bottomRight` `topLeft` `topRight` | bottomLeft |
29-
| `[nzDisabled]` | Disabled or not | `boolean` | `false` |
30-
| `[nzShowIcon]` | Shows the icon before a TreeNode's title. There is no default style | `boolean` | `false` |
31-
| `[nzShowSearch]` | Whether to display a search input in the dropdown menu(valid only in the single mode) | `boolean` | `false` | ✅ |
32-
| `[nzNotFoundContent]` | Specify content to show when no result matches. | `string` | - |
33-
| `[nzDropdownMatchSelectWidth]` | Determine whether the dropdown menu and the select input are the same width | `boolean` | `true` | ✅ |
34-
| `[nzDropdownStyle]` | To set the style of the dropdown menu | `object` | - |
35-
| `[nzDropdownClassName]` | classname of dropdown menu | `string` | - |
36-
| `[nzMultiple]` | Support multiple or not, will be `true` when enable `nzCheckable`. | `boolean` | `false` |
37-
| `[nzHideUnMatched]` | Hide unmatched nodes while searching | `boolean` | `false` | ✅ |
38-
| `[nzSize]` | To set the size of the select input | `'large' \| 'small' \| 'default'` | `'default'` | ✅ |
39-
| `[nzStatus]` | Set validation status | `'error' \| 'warning'` | - | |
40-
| `[nzCheckable]` | Whether to show checkbox on the treeNodes | `boolean` | `false` |
41-
| `[nzCheckStrictly]` | Check treeNode precisely; parent treeNode and children treeNodes are not associated | `boolean` | `false` |
42-
| `[nzShowExpand]` | Show a Expand Icon before the treeNodes | `boolean` | `true` | |
43-
| `[nzShowLine]` | Shows a connecting line | `boolean` | `false` | |
44-
| `[nzAsyncData]` | Load data asynchronously (should be used with NzTreeNode.addChildren(...)) | `boolean` | `false` |
45-
| `[nzNodes]` | Data of the treeNodes | `NzTreeNodeOptions[]` | `[]` |
46-
| `[nzDefaultExpandAll]` | Whether to expand all treeNodes by default | `boolean` | `false` |
47-
| `[nzExpandedKeys]` | Default expanded treeNodes | `string[]` | - |
48-
| `[nzDisplayWith]` | How to display the selected node value in the trigger | `(node: NzTreeNode) => string` | `(node: NzTreeNode) => node.title` |
49-
| `[nzMaxTagCount]` | Max tag count to show| number | - |
50-
| `[nzMaxTagPlaceholder]` | Placeholder for not showing tags | TemplateRef<{ $implicit: NzTreeNode[] }> | - |
51-
| `[nzTreeTemplate]` | Custom Nodes | `TemplateRef<{ $implicit: NzTreeNode }>` | - |
52-
| `[nzVirtualHeight]` | The height of virtual scroll | `string` | `-` |
53-
| `[nzVirtualItemSize]` | The size of the items in the list, same as [cdk itemSize](https://material.angular.io/cdk/scrolling/api) | `number` | `28` |
54-
| `[nzVirtualMaxBufferPx]` | The number of pixels worth of buffer to render for when rendering new items, same as [cdk maxBufferPx](https://material.angular.io/cdk/scrolling/api) | `number` | `500` |
55-
| `[nzVirtualMinBufferPx]` | The minimum amount of buffer rendered beyond the viewport (in pixels),same as [cdk minBufferPx](https://material.angular.io/cdk/scrolling/api) | `number` | `28` |
56-
| `[nzBackdrop]` | whether or not the overlay should attach a backdrop | `boolean` | `false` |
57-
| `(nzExpandChange)` | Callback function for when a treeNode is expanded or collapsed |`EventEmitter<NzFormatEmitEvent>` | - |
23+
| Property | Description | Type | Default | Global Config |
24+
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ---------------------------------- | ------------- |
25+
| `[nzId]` | input id attribute inside the component | `string` | - |
26+
| `[nzAllowClear]` | Whether allow clear | `boolean` | `false` |
27+
| `[nzPlaceHolder]` | Placeholder of the select input | `string` | - |
28+
| `[nzPlacement]` | The position where the selection box pops up | `bottomLeft` `bottomRight` `topLeft` `topRight` | bottomLeft |
29+
| `[nzDisabled]` | Disabled or not | `boolean` | `false` |
30+
| `[nzShowIcon]` | Shows the icon before a TreeNode's title. There is no default style | `boolean` | `false` |
31+
| `[nzShowSearch]` | Whether to display a search input in the dropdown menu(valid only in the single mode) | `boolean` | `false` | ✅ |
32+
| `[nzNotFoundContent]` | Specify content to show when no result matches. | `string` | - |
33+
| `[nzDropdownMatchSelectWidth]` | Determine whether the dropdown menu and the select input are the same width | `boolean` | `true` | ✅ |
34+
| `[nzDropdownStyle]` | To set the style of the dropdown menu | `object` | - |
35+
| `[nzDropdownClassName]` | classname of dropdown menu | `string` | - |
36+
| `[nzMultiple]` | Support multiple or not, will be `true` when enable `nzCheckable`. | `boolean` | `false` |
37+
| `[nzHideUnMatched]` | Hide unmatched nodes while searching | `boolean` | `false` | ✅ |
38+
| `[nzSize]` | To set the size of the select input | `'large' \| 'small' \| 'default'` | `'default'` | ✅ |
39+
| `[nzStatus]` | Set validation status | `'error' \| 'warning'` | - | |
40+
| `[nzCheckable]` | Whether to show checkbox on the treeNodes | `boolean` | `false` |
41+
| `[nzCheckStrictly]` | Check treeNode precisely; parent treeNode and children treeNodes are not associated | `boolean` | `false` |
42+
| `[nzShowExpand]` | Show a Expand Icon before the treeNodes | `boolean` | `true` | |
43+
| `[nzShowLine]` | Shows a connecting line | `boolean` | `false` | |
44+
| `[nzAsyncData]` | Load data asynchronously (should be used with NzTreeNode.addChildren(...)) | `boolean` | `false` |
45+
| `[nzNodes]` | Data of the treeNodes | `NzTreeNodeOptions[]` | `[]` |
46+
| `[nzDefaultExpandAll]` | Whether to expand all treeNodes by default | `boolean` | `false` |
47+
| `[nzExpandedKeys]` | Default expanded treeNodes | `string[]` | - |
48+
| `[nzDisplayWith]` | How to display the selected node value in the trigger | `(node: NzTreeNode) => string` | `(node: NzTreeNode) => node.title` |
49+
| `[nzMaxTagCount]` | Max tag count to show | number | - |
50+
| `[nzMaxTagPlaceholder]` | Placeholder for not showing tags | TemplateRef<{ $implicit: NzTreeNode[] }> | - |
51+
| `[nzTreeTemplate]` | Custom Nodes | `TemplateRef<{ $implicit: NzTreeNode }>` | - |
52+
| `[nzVirtualHeight]` | The height of virtual scroll | `string` | `-` |
53+
| `[nzVirtualItemSize]` | The size of the items in the list, same as [cdk itemSize](https://material.angular.io/cdk/scrolling/api) | `number` | `28` |
54+
| `[nzVirtualMaxBufferPx]` | The number of pixels worth of buffer to render for when rendering new items, same as [cdk maxBufferPx](https://material.angular.io/cdk/scrolling/api) | `number` | `500` |
55+
| `[nzVirtualMinBufferPx]` | The minimum amount of buffer rendered beyond the viewport (in pixels),same as [cdk minBufferPx](https://material.angular.io/cdk/scrolling/api) | `number` | `28` |
56+
| `[nzBackdrop]` | whether or not the overlay should attach a backdrop | `boolean` | `false` |
57+
| `(nzExpandChange)` | Callback function for when a treeNode is expanded or collapsed | `EventEmitter<NzFormatEmitEvent>` | - |
5858

5959
#### Methods
6060

61-
| Property | Description | Type |
62-
| -------- | ----------- | ---- |
63-
| getTreeNodes | get all nodes(NzTreeNode) | `NzTreeNode[]` |
64-
| getTreeNodeByKey | get NzTreeNode with key | `NzTreeNode` |
65-
| getCheckedNodeList | get checked nodes(merged) | `NzTreeNode[]` |
66-
| getSelectedNodeList | get selected nodes | `NzTreeNode[]` |
67-
| getHalfCheckedNodeList | get half checked nodes | `NzTreeNode[]` |
68-
| getExpandedNodeList | get expanded nodes | `NzTreeNode[]` |
69-
| getMatchedNodeList | get matched nodes(if nzSearchValue is not null) | `NzTreeNode[]` |
61+
| Property | Description | Type |
62+
| ---------------------- | ----------------------------------------------- | -------------- |
63+
| getTreeNodes | get all nodes(NzTreeNode) | `NzTreeNode[]` |
64+
| getTreeNodeByKey | get NzTreeNode with key | `NzTreeNode` |
65+
| getCheckedNodeList | get checked nodes(merged) | `NzTreeNode[]` |
66+
| getSelectedNodeList | get selected nodes | `NzTreeNode[]` |
67+
| getHalfCheckedNodeList | get half checked nodes | `NzTreeNode[]` |
68+
| getExpandedNodeList | get expanded nodes | `NzTreeNode[]` |
69+
| getMatchedNodeList | get matched nodes(if nzSearchValue is not null) | `NzTreeNode[]` |

0 commit comments

Comments
 (0)