Skip to content

Commit 0245ebf

Browse files
committed
doc
1 parent d787245 commit 0245ebf

File tree

5 files changed

+72
-17
lines changed

5 files changed

+72
-17
lines changed

src/assets/styles/index.scss

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,6 @@
11
@import "reset";
22
@import "highlight.github.css";
3+
4+
.table-row-abandoned {
5+
text-decoration: line-through;
6+
}

src/components/VirtualTree/types.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ interface TreeNodeOptions {
1212
hasChildren?: boolean;
1313
children?: TreeNodeOptions[];
1414
parentKey?: NodeKey | null;
15-
// [key: string]: any;
1615
}
1716

1817
interface TreeInstance {

src/doc/BaseDemo.vue

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,6 @@
4747
const defaultSelectedKey = ref('0-0-1-0');
4848
const defaultDisabledKeys = ref(['0-0-1']);
4949
50-
setTimeout(() => {
51-
defaultDisabledKeys.value = ['0-1', '0-0-2'];
52-
}, 5000);
53-
5450
onMounted(() => {
5551
list.value = recursion();
5652
});

src/doc/index.vue

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
<demo-box
4343
id="base-demo"
4444
title="基本用法"
45-
desc="展开、选中、禁用的基本功能aa"
45+
desc="展开、选中、禁用的基本功能"
4646
code-type="base">
4747
<base-demo />
4848
</demo-box>
@@ -98,7 +98,13 @@
9898
<a-table :columns="methodColumns" :data-source="methodData" rowKey="argument" :pagination="false" />
9999
<br />
100100
<a-typography-title :level="4">TreeNodeOptions</a-typography-title>
101-
<a-table :columns="columns" :data-source="nodeOptionData" rowKey="argument" :pagination="false" />
101+
<a-table
102+
:columns="columns"
103+
:data-source="nodeOptionData"
104+
rowKey="argument"
105+
:pagination="false"
106+
:row-class-name="rowClsName"
107+
/>
102108
</section>
103109
</div>
104110
</template>
@@ -117,14 +123,17 @@
117123
export default defineComponent({
118124
name: 'DocContainer',
119125
components: { DemoBox, BaseDemo, CheckboxDemo, AsyncDataDemo, CustomNodeDemo, CustomIconDemo, SearchNodeDemo },
120-
setup(prop, {emit}) {
126+
setup() {
127+
const rowClsName = (_: any, index: number) => ([5, 6, 7, 8].includes(index) ? 'table-row-abandoned' : null);
128+
121129
return {
122130
propData,
123131
eventData,
124132
methodData,
125133
nodeOptionData,
126134
columns,
127-
methodColumns
135+
methodColumns,
136+
rowClsName
128137
}
129138
}
130139
});
@@ -149,4 +158,5 @@
149158
}
150159
}
151160
}
161+
152162
</style>

src/doc/tableData.ts

Lines changed: 54 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ const columns = [
1414
{
1515
title: '默认值',
1616
dataIndex: 'defaultValue'
17+
},
18+
{
19+
title: '版本号',
20+
dataIndex: 'version'
1721
}
1822
];
1923
const methodColumns = [
@@ -28,6 +32,10 @@ const methodColumns = [
2832
{
2933
title: '参数',
3034
dataIndex: 'type'
35+
},
36+
{
37+
title: '版本号',
38+
dataIndex: 'version'
3139
}
3240
];
3341

@@ -73,7 +81,35 @@ const propData = [
7381
description: '自定义渲染节点',
7482
type: '() => JSX.Element',
7583
defaultValue: 'undefined'
76-
}
84+
},
85+
{
86+
argument: 'defaultExpandedKeys',
87+
description: '默认展开的nodeKey数组',
88+
type: 'Array<string | number>',
89+
defaultValue: '[]',
90+
version: '2.0.0'
91+
},
92+
{
93+
argument: 'defaultDisabledKeys',
94+
description: '默认禁用的nodeKey数组',
95+
type: 'Array<string | number>',
96+
defaultValue: '[]',
97+
version: '2.0.0'
98+
},
99+
{
100+
argument: 'defaultCheckedKeys',
101+
description: '默认勾选的nodeKey数组',
102+
type: 'Array<string | number>',
103+
defaultValue: '[]',
104+
version: '2.0.0'
105+
},
106+
{
107+
argument: 'defaultSelectedKey',
108+
description: '默认选中的nodeKey',
109+
type: 'string | number',
110+
defaultValue: '',
111+
version: '2.0.0'
112+
},
77113
];
78114
const eventData = [
79115
{
@@ -96,17 +132,23 @@ const methodData = [
96132
{
97133
name: 'getSelectedNode',
98134
description: '获取选中的节点',
99-
type: '() => TreeNodeOptions | undefined;'
135+
type: '() => TreeNodeOptions | undefined'
100136
},
101137
{
102138
name: 'getCheckedNodes',
103139
description: '获取已勾选的节点',
104-
type: '() => TreeNodeOptions;'
140+
type: '() => TreeNodeOptions'
105141
},
106142
{
107143
name: 'getHalfCheckedNodes',
108144
description: '获取半勾选的节点',
109-
type: '() => TreeNodeOptions;'
145+
type: '() => TreeNodeOptions'
146+
},
147+
{
148+
name: 'getExpandedKeys',
149+
description: '获取已展开的nodeKeys',
150+
type: '() => Array<string | number>',
151+
version: '2.0.0'
110152
}
111153
];
112154
const nodeOptionData = [
@@ -140,25 +182,29 @@ const nodeOptionData = [
140182
argument: 'disabled',
141183
description: '是否禁用',
142184
type: 'boolean',
143-
defaultValue: 'false'
185+
defaultValue: 'false',
186+
version: '2.0.0已废弃'
144187
},
145188
{
146189
argument: 'expanded',
147190
description: '是否展开',
148191
type: 'boolean',
149-
defaultValue: 'false'
192+
defaultValue: 'false',
193+
version: '2.0.0已废弃'
150194
},
151195
{
152196
argument: 'selected',
153197
description: '是否选中',
154198
type: 'boolean',
155-
defaultValue: 'false'
199+
defaultValue: 'false',
200+
version: '2.0.0已废弃'
156201
},
157202
{
158203
argument: 'checked',
159204
description: '是否勾选',
160205
type: 'boolean',
161-
defaultValue: 'false'
206+
defaultValue: 'false',
207+
version: '2.0.0已废弃'
162208
},
163209
{
164210
argument: 'children',

0 commit comments

Comments
 (0)