create-yss-spec 3.4.9 → 3.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (287) hide show
  1. package/README.md +2 -2
  2. package/package.json +1 -1
  3. package/src/api/_sync-service.js +111 -18
  4. package/src/cli/args.js +1 -0
  5. package/src/cli/help.js +10 -1
  6. package/src/cli/index.js +3 -0
  7. package/src/cli/prompts.js +5 -1
  8. package/src/cli/router.js +2 -0
  9. package/src/commands/attach.js +12 -2
  10. package/src/commands/init.js +2 -0
  11. package/src/commands/skills.js +253 -0
  12. package/src/commands/sync.js +3 -0
  13. package/src/family-identity.js +1 -1
  14. package/src/template/asset-runtime.js +220 -0
  15. package/src/template/attach-planner.js +5 -0
  16. package/src/template/distribution-runtime.js +165 -0
  17. package/src/template/instance-runtime.js +76 -29
  18. package/src/template/ownership-policy.js +17 -1
  19. package/src/template/prune-planner.js +6 -1
  20. package/src/template/sync-planner.js +8 -0
  21. package/src/template/verification-runtime.js +56 -1
  22. package/src/validation/metadata.js +24 -1
  23. package/template/.agents/skills/.strategic-design-skills-manifest.json +1 -1
  24. package/template/.agents/skills/yss-cache/SKILL.md +6 -5
  25. package/template/.agents/skills/yss-cache/references/annotations.md +3 -1
  26. package/template/.agents/skills/yss-cache/references/architecture.md +4 -2
  27. package/template/.agents/skills/yss-cache/references/configuration.md +6 -3
  28. package/template/.agents/skills/yss-cache/references/jetcache.md +21 -0
  29. package/template/.agents/skills/yss-cache/references/redis-fallback.md +5 -3
  30. package/template/.agents/skills/yss-cache/references/verification.md +10 -4
  31. package/template/.agents/skills/yss-cache/scripts/verify-cache-component.sh +26 -20
  32. package/template/.agents/skills/yss-distributed-id/SKILL.md +14 -58
  33. package/template/.agents/skills/yss-distributed-id/agents/openai.yaml +2 -2
  34. package/template/.agents/skills/yss-distributed-id/references/README.md +11 -47
  35. package/template/.agents/skills/yss-implementation-contract-compiler/SKILL.md +2 -0
  36. package/template/.agents/skills/yss-mybatis/SKILL.md +14 -2
  37. package/template/.agents/skills/yss-openapi-draft-review/SKILL.md +2 -0
  38. package/template/.agents/skills/yss-openapi-governance/SKILL.md +4 -0
  39. package/template/.agents/skills/yss-product-lifecycle/SKILL.md +11 -5
  40. package/template/.agents/skills/yss-product-lifecycle/references/orchestration-contract.yaml +68 -5
  41. package/template/.agents/skills/yss-product-lifecycle/references/orchestration.md +2 -2
  42. package/template/.agents/skills/yss-product-lifecycle/references/state-model.md +8 -8
  43. package/template/.agents/skills/yss-prototype-stage/SKILL.md +4 -2
  44. package/template/.agents/skills/yss-prototype-stage/scripts/visual-baseline-contract.mjs +2 -2
  45. package/template/.agents/skills/yss-repository/SKILL.md +1 -0
  46. package/template/.agents/skills/yss-stage-decision/SKILL.md +2 -0
  47. package/template/.agents/skills/yss-tactical-design/SKILL.md +2 -0
  48. package/template/.agents/skills/yss-technical-design/SKILL.md +2 -0
  49. package/template/.agents/skills/yss-technical-design/scripts/engineering-design.mjs +1 -1
  50. package/template/.agents/skills/yss-technical-design/scripts/validate-technical-design.mjs +11 -8
  51. package/template/.codex/skills/yss-cache/SKILL.md +6 -5
  52. package/template/.codex/skills/yss-cache/references/annotations.md +3 -1
  53. package/template/.codex/skills/yss-cache/references/architecture.md +4 -2
  54. package/template/.codex/skills/yss-cache/references/configuration.md +6 -3
  55. package/template/.codex/skills/yss-cache/references/jetcache.md +21 -0
  56. package/template/.codex/skills/yss-cache/references/redis-fallback.md +5 -3
  57. package/template/.codex/skills/yss-cache/references/verification.md +10 -4
  58. package/template/.codex/skills/yss-cache/scripts/verify-cache-component.sh +26 -20
  59. package/template/.codex/skills/yss-distributed-id/SKILL.md +14 -58
  60. package/template/.codex/skills/yss-distributed-id/agents/openai.yaml +2 -2
  61. package/template/.codex/skills/yss-distributed-id/references/README.md +11 -47
  62. package/template/.codex/skills/yss-implementation-contract-compiler/SKILL.md +2 -0
  63. package/template/.codex/skills/yss-mybatis/SKILL.md +14 -2
  64. package/template/.codex/skills/yss-openapi-draft-review/SKILL.md +2 -0
  65. package/template/.codex/skills/yss-openapi-governance/SKILL.md +4 -0
  66. package/template/.codex/skills/yss-product-lifecycle/SKILL.md +11 -5
  67. package/template/.codex/skills/yss-product-lifecycle/references/orchestration-contract.yaml +68 -5
  68. package/template/.codex/skills/yss-product-lifecycle/references/orchestration.md +2 -2
  69. package/template/.codex/skills/yss-product-lifecycle/references/state-model.md +8 -8
  70. package/template/.codex/skills/yss-prototype-stage/SKILL.md +4 -2
  71. package/template/.codex/skills/yss-prototype-stage/scripts/visual-baseline-contract.mjs +2 -2
  72. package/template/.codex/skills/yss-repository/SKILL.md +1 -0
  73. package/template/.codex/skills/yss-stage-decision/SKILL.md +2 -0
  74. package/template/.codex/skills/yss-tactical-design/SKILL.md +2 -0
  75. package/template/.codex/skills/yss-technical-design/SKILL.md +2 -0
  76. package/template/.codex/skills/yss-technical-design/scripts/engineering-design.mjs +1 -1
  77. package/template/.codex/skills/yss-technical-design/scripts/validate-technical-design.mjs +11 -8
  78. package/template/.cursor/skills/yss-cache/SKILL.md +6 -5
  79. package/template/.cursor/skills/yss-cache/references/annotations.md +3 -1
  80. package/template/.cursor/skills/yss-cache/references/architecture.md +4 -2
  81. package/template/.cursor/skills/yss-cache/references/configuration.md +6 -3
  82. package/template/.cursor/skills/yss-cache/references/jetcache.md +21 -0
  83. package/template/.cursor/skills/yss-cache/references/redis-fallback.md +5 -3
  84. package/template/.cursor/skills/yss-cache/references/verification.md +10 -4
  85. package/template/.cursor/skills/yss-cache/scripts/verify-cache-component.sh +26 -20
  86. package/template/.cursor/skills/yss-distributed-id/SKILL.md +14 -58
  87. package/template/.cursor/skills/yss-distributed-id/agents/openai.yaml +2 -2
  88. package/template/.cursor/skills/yss-distributed-id/references/README.md +11 -47
  89. package/template/.cursor/skills/yss-implementation-contract-compiler/SKILL.md +2 -0
  90. package/template/.cursor/skills/yss-mybatis/SKILL.md +14 -2
  91. package/template/.cursor/skills/yss-openapi-draft-review/SKILL.md +2 -0
  92. package/template/.cursor/skills/yss-openapi-governance/SKILL.md +4 -0
  93. package/template/.cursor/skills/yss-product-lifecycle/SKILL.md +11 -5
  94. package/template/.cursor/skills/yss-product-lifecycle/references/orchestration-contract.yaml +68 -5
  95. package/template/.cursor/skills/yss-product-lifecycle/references/orchestration.md +2 -2
  96. package/template/.cursor/skills/yss-product-lifecycle/references/state-model.md +8 -8
  97. package/template/.cursor/skills/yss-prototype-stage/SKILL.md +4 -2
  98. package/template/.cursor/skills/yss-prototype-stage/scripts/visual-baseline-contract.mjs +2 -2
  99. package/template/.cursor/skills/yss-repository/SKILL.md +1 -0
  100. package/template/.cursor/skills/yss-stage-decision/SKILL.md +2 -0
  101. package/template/.cursor/skills/yss-tactical-design/SKILL.md +2 -0
  102. package/template/.cursor/skills/yss-technical-design/SKILL.md +2 -0
  103. package/template/.cursor/skills/yss-technical-design/scripts/engineering-design.mjs +1 -1
  104. package/template/.cursor/skills/yss-technical-design/scripts/validate-technical-design.mjs +11 -8
  105. package/template/.pi/skills/yss-cache/SKILL.md +6 -5
  106. package/template/.pi/skills/yss-cache/references/annotations.md +3 -1
  107. package/template/.pi/skills/yss-cache/references/architecture.md +4 -2
  108. package/template/.pi/skills/yss-cache/references/configuration.md +6 -3
  109. package/template/.pi/skills/yss-cache/references/jetcache.md +21 -0
  110. package/template/.pi/skills/yss-cache/references/redis-fallback.md +5 -3
  111. package/template/.pi/skills/yss-cache/references/verification.md +10 -4
  112. package/template/.pi/skills/yss-cache/scripts/verify-cache-component.sh +26 -20
  113. package/template/.pi/skills/yss-distributed-id/SKILL.md +14 -58
  114. package/template/.pi/skills/yss-distributed-id/agents/openai.yaml +2 -2
  115. package/template/.pi/skills/yss-distributed-id/references/README.md +11 -47
  116. package/template/.pi/skills/yss-implementation-contract-compiler/SKILL.md +2 -0
  117. package/template/.pi/skills/yss-mybatis/SKILL.md +14 -2
  118. package/template/.pi/skills/yss-openapi-draft-review/SKILL.md +2 -0
  119. package/template/.pi/skills/yss-openapi-governance/SKILL.md +4 -0
  120. package/template/.pi/skills/yss-product-lifecycle/SKILL.md +11 -5
  121. package/template/.pi/skills/yss-product-lifecycle/references/orchestration-contract.yaml +68 -5
  122. package/template/.pi/skills/yss-product-lifecycle/references/orchestration.md +2 -2
  123. package/template/.pi/skills/yss-product-lifecycle/references/state-model.md +8 -8
  124. package/template/.pi/skills/yss-prototype-stage/SKILL.md +4 -2
  125. package/template/.pi/skills/yss-prototype-stage/scripts/visual-baseline-contract.mjs +2 -2
  126. package/template/.pi/skills/yss-repository/SKILL.md +1 -0
  127. package/template/.pi/skills/yss-stage-decision/SKILL.md +2 -0
  128. package/template/.pi/skills/yss-tactical-design/SKILL.md +2 -0
  129. package/template/.pi/skills/yss-technical-design/SKILL.md +2 -0
  130. package/template/.pi/skills/yss-technical-design/scripts/engineering-design.mjs +1 -1
  131. package/template/.pi/skills/yss-technical-design/scripts/validate-technical-design.mjs +11 -8
  132. package/template/AGENTS.md +2 -0
  133. package/template/CONTEXT.md +2 -1
  134. package/template/README.md +3 -5
  135. package/template/docs/agents/issue-tracker.md +7 -0
  136. package/template/docs/agents/skill-migrations.md +4 -0
  137. package/template/docs/agents/yss-skill-registry.yaml +7 -6
  138. package/template/docs/design/README.md +0 -1
  139. package/template/docs/design/design.md +2 -2
  140. package/template/docs/design/templates/interaction-spec-template.md +1 -1
  141. package/template/docs/engineering/evidence/aliyun-artifact-resolution.json +446 -0
  142. package/template/docs/process/contract-reading.md +46 -0
  143. package/template/docs/process/lifecycle-artifact-map.md +2 -2
  144. package/template/docs/process/lifecycle-registry-baseline.json +2 -1
  145. package/template/docs/process/lifecycle-registry.yaml +10 -4
  146. package/template/docs/process/schemas/api-contract-decision-v2.schema.json +198 -0
  147. package/template/docs/process/schemas/digital-human-task-package.schema.json +8 -0
  148. package/template/docs/process/schemas/lifecycle-checkpoint.schema.json +259 -0
  149. package/template/docs/process/schemas/stage-tracking.schema.json +259 -0
  150. package/template/docs/process/stage-tracking.md +62 -0
  151. package/template/docs/process/strategic-handoff-package.md +8 -0
  152. package/template/docs/user-guide//347/224/250/346/210/267/346/211/213/345/206/214.md +2 -0
  153. package/template/docs/user-guide//347/224/250/346/210/267/346/211/213/345/206/214/347/264/242/345/274/225.md +1 -0
  154. package/template/docs/user-guide//351/230/266/346/256/265/346/216/245/345/205/245/344/270/216/344/272/247/347/211/251/345/244/215/347/224/250/344/275/277/347/224/250/346/211/213/345/206/214.md +243 -0
  155. package/template/scripts/api-contract-decision +16 -0
  156. package/template/scripts/complete-backend-delivery +17 -0
  157. package/template/scripts/contract +13 -0
  158. package/template/scripts/design-md +2 -0
  159. package/template/scripts/dispatch-slice-task +13 -0
  160. package/template/scripts/lib/api-contract-decision.mjs +45 -4
  161. package/template/scripts/lib/approval-record.mjs +1 -1
  162. package/template/scripts/lib/approved-execution-context.mjs +35 -7
  163. package/template/scripts/lib/backend-architecture.mjs +2 -2
  164. package/template/scripts/lib/backend-delivery-terminal.mjs +51 -0
  165. package/template/scripts/lib/backend-platform-provenance.mjs +1 -1
  166. package/template/scripts/lib/backend-platform.mjs +1 -1
  167. package/template/scripts/lib/backend-scaffold-prerequisites.mjs +1 -1
  168. package/template/scripts/lib/context-contract.mjs +1 -1
  169. package/template/scripts/lib/context-reconciliation.mjs +1 -1
  170. package/template/scripts/lib/contract-source.mjs +22 -0
  171. package/template/scripts/lib/contract-views.mjs +109 -0
  172. package/template/scripts/lib/delivery-preflight.mjs +3 -2
  173. package/template/scripts/lib/design-md.mjs +230 -0
  174. package/template/scripts/lib/digital-human-roles.mjs +1 -1
  175. package/template/scripts/lib/existing-backend-architecture.mjs +4 -3
  176. package/template/scripts/lib/existing-ui-baseline.mjs +4 -2
  177. package/template/scripts/lib/frontend-delivery-boundary.mjs +1 -1
  178. package/template/scripts/lib/frontend-delivery.mjs +1 -1
  179. package/template/scripts/lib/harness-execution-scope.mjs +15 -1
  180. package/template/scripts/lib/implementation-contract-compiler.mjs +4 -4
  181. package/template/scripts/lib/json-schema.mjs +19 -4
  182. package/template/scripts/lib/lifecycle-context-query.mjs +5 -1
  183. package/template/scripts/lib/lifecycle-controls.mjs +1 -1
  184. package/template/scripts/lib/lifecycle-execution-scope.mjs +92 -0
  185. package/template/scripts/lib/lifecycle-registry.mjs +2 -1
  186. package/template/scripts/lib/lifecycle-transition.mjs +21 -3
  187. package/template/scripts/lib/openapi-draft-validation.mjs +2 -1
  188. package/template/scripts/lib/skill-registry.mjs +10 -3
  189. package/template/scripts/lib/skill-supply-chain.mjs +33 -14
  190. package/template/scripts/lib/slice-contract-preparation.mjs +16 -14
  191. package/template/scripts/lib/slice-contract-views.mjs +1 -1
  192. package/template/scripts/lib/slice-contract.mjs +18 -3
  193. package/template/scripts/lib/slice-execution-preflight.mjs +7 -3
  194. package/template/scripts/lib/slice-repositories.mjs +1 -1
  195. package/template/scripts/lib/slice-task-package.mjs +3 -2
  196. package/template/scripts/lib/stage-tracking-migration.mjs +176 -0
  197. package/template/scripts/lib/stage-tracking.mjs +184 -0
  198. package/template/scripts/lib/strategic-handoff-consumption.mjs +5 -4
  199. package/template/scripts/lib/strategic-handoff-io.mjs +5 -2
  200. package/template/scripts/lib/strategic-handoff-routing.mjs +31 -0
  201. package/template/scripts/lib/strategic-handoff.mjs +4 -2
  202. package/template/scripts/lib/task-package.mjs +2 -0
  203. package/template/scripts/lib/technical-design-boundary.mjs +4 -2
  204. package/template/scripts/lib/ui-baseline.mjs +1 -1
  205. package/template/scripts/lib/user-decision.mjs +1 -1
  206. package/template/scripts/lib/validation-phase.mjs +72 -0
  207. package/template/scripts/stage-tracking +25 -0
  208. package/template/scripts/strategic-consumer-entry +47 -0
  209. package/template/scripts/verify-context-reconciliation +4 -3
  210. package/template/scripts/verify-lifecycle-checkpoint +10 -0
  211. package/template/scripts/verify-project-instance +11 -10
  212. package/template/skills-lock.json +17 -32
  213. package/template.manifest.json +18 -3
  214. package/template.snapshot.json +5 -5
  215. package/template/.agents/skills/grill-me/SKILL.md +0 -7
  216. package/template/.agents/skills/grill-me/agents/openai.yaml +0 -5
  217. package/template/.agents/skills/yss-distributed-id/assets/AutoIdInterceptor.java +0 -246
  218. package/template/.agents/skills/yss-distributed-id/assets/EnableDistributedId.java +0 -25
  219. package/template/.agents/skills/yss-distributed-id/assets/LeafConf.java +0 -36
  220. package/template/.codex/skills/grill-me/SKILL.md +0 -7
  221. package/template/.codex/skills/grill-me/agents/openai.yaml +0 -5
  222. package/template/.codex/skills/yss-distributed-id/assets/AutoIdInterceptor.java +0 -246
  223. package/template/.codex/skills/yss-distributed-id/assets/EnableDistributedId.java +0 -25
  224. package/template/.codex/skills/yss-distributed-id/assets/LeafConf.java +0 -36
  225. package/template/.cursor/skills/grill-me/SKILL.md +0 -7
  226. package/template/.cursor/skills/grill-me/agents/openai.yaml +0 -5
  227. package/template/.cursor/skills/yss-distributed-id/assets/AutoIdInterceptor.java +0 -246
  228. package/template/.cursor/skills/yss-distributed-id/assets/EnableDistributedId.java +0 -25
  229. package/template/.cursor/skills/yss-distributed-id/assets/LeafConf.java +0 -36
  230. package/template/.pi/skills/grill-me/SKILL.md +0 -7
  231. package/template/.pi/skills/grill-me/agents/openai.yaml +0 -5
  232. package/template/.pi/skills/yss-distributed-id/assets/AutoIdInterceptor.java +0 -246
  233. package/template/.pi/skills/yss-distributed-id/assets/EnableDistributedId.java +0 -25
  234. package/template/.pi/skills/yss-distributed-id/assets/LeafConf.java +0 -36
  235. package/template/docs/agents/yss-plugin-dependency-contract.md +0 -45
  236. package/template/docs/api/.gitkeep +0 -0
  237. package/template/docs/api/specs/.gitkeep +0 -0
  238. package/template/docs/architecture/.gitkeep +0 -0
  239. package/template/docs/design/facts/antdv-next/1.5.2/cli-help.txt +0 -38
  240. package/template/docs/design/facts/antdv-next/1.5.2/component-list.json +0 -434
  241. package/template/docs/design/facts/antdv-next/1.5.2/components/Alert/demo-basic.json +0 -7
  242. package/template/docs/design/facts/antdv-next/1.5.2/components/Alert/info.json +0 -246
  243. package/template/docs/design/facts/antdv-next/1.5.2/components/Alert/semantic.json +0 -40
  244. package/template/docs/design/facts/antdv-next/1.5.2/components/Alert/token.json +0 -32
  245. package/template/docs/design/facts/antdv-next/1.5.2/components/Button/demo-basic.json +0 -7
  246. package/template/docs/design/facts/antdv-next/1.5.2/components/Button/info.json +0 -190
  247. package/template/docs/design/facts/antdv-next/1.5.2/components/Button/semantic.json +0 -20
  248. package/template/docs/design/facts/antdv-next/1.5.2/components/Button/token.json +0 -256
  249. package/template/docs/design/facts/antdv-next/1.5.2/components/Input/demo-basic.json +0 -7
  250. package/template/docs/design/facts/antdv-next/1.5.2/components/Input/info.json +0 -460
  251. package/template/docs/design/facts/antdv-next/1.5.2/components/Input/semantic.json +0 -70
  252. package/template/docs/design/facts/antdv-next/1.5.2/components/Input/token.json +0 -123
  253. package/template/docs/design/facts/antdv-next/1.5.2/components/Modal/demo-basic.json +0 -7
  254. package/template/docs/design/facts/antdv-next/1.5.2/components/Modal/info.json +0 -646
  255. package/template/docs/design/facts/antdv-next/1.5.2/components/Modal/semantic.json +0 -50
  256. package/template/docs/design/facts/antdv-next/1.5.2/components/Modal/token.json +0 -130
  257. package/template/docs/design/facts/antdv-next/1.5.2/components/Select/demo-basic.json +0 -7
  258. package/template/docs/design/facts/antdv-next/1.5.2/components/Select/info.json +0 -640
  259. package/template/docs/design/facts/antdv-next/1.5.2/components/Select/semantic.json +0 -70
  260. package/template/docs/design/facts/antdv-next/1.5.2/components/Select/token.json +0 -172
  261. package/template/docs/design/facts/antdv-next/1.5.2/components/Table/demo-basic.json +0 -7
  262. package/template/docs/design/facts/antdv-next/1.5.2/components/Table/info.json +0 -1010
  263. package/template/docs/design/facts/antdv-next/1.5.2/components/Table/semantic.json +0 -70
  264. package/template/docs/design/facts/antdv-next/1.5.2/components/Table/token.json +0 -263
  265. package/template/docs/design/facts/antdv-next/1.5.2/components/Tag/demo-basic.json +0 -7
  266. package/template/docs/design/facts/antdv-next/1.5.2/components/Tag/info.json +0 -321
  267. package/template/docs/design/facts/antdv-next/1.5.2/components/Tag/semantic.json +0 -25
  268. package/template/docs/design/facts/antdv-next/1.5.2/components/Tag/token.json +0 -25
  269. package/template/docs/design/facts/antdv-next/1.5.2/design-md.json +0 -3
  270. package/template/docs/design/facts/antdv-next/1.5.2/manifest.json +0 -215
  271. package/template/docs/design/facts/antdv-next/1.5.2/resolution-probe.json +0 -5
  272. package/template/docs/design/prototypes/.gitkeep +0 -1
  273. package/template/docs/implementation/.gitkeep +0 -1
  274. package/template/docs/plan/IDEATION.md +0 -96
  275. package/template/docs/process/PDCA-SCRUM.md +0 -10
  276. package/template/docs/process/harness-executive-blueprint.md +0 -10
  277. package/template/docs/releases/.gitkeep +0 -1
  278. package/template/docs/requirements/README.md +0 -85
  279. package/template/docs/requirements/tickets/.gitkeep +0 -1
  280. package/template/docs/templates/agent-brief-template.md +0 -46
  281. package/template/docs/templates/architecture-proposal-template.md +0 -18
  282. package/template/docs/templates/implementation-plan-template.md +0 -16
  283. package/template/docs/templates/implementation-routing-template.md +0 -350
  284. package/template/docs/templates/requirement-freeze-template.md +0 -63
  285. package/template/docs/templates/risk-register-template.md +0 -11
  286. package/template/docs/templates/user-story-template.md +0 -20
  287. package/template/docs/testing/README.md +0 -110
@@ -1,1010 +0,0 @@
1
- {
2
- "name": "Table",
3
- "nameZh": "表格",
4
- "description": "A table displays rows of data.",
5
- "props": [
6
- {
7
- "name": "bordered",
8
- "type": "boolean",
9
- "default": "false",
10
- "description": "Whether to show all table borders",
11
- "descriptionZh": "是否展示外边框和列边框"
12
- },
13
- {
14
- "name": "classes",
15
- "type": "Record\\<[SemanticDOM](#semantic-dom), string\\> \\| (info: \\{ props \\})=> Record\\<[SemanticDOM](#semantic-dom), string\\>",
16
- "default": "-",
17
- "description": "Customize class for each semantic structure inside the component. Supports object or function.",
18
- "descriptionZh": "用于自定义组件内部各语义化结构的 class,支持对象或函数"
19
- },
20
- {
21
- "name": "column",
22
- "type": "Partial\\<[ColumnType](#column)\\>",
23
- "default": "-",
24
- "description": "Default props for every column. See [Column](#column). It only applies when the column does not define the same property.",
25
- "descriptionZh": "统一列配置,参考 [Column](#column),仅在单列未声明同名属性时生效"
26
- },
27
- {
28
- "name": "columns",
29
- "type": "[ColumnsType](#column)\\[\\]",
30
- "default": "-",
31
- "description": "Columns of table",
32
- "descriptionZh": "表格列的配置描述,具体项见下表"
33
- },
34
- {
35
- "name": "components",
36
- "type": "[components](#components)",
37
- "default": "-",
38
- "description": "Override default table elements",
39
- "descriptionZh": "覆盖默认的 table 元素"
40
- },
41
- {
42
- "name": "dataSource",
43
- "type": "object[]",
44
- "default": "-",
45
- "description": "Data record array to be displayed",
46
- "descriptionZh": "数据数组"
47
- },
48
- {
49
- "name": "expandable",
50
- "type": "[expandable](#expandable)",
51
- "default": "-",
52
- "description": "Config expandable content",
53
- "descriptionZh": "配置展开属性"
54
- },
55
- {
56
- "name": "getPopupContainer",
57
- "type": "(triggerNode) => HTMLElement",
58
- "default": "() => TableHtmlElement",
59
- "description": "The render container of dropdowns in table",
60
- "descriptionZh": "设置表格内各类浮层的渲染节点,如筛选菜单"
61
- },
62
- {
63
- "name": "loading",
64
- "type": "boolean \\| [Spin Props](/components/spin/#props)",
65
- "default": "false",
66
- "description": "Loading status of table",
67
- "descriptionZh": "页面是否加载中"
68
- },
69
- {
70
- "name": "locale",
71
- "type": "object",
72
- "default": "[默认值](https://github.com/ant-design/ant-design/blob/6dae4a7e18ad1ba193aedd5ab6867e1d823e2aa4/components/locale/zh_CN.tsx#L20-L37)",
73
- "description": "The i18n text including filter, sort, empty text, etc",
74
- "descriptionZh": "默认文案设置,目前包括排序、过滤、空数据文案"
75
- },
76
- {
77
- "name": "pagination",
78
- "type": "false \\| TablePaginationConfig",
79
- "default": "-",
80
- "description": "Config of pagination. You can ref table pagination [config](#pagination) or full [`pagination`](/components/pagination/) document, hide it by setting it to `false`",
81
- "descriptionZh": "分页器,参考[配置项](#pagination)或 [pagination](/components/pagination-cn) 文档,设为 false 时不展示和进行分页"
82
- },
83
- {
84
- "name": "rowClassName",
85
- "type": "function(record, index): string",
86
- "default": "-",
87
- "description": "Row's className",
88
- "descriptionZh": "表格行的类名"
89
- },
90
- {
91
- "name": "rowKey",
92
- "type": "string \\| function(record): string",
93
- "default": "`key`",
94
- "description": "Row's unique key, could be a string or function that returns a string",
95
- "descriptionZh": "表格行 key 的取值,可以是字符串或一个函数"
96
- },
97
- {
98
- "name": "rowSelection",
99
- "type": "object",
100
- "default": "-",
101
- "description": "Row selection [config](#rowselection)",
102
- "descriptionZh": "表格行是否可选择,[配置项](#rowselection)"
103
- },
104
- {
105
- "name": "rowHoverable",
106
- "type": "boolean",
107
- "default": "true",
108
- "description": "Row hover",
109
- "descriptionZh": "表格行是否开启 hover 交互"
110
- },
111
- {
112
- "name": "scroll",
113
- "type": "object",
114
- "default": "-",
115
- "description": "Whether the table can be scrollable, [config](#scroll)",
116
- "descriptionZh": "表格是否可滚动,也可以指定滚动区域的宽、高,[配置项](#scroll)"
117
- },
118
- {
119
- "name": "showHeader",
120
- "type": "boolean",
121
- "default": "true",
122
- "description": "Whether to show table header",
123
- "descriptionZh": "是否显示表头"
124
- },
125
- {
126
- "name": "showSorterTooltip",
127
- "type": "boolean \\| [Tooltip props](/components/tooltip/) & `{target?: 'full-header' \\| 'sorter-icon' }`",
128
- "default": "\\{ target: 'full-header' \\}",
129
- "description": "The header show next sorter direction tooltip. It will be set as the property of Tooltip if its type is object",
130
- "descriptionZh": "表头是否显示下一次排序的 tooltip 提示。当参数类型为对象时,将被设置为 Tooltip 的属性"
131
- },
132
- {
133
- "name": "size",
134
- "type": "`large` \\| `middle` \\| `small`",
135
- "default": "`large`",
136
- "description": "Size of table",
137
- "descriptionZh": "表格大小"
138
- },
139
- {
140
- "name": "sortDirections",
141
- "type": "Array",
142
- "default": "\\[`ascend`, `descend`]",
143
- "description": "Supported sort way, could be `ascend`, `descend`",
144
- "descriptionZh": "支持的排序方式,取值为 `ascend` `descend`"
145
- },
146
- {
147
- "name": "sticky",
148
- "type": "boolean \\| `{offsetHeader?: number, offsetScroll?: number, getContainer?: () => HTMLElement}`",
149
- "default": "-",
150
- "description": "Set sticky header and scroll bar",
151
- "descriptionZh": "设置粘性头部和滚动条"
152
- },
153
- {
154
- "name": "styles",
155
- "type": "Record\\<[SemanticDOM](#semantic-dom), CSSProperties\\> \\| (info: \\{ props \\})=> Record\\<[SemanticDOM](#semantic-dom), CSSProperties\\>",
156
- "default": "-",
157
- "description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
158
- "descriptionZh": "用于自定义组件内部各语义化结构的行内 style,支持对象或函数"
159
- },
160
- {
161
- "name": "summary",
162
- "type": "VueNode \\| function(currentPageData)",
163
- "default": "-",
164
- "description": "Summary content renderer. You can also use the `#summary` slot.",
165
- "descriptionZh": "总结栏,也可以使用 `#summary` 插槽"
166
- },
167
- {
168
- "name": "tableLayout",
169
- "type": "- \\| `auto` \\| `fixed`",
170
- "default": "-<hr />`fixed` when header/columns are fixed, or using `column.ellipsis`",
171
- "description": "The [table-layout](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout) attribute of table element",
172
- "descriptionZh": "表格元素的 [table-layout](https://developer.mozilla.org/zh-CN/docs/Web/CSS/table-layout) 属性,设为 `fixed` 表示内容不会影响列的布局"
173
- },
174
- {
175
- "name": "title",
176
- "type": "VueNode \\| function(currentPageData)",
177
- "default": "-",
178
- "description": "Table title renderer. You can also use the `#title` slot.",
179
- "descriptionZh": "表格标题,也可以使用 `#title` 插槽"
180
- },
181
- {
182
- "name": "dropdownPrefixCls",
183
- "type": "string",
184
- "default": "-",
185
- "description": "-",
186
- "descriptionZh": "-"
187
- },
188
- {
189
- "name": "virtual",
190
- "type": "boolean",
191
- "default": "-",
192
- "description": "Support virtual list",
193
- "descriptionZh": "支持虚拟列表"
194
- },
195
- {
196
- "name": "footer",
197
- "type": "VueNode \\| function(currentPageData)",
198
- "default": "-",
199
- "description": "",
200
- "descriptionZh": "表格尾部,也可以使用 `#footer` 插槽"
201
- }
202
- ],
203
- "events": [
204
- {
205
- "name": "change",
206
- "type": "( pagination: TablePaginationConfig, filters: Record&lt;string, FilterValue \\| null&gt;, sorter: SorterResult&lt;RecordType&gt; \\| SorterResult&lt;RecordType&gt;[], extra: TableCurrentDataSource&lt;RecordType&gt;, ) =&gt; void",
207
- "default": "",
208
- "description": "Callback executed when pagination, filters or sorter is changed",
209
- "descriptionZh": "分页、排序、筛选变化时触发"
210
- },
211
- {
212
- "name": "update:expandedRowKeys",
213
- "type": "(keys: readonly Key[]) =&gt; void",
214
- "default": "",
215
- "description": "-",
216
- "descriptionZh": "-"
217
- },
218
- {
219
- "name": "scroll",
220
- "type": "NonNullable&lt;VcTableProps['onScroll']&gt;",
221
- "default": "",
222
- "description": "Whether the table can be scrollable, [config](#scroll)",
223
- "descriptionZh": "表格是否可滚动,也可以指定滚动区域的宽、高,[配置项](#scroll)"
224
- },
225
- {
226
- "name": "headerRow",
227
- "type": "function(columns, index)",
228
- "default": "",
229
- "description": "Set props on per header row",
230
- "descriptionZh": "设置头部行属性"
231
- },
232
- {
233
- "name": "row",
234
- "type": "function(record, index)",
235
- "default": "",
236
- "description": "Set props on per row",
237
- "descriptionZh": "设置行属性"
238
- }
239
- ],
240
- "slots": [
241
- {
242
- "name": "title",
243
- "type": "(data: readonly RecordType[]) =&gt; any",
244
- "default": "",
245
- "description": "Table title renderer",
246
- "descriptionZh": "表格标题"
247
- },
248
- {
249
- "name": "footer",
250
- "type": "(data: readonly RecordType[]) =&gt; any",
251
- "default": "",
252
- "description": "Table footer renderer",
253
- "descriptionZh": "表格尾部"
254
- },
255
- {
256
- "name": "summary",
257
- "type": "(data: readonly RecordType[]) =&gt; any",
258
- "default": "",
259
- "description": "Summary content",
260
- "descriptionZh": "总结栏"
261
- },
262
- {
263
- "name": "emptyText",
264
- "type": "() =&gt; any",
265
- "default": "",
266
- "description": "-",
267
- "descriptionZh": "-"
268
- },
269
- {
270
- "name": "expandIcon",
271
- "type": "(info: any) =&gt; any",
272
- "default": "",
273
- "description": "-",
274
- "descriptionZh": "-"
275
- },
276
- {
277
- "name": "expandedRowRender",
278
- "type": "(ctx: &#123; record: RecordType, index: number, indent: number, expanded: boolean &#125;) =&gt; any",
279
- "default": "",
280
- "description": "-",
281
- "descriptionZh": "-"
282
- },
283
- {
284
- "name": "headerCell",
285
- "type": "(ctx: &#123; column: ColumnType&lt;RecordType&gt;, index: number, text: any &#125;) =&gt; any",
286
- "default": "",
287
- "description": "-",
288
- "descriptionZh": "-"
289
- },
290
- {
291
- "name": "bodyCell",
292
- "type": "(ctx: &#123; column: ColumnType&lt;RecordType&gt;, index: number, text: any, record: RecordType &#125;) =&gt; any",
293
- "default": "",
294
- "description": "-",
295
- "descriptionZh": "-"
296
- },
297
- {
298
- "name": "filterDropdown",
299
- "type": "(ctx: FilterDropdownProps & &#123; column: ColumnType&lt;RecordType&gt; &#125;) =&gt; any",
300
- "default": "",
301
- "description": "-",
302
- "descriptionZh": "-"
303
- },
304
- {
305
- "name": "filterIcon",
306
- "type": "(ctx: &#123; column: ColumnType&lt;RecordType&gt;, filtered: boolean &#125;) =&gt; any",
307
- "default": "",
308
- "description": "-",
309
- "descriptionZh": "-"
310
- }
311
- ],
312
- "methods": [],
313
- "subComponentProps": {
314
- "Column": {
315
- "properties": [
316
- {
317
- "name": "align",
318
- "type": "`left` \\| `right` \\| `center`",
319
- "default": "`left`",
320
- "description": "The specify which way that column is aligned",
321
- "descriptionZh": "设置列的对齐方式"
322
- },
323
- {
324
- "name": "className",
325
- "type": "string",
326
- "default": "-",
327
- "description": "The className of this column",
328
- "descriptionZh": "列样式类名"
329
- },
330
- {
331
- "name": "colSpan",
332
- "type": "number",
333
- "default": "-",
334
- "description": "Span of this column's title",
335
- "descriptionZh": "表头列合并,设置为 0 时,不渲染"
336
- },
337
- {
338
- "name": "dataIndex",
339
- "type": "string \\| string\\[]",
340
- "default": "-",
341
- "description": "Display field of the data record, support nest path by string array",
342
- "descriptionZh": "列数据在数据项中对应的路径,支持通过数组查询嵌套路径"
343
- },
344
- {
345
- "name": "defaultFilteredValue",
346
- "type": "string\\[]",
347
- "default": "-",
348
- "description": "Default filtered values",
349
- "descriptionZh": "默认筛选值"
350
- },
351
- {
352
- "name": "filterResetToDefaultFilteredValue",
353
- "type": "boolean",
354
- "default": "false",
355
- "description": "click the reset button, whether to restore the default filter",
356
- "descriptionZh": "点击重置按钮的时候,是否恢复默认筛选值"
357
- },
358
- {
359
- "name": "defaultSortOrder",
360
- "type": "`ascend` \\| `descend`",
361
- "default": "-",
362
- "description": "Default order of sorted values",
363
- "descriptionZh": "默认排序顺序"
364
- },
365
- {
366
- "name": "ellipsis",
367
- "type": "boolean \\| \\{ showTitle?: boolean \\}",
368
- "default": "false",
369
- "description": "The ellipsis cell content, not working with sorter and filters for now.<br />tableLayout would be `fixed` when `ellipsis` is `true` or `{ showTitle?: boolean }`",
370
- "descriptionZh": "超过宽度将自动省略,暂不支持和排序筛选一起使用。<br />设置为 `true` 或 `{ showTitle?: boolean }` 时,表格布局将变成 `tableLayout=\"fixed\"`。"
371
- },
372
- {
373
- "name": "filterDropdown",
374
- "type": "VueNode \\| (props: [FilterDropdownProps](https://github.com/antdv-next/antdv-next/blob/main/packages/antdv-next/src/table/interface.ts#L94)) => VueNode",
375
- "default": "-",
376
- "description": "Customized filter overlay",
377
- "descriptionZh": "可以自定义筛选菜单,此函数只负责渲染图层,需要自行编写各种交互"
378
- },
379
- {
380
- "name": "filtered",
381
- "type": "boolean",
382
- "default": "false",
383
- "description": "Whether the `dataSource` is filtered",
384
- "descriptionZh": "是否处于筛选状态"
385
- },
386
- {
387
- "name": "filteredValue",
388
- "type": "string\\[]",
389
- "default": "-",
390
- "description": "Controlled filtered value, filter icon will highlight",
391
- "descriptionZh": "筛选的受控属性,外界可用此控制列的筛选状态,值为已筛选的 value 数组"
392
- },
393
- {
394
- "name": "filterIcon",
395
- "type": "VueNode \\| (filtered: boolean) => VueNode",
396
- "default": "-",
397
- "description": "Customized filter icon",
398
- "descriptionZh": "自定义 filter 图标。"
399
- },
400
- {
401
- "name": "filterOnClose",
402
- "type": "boolean",
403
- "default": "true",
404
- "description": "Whether to trigger filter when the filter menu closes",
405
- "descriptionZh": "是否在筛选菜单关闭时触发筛选"
406
- },
407
- {
408
- "name": "filterMultiple",
409
- "type": "boolean",
410
- "default": "true",
411
- "description": "Whether multiple filters can be selected",
412
- "descriptionZh": "是否多选"
413
- },
414
- {
415
- "name": "filterMode",
416
- "type": "'menu' \\| 'tree'",
417
- "default": "'menu'",
418
- "description": "To specify the filter interface",
419
- "descriptionZh": "指定筛选菜单的用户界面"
420
- },
421
- {
422
- "name": "filterSearch",
423
- "type": "boolean \\| function(input, record):boolean",
424
- "default": "false",
425
- "description": "Whether to be searchable for filter menu",
426
- "descriptionZh": "筛选菜单项是否可搜索"
427
- },
428
- {
429
- "name": "filters",
430
- "type": "object\\[]",
431
- "default": "-",
432
- "description": "Filter menu config",
433
- "descriptionZh": "表头的筛选菜单项"
434
- },
435
- {
436
- "name": "filterDropdownProps",
437
- "type": "[DropdownProps](/components/dropdown#api)",
438
- "default": "-",
439
- "description": "Customized dropdown props",
440
- "descriptionZh": "自定义下拉属性"
441
- },
442
- {
443
- "name": "fixed",
444
- "type": "boolean \\| string",
445
- "default": "false",
446
- "description": "(IE not support) Set column to be fixed: `true`(same as `'start'`) `'start'` `'end'`",
447
- "descriptionZh": "(IE 下无效)列是否固定,可选 `true` (等效于 `'start'`) `'start'` `'end'`"
448
- },
449
- {
450
- "name": "key",
451
- "type": "string",
452
- "default": "-",
453
- "description": "Unique key of this column, you can ignore this prop if you've set a unique `dataIndex`",
454
- "descriptionZh": "Vue 需要的 key,如果已经设置了唯一的 `dataIndex`,可以忽略这个属性"
455
- },
456
- {
457
- "name": "render",
458
- "type": "(value: V, record: T, index: number): VueNode",
459
- "default": "-",
460
- "description": "Renderer of the table cell. `value` is the value of current cell; `record` is the value object of current row; `index` is the row number. The return value should be a VueNode",
461
- "descriptionZh": "生成复杂数据的渲染函数,参数分别为当前单元格的值,当前行数据,行索引"
462
- },
463
- {
464
- "name": "responsive",
465
- "type": "[Breakpoint](https://github.com/antdv-next/antdv-next/blob/main/packages/antdv-next/src/_util/responsiveObserver.ts#L9)\\[]",
466
- "default": "-",
467
- "description": "The list of breakpoints at which to display this column. Always visible if not set",
468
- "descriptionZh": "响应式 breakpoint 配置列表。未设置则始终可见。"
469
- },
470
- {
471
- "name": "rowScope",
472
- "type": "`row` \\| `rowgroup`",
473
- "default": "-",
474
- "description": "Set scope attribute for all cells in this column",
475
- "descriptionZh": "设置列范围"
476
- },
477
- {
478
- "name": "shouldCellUpdate",
479
- "type": "(record, prevRecord) => boolean",
480
- "default": "-",
481
- "description": "Control cell render logic",
482
- "descriptionZh": "自定义单元格渲染时机"
483
- },
484
- {
485
- "name": "showSorterTooltip",
486
- "type": "boolean \\| [Tooltip props](/components/tooltip/) & `{target?: 'full-header' \\| 'sorter-icon' }`",
487
- "default": "\\{ target: 'full-header' \\}",
488
- "description": "If header show next sorter direction tooltip, override `showSorterTooltip` in table",
489
- "descriptionZh": "表头显示下一次排序的 tooltip 提示, 覆盖 table 中 `showSorterTooltip`"
490
- },
491
- {
492
- "name": "sortDirections",
493
- "type": "Array",
494
- "default": "\\[`ascend`, `descend`]",
495
- "description": "Supported sort way, override `sortDirections` in `Table`, could be `ascend`, `descend`",
496
- "descriptionZh": "支持的排序方式,覆盖 `Table` 中 `sortDirections`, 取值为 `ascend` `descend`"
497
- },
498
- {
499
- "name": "sorter",
500
- "type": "function \\| boolean \\| \\{ compare: function, multiple: number \\}",
501
- "default": "-",
502
- "description": "Sort function for local sort, see [Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)'s compareFunction. If it is server-side sorting, set to `true`, but if you want to support multi-column sorting, you can set it to `{ multiple: number }`",
503
- "descriptionZh": "排序函数,本地排序使用一个函数(参考 [Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) 的 compareFunction)。需要服务端排序可设为 `true`(单列排序) 或 `{ multiple: number }`(多列排序)"
504
- },
505
- {
506
- "name": "sortOrder",
507
- "type": "`ascend` \\| `descend` \\| null",
508
- "default": "-",
509
- "description": "Order of sorted values: `ascend` `descend` `null`",
510
- "descriptionZh": "排序的受控属性,外界可用此控制列的排序,可设置为 `ascend` `descend` `null`"
511
- },
512
- {
513
- "name": "sortIcon",
514
- "type": "(props: \\{ sortOrder \\}) => VueNode",
515
- "default": "-",
516
- "description": "Customized sort icon",
517
- "descriptionZh": "自定义 sort 图标"
518
- },
519
- {
520
- "name": "title",
521
- "type": "VueNode \\| (\\{ sortColumns, filters \\}) => VueNode",
522
- "default": "-",
523
- "description": "Title of this column",
524
- "descriptionZh": "列头显示文字(函数用法 `3.10.0` 后支持)"
525
- },
526
- {
527
- "name": "width",
528
- "type": "string \\| number",
529
- "default": "-",
530
- "description": "Width of this column ([width not working?](https://github.com/ant-design/ant-design/issues/13825#issuecomment-449889241))",
531
- "descriptionZh": "列宽"
532
- },
533
- {
534
- "name": "minWidth",
535
- "type": "number",
536
- "default": "-",
537
- "description": "Min width of this column, only works when `tableLayout=\"auto\"`",
538
- "descriptionZh": "最小列宽度,只在 `tableLayout=\"auto\"` 时有效"
539
- },
540
- {
541
- "name": "hidden",
542
- "type": "boolean",
543
- "default": "false",
544
- "description": "Hidden this column",
545
- "descriptionZh": "隐藏列"
546
- },
547
- {
548
- "name": "onCell",
549
- "type": "function(record, rowIndex)",
550
- "default": "-",
551
- "description": "Set props on per cell",
552
- "descriptionZh": "设置单元格属性"
553
- },
554
- {
555
- "name": "onFilter",
556
- "type": "function(value, record) => boolean",
557
- "default": "-",
558
- "description": "Function that determines if the row is displayed when filtered",
559
- "descriptionZh": "本地模式下,确定筛选的运行函数"
560
- },
561
- {
562
- "name": "onHeaderCell",
563
- "type": "function(column)",
564
- "default": "-",
565
- "description": "Set props on per header cell",
566
- "descriptionZh": "设置头部单元格属性"
567
- }
568
- ],
569
- "events": [],
570
- "slots": [],
571
- "methods": []
572
- },
573
- "ColumnGroup": {
574
- "properties": [
575
- {
576
- "name": "title",
577
- "type": "VueNode",
578
- "default": "-",
579
- "description": "Title of the column group",
580
- "descriptionZh": "列头显示文字"
581
- }
582
- ],
583
- "events": [],
584
- "slots": [],
585
- "methods": []
586
- },
587
- "components": {
588
- "properties": [
589
- {
590
- "name": "table",
591
- "type": "Component",
592
- "default": "-",
593
- "description": "Customize table element",
594
- "descriptionZh": "自定义 table 元素"
595
- },
596
- {
597
- "name": "header.table",
598
- "type": "Component",
599
- "default": "-",
600
- "description": "Customize header table element",
601
- "descriptionZh": "自定义表头 table 元素"
602
- },
603
- {
604
- "name": "header.wrapper",
605
- "type": "Component",
606
- "default": "-",
607
- "description": "Customize header wrapper element",
608
- "descriptionZh": "自定义表头 wrapper 元素"
609
- },
610
- {
611
- "name": "header.row",
612
- "type": "Component",
613
- "default": "-",
614
- "description": "Customize header row element",
615
- "descriptionZh": "自定义表头行元素"
616
- },
617
- {
618
- "name": "header.cell",
619
- "type": "Component",
620
- "default": "-",
621
- "description": "Customize header cell element",
622
- "descriptionZh": "自定义表头单元格元素"
623
- },
624
- {
625
- "name": "body",
626
- "type": "Function \\| object",
627
- "default": "-",
628
- "description": "Customize body render function or body element collection",
629
- "descriptionZh": "自定义表体渲染函数或表体元素集合"
630
- },
631
- {
632
- "name": "body.wrapper",
633
- "type": "Component",
634
- "default": "-",
635
- "description": "Customize body wrapper element",
636
- "descriptionZh": "自定义表体 wrapper 元素"
637
- },
638
- {
639
- "name": "body.row",
640
- "type": "Component",
641
- "default": "-",
642
- "description": "Customize body row element",
643
- "descriptionZh": "自定义表体行元素"
644
- },
645
- {
646
- "name": "body.cell",
647
- "type": "Component",
648
- "default": "-",
649
- "description": "Customize body cell element",
650
- "descriptionZh": "自定义表体单元格元素"
651
- }
652
- ],
653
- "events": [],
654
- "slots": [],
655
- "methods": []
656
- },
657
- "pagination": {
658
- "properties": [
659
- {
660
- "name": "placement",
661
- "type": "Array",
662
- "default": "\\[`bottomEnd`]",
663
- "description": "Specify the placement of `Pagination`, could be`topStart` \\| `topCenter` \\| `topEnd` \\|`bottomStart` \\| `bottomCenter` \\| `bottomEnd` \\| `none`",
664
- "descriptionZh": "指定分页显示的位置, 取值为`topStart` \\| `topCenter` \\| `topEnd` \\|`bottomStart` \\| `bottomCenter` \\| `bottomEnd`\\| `none`"
665
- }
666
- ],
667
- "events": [],
668
- "slots": [],
669
- "methods": []
670
- },
671
- "expandable": {
672
- "properties": [
673
- {
674
- "name": "childrenColumnName",
675
- "type": "string",
676
- "default": "children",
677
- "description": "The column contains children to display",
678
- "descriptionZh": "指定树形结构的列名"
679
- },
680
- {
681
- "name": "columnTitle",
682
- "type": "VueNode",
683
- "default": "-",
684
- "description": "Set the title of the expand column",
685
- "descriptionZh": "自定义展开列表头"
686
- },
687
- {
688
- "name": "columnWidth",
689
- "type": "string \\| number",
690
- "default": "-",
691
- "description": "Set the width of the expand column",
692
- "descriptionZh": "自定义展开列宽度"
693
- },
694
- {
695
- "name": "defaultExpandAllRows",
696
- "type": "boolean",
697
- "default": "false",
698
- "description": "Expand all rows initially",
699
- "descriptionZh": "初始时,是否展开所有行"
700
- },
701
- {
702
- "name": "defaultExpandedRowKeys",
703
- "type": "string\\[]",
704
- "default": "-",
705
- "description": "Initial expanded row keys",
706
- "descriptionZh": "默认展开的行"
707
- },
708
- {
709
- "name": "expandedRowClassName",
710
- "type": "string \\| (record, index, indent) => string",
711
- "default": "-",
712
- "description": "Expanded row's className",
713
- "descriptionZh": "展开行的 className"
714
- },
715
- {
716
- "name": "expandedRowKeys",
717
- "type": "string\\[]",
718
- "default": "-",
719
- "description": "Current expanded row keys",
720
- "descriptionZh": "展开的行,控制属性"
721
- },
722
- {
723
- "name": "expandedRowRender",
724
- "type": "function(record, index, indent, expanded): VueNode",
725
- "default": "-",
726
- "description": "Expanded container render for each row",
727
- "descriptionZh": "额外的展开行"
728
- },
729
- {
730
- "name": "expandIcon",
731
- "type": "function(props): VueNode",
732
- "default": "-",
733
- "description": "Customize row expand Icon. Ref [example](https://stackblitz.com/edit/vitejs-vite-jezqinto?file=src%2FApp.vue)",
734
- "descriptionZh": "自定义展开图标,参考[示例](https://stackblitz.com/edit/vitejs-vite-jezqinto?file=src%2FApp.vue)"
735
- },
736
- {
737
- "name": "expandRowByClick",
738
- "type": "boolean",
739
- "default": "false",
740
- "description": "Whether to expand row by clicking anywhere in the whole row",
741
- "descriptionZh": "通过点击行来展开子行"
742
- },
743
- {
744
- "name": "fixed",
745
- "type": "boolean \\| string",
746
- "default": "false",
747
- "description": "Whether the expansion icon is fixed. Optional true `left` `right`",
748
- "descriptionZh": "控制展开图标是否固定,可选 `true` `'left'` `'right'`"
749
- },
750
- {
751
- "name": "forceRender",
752
- "type": "boolean",
753
- "default": "false",
754
- "description": "Force render expanded row content before expansion. In virtual mode, only rows currently mounted by the virtual list are force-rendered; off-screen rows may still be unmounted",
755
- "descriptionZh": "在展开前强制渲染展开行内容。虚拟模式下,仅强制渲染虚拟列表当前挂载的行;屏幕外的行仍可能被卸载"
756
- },
757
- {
758
- "name": "indentSize",
759
- "type": "number",
760
- "default": "15",
761
- "description": "Indent size in pixels of tree data",
762
- "descriptionZh": "展示树形数据时,每层缩进的宽度,以 px 为单位"
763
- },
764
- {
765
- "name": "rowExpandable",
766
- "type": "(record) => boolean",
767
- "default": "-",
768
- "description": "Enable row can be expandable",
769
- "descriptionZh": "设置是否允许行展开(`dataSource` 若存在 `children` 字段将不生效)"
770
- },
771
- {
772
- "name": "showExpandColumn",
773
- "type": "boolean",
774
- "default": "true",
775
- "description": "Show expand column",
776
- "descriptionZh": "是否显示展开图标列"
777
- },
778
- {
779
- "name": "onExpand",
780
- "type": "function(expanded, record)",
781
- "default": "-",
782
- "description": "Callback executed when the row expand icon is clicked",
783
- "descriptionZh": "点击展开图标时触发"
784
- },
785
- {
786
- "name": "onExpandedRowsChange",
787
- "type": "function(expandedRows)",
788
- "default": "-",
789
- "description": "Callback executed when the expanded rows change",
790
- "descriptionZh": "展开的行变化时触发"
791
- }
792
- ],
793
- "events": [],
794
- "slots": [],
795
- "methods": []
796
- },
797
- "rowSelection": {
798
- "properties": [
799
- {
800
- "name": "align",
801
- "type": "`left` \\| `right` \\| `center`",
802
- "default": "`left`",
803
- "description": "Set the alignment of selection column",
804
- "descriptionZh": "设置选择列的对齐方式"
805
- },
806
- {
807
- "name": "checkStrictly",
808
- "type": "boolean",
809
- "default": "true",
810
- "description": "Check table row precisely; parent row and children rows are not associated",
811
- "descriptionZh": "checkable 状态下节点选择完全受控(父子数据选中状态不再关联)"
812
- },
813
- {
814
- "name": "columnTitle",
815
- "type": "VueNode \\| (originalNode: VueNode) => VueNode",
816
- "default": "-",
817
- "description": "Set the title of the selection column",
818
- "descriptionZh": "自定义列表选择框标题"
819
- },
820
- {
821
- "name": "columnWidth",
822
- "type": "string \\| number",
823
- "default": "`32px`",
824
- "description": "Set the width of the selection column",
825
- "descriptionZh": "自定义列表选择框宽度"
826
- },
827
- {
828
- "name": "fixed",
829
- "type": "boolean",
830
- "default": "-",
831
- "description": "Fixed selection column on the left",
832
- "descriptionZh": "把选择框列固定在左边"
833
- },
834
- {
835
- "name": "getCheckboxProps",
836
- "type": "function(record)",
837
- "default": "-",
838
- "description": "Get Checkbox or Radio props",
839
- "descriptionZh": "选择框的默认属性配置"
840
- },
841
- {
842
- "name": "getTitleCheckboxProps",
843
- "type": "function()",
844
- "default": "-",
845
- "description": "Get title Checkbox props",
846
- "descriptionZh": "标题选择框的默认属性配置"
847
- },
848
- {
849
- "name": "hideSelectAll",
850
- "type": "boolean",
851
- "default": "false",
852
- "description": "Hide the selectAll checkbox and custom selection",
853
- "descriptionZh": "隐藏全选勾选框与自定义选择项"
854
- },
855
- {
856
- "name": "preserveSelectedRowKeys",
857
- "type": "boolean",
858
- "default": "-",
859
- "description": "Keep selection `key` even when it removed from `dataSource`",
860
- "descriptionZh": "当数据被删除时仍然保留选项的 `key`"
861
- },
862
- {
863
- "name": "renderCell",
864
- "type": "(checked: boolean, record: T, index: number, originNode: VueNode): VueNode",
865
- "default": "-",
866
- "description": "Renderer of the table cell. Same as `render` in column",
867
- "descriptionZh": "渲染勾选框,用法与 Column 的 `render` 相同"
868
- },
869
- {
870
- "name": "selectedRowKeys",
871
- "type": "string\\[] \\| number\\[]",
872
- "default": "\\[]",
873
- "description": "Controlled selected row keys",
874
- "descriptionZh": "指定选中项的 key 数组,需要和 onChange 进行配合"
875
- },
876
- {
877
- "name": "selections",
878
- "type": "object\\[] \\| boolean",
879
- "default": "-",
880
- "description": "Custom selection [config](#selection), only displays default selections when set to `true`",
881
- "descriptionZh": "自定义选择项 [配置项](#selection), 设为 `true` 时使用默认选择项"
882
- },
883
- {
884
- "name": "type",
885
- "type": "`checkbox` \\| `radio`",
886
- "default": "`checkbox`",
887
- "description": "`checkbox` or `radio`",
888
- "descriptionZh": "多选/单选"
889
- },
890
- {
891
- "name": "onCell",
892
- "type": "function(record, rowIndex)",
893
- "default": "-",
894
- "description": "Set props on per cell. Same as `onCell` in column",
895
- "descriptionZh": "设置单元格属性,用法与 Column 的 `onCell` 相同"
896
- },
897
- {
898
- "name": "onChange",
899
- "type": "function(selectedRowKeys, selectedRows, info: \\{ type \\})",
900
- "default": "-",
901
- "description": "Callback executed when selected rows change",
902
- "descriptionZh": "选中项发生变化时的回调"
903
- },
904
- {
905
- "name": "onSelect",
906
- "type": "function(record, selected, selectedRows, nativeEvent)",
907
- "default": "-",
908
- "description": "Callback executed when select/deselect one row",
909
- "descriptionZh": "用户手动选择/取消选择某行的回调"
910
- },
911
- {
912
- "name": "defaultSelectedRowKeys",
913
- "type": "string\\[] \\| number\\[]",
914
- "default": "\\[]",
915
- "description": "",
916
- "descriptionZh": "默认选中项的 key 数组"
917
- }
918
- ],
919
- "events": [],
920
- "slots": [],
921
- "methods": []
922
- },
923
- "scroll": {
924
- "properties": [
925
- {
926
- "name": "scrollToFirstRowOnChange",
927
- "type": "boolean",
928
- "default": "-",
929
- "description": "Whether to scroll to the top of the table when paging, sorting, filtering changes",
930
- "descriptionZh": "当分页、排序、筛选变化后是否滚动到表格顶部"
931
- },
932
- {
933
- "name": "x",
934
- "type": "string \\| number \\| true",
935
- "default": "-",
936
- "description": "Set horizontal scrolling, can also be used to specify the width of the scroll area, could be number, percent value, true and ['max-content'](https://developer.mozilla.org/en-US/docs/Web/CSS/width#max-content)",
937
- "descriptionZh": "设置横向滚动,也可用于指定滚动区域的宽,可以设置为像素值,百分比,`true` 和 ['max-content'](https://developer.mozilla.org/zh-CN/docs/Web/CSS/width#max-content)"
938
- },
939
- {
940
- "name": "y",
941
- "type": "string \\| number",
942
- "default": "-",
943
- "description": "Set vertical scrolling, can also be used to specify the height of the scroll area, could be string or number",
944
- "descriptionZh": "设置纵向滚动,也可用于指定滚动区域的高,可以设置为像素值"
945
- }
946
- ],
947
- "events": [],
948
- "slots": [],
949
- "methods": []
950
- },
951
- "selection": {
952
- "properties": [
953
- {
954
- "name": "key",
955
- "type": "string",
956
- "default": "-",
957
- "description": "Unique key of this selection",
958
- "descriptionZh": "Vue 需要的 key,建议设置"
959
- },
960
- {
961
- "name": "text",
962
- "type": "VueNode",
963
- "default": "-",
964
- "description": "Display text of this selection",
965
- "descriptionZh": "选择项显示的文字"
966
- },
967
- {
968
- "name": "onSelect",
969
- "type": "function(changeableRowKeys)",
970
- "default": "-",
971
- "description": "Callback executed when this selection is clicked",
972
- "descriptionZh": "选择项点击回调"
973
- }
974
- ],
975
- "events": [],
976
- "slots": [],
977
- "methods": []
978
- }
979
- },
980
- "commonProps": [
981
- {
982
- "name": "style",
983
- "type": "CSSProperties",
984
- "default": "-",
985
- "description": "The additional style",
986
- "descriptionZh": "自定义样式"
987
- },
988
- {
989
- "name": "class",
990
- "type": "string",
991
- "default": "-",
992
- "description": "The additional css class",
993
- "descriptionZh": "自定义类名"
994
- },
995
- {
996
- "name": "rootClass",
997
- "type": "string",
998
- "default": "-",
999
- "description": "ClassName on the root element",
1000
- "descriptionZh": "添加在组件最外层的 className"
1001
- },
1002
- {
1003
- "name": "autoFocus",
1004
- "type": "boolean",
1005
- "default": "false",
1006
- "description": "Auto focus when component mounted, only effective for focusable elements like forms, links, etc.",
1007
- "descriptionZh": "自动获取焦点,仅对表单类、链接、交互容器等可聚焦元素生效"
1008
- }
1009
- ]
1010
- }