Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

docs(core): document List.start and CheckboxInput.isReadOnly props (#3207)

Durvesh Pilankar154ecbf4bf2a
diff --git a/.changeset/doc-missing-props-list-checkbox.md b/.changeset/doc-missing-props-list-checkbox.md
new file mode 100644
index 0000000000..44bc52e1f1
--- /dev/null
+++ b/.changeset/doc-missing-props-list-checkbox.md
@@ -0,0 +1,6 @@
+---
+'@astryxdesign/core': patch
+---
+
+[docs] Document two public props missing from the docsite properties tab: List's `start` (ordered-list counter start) and CheckboxInput's `isReadOnly`
+@durvesh1992
diff --git a/packages/core/src/CheckboxInput/CheckboxInput.doc.mjs b/packages/core/src/CheckboxInput/CheckboxInput.doc.mjs
index 840673f4cc..b960154300 100644
--- a/packages/core/src/CheckboxInput/CheckboxInput.doc.mjs
+++ b/packages/core/src/CheckboxInput/CheckboxInput.doc.mjs
@@ -63,6 +63,13 @@ export const docs = {
description: 'Whether the checkbox is disabled.',
default: 'false',
},
+ {
+ name: 'isReadOnly',
+ type: 'boolean',
+ description:
+ 'Whether the checkbox is read-only. Displays the current state at full opacity but prevents interaction. Unlike `isDisabled`, read-only checkboxes are not visually dimmed.',
+ default: 'false',
+ },
{
name: 'isOptional',
type: 'boolean',
@@ -156,6 +163,7 @@ export const docsZh = {
},
{name: 'isLoading', type: 'boolean', description: '复选框是否处于加载状态。显示旋转器并阻止交互。', default: 'false'},
{name: 'isDisabled', type: 'boolean', description: '复选框是否禁用。', default: 'false'},
+ {name: 'isReadOnly', type: 'boolean', description: '复选框是否为只读。以完整不透明度显示当前状态但阻止交互。与 isDisabled 不同,只读复选框不会变暗。', default: 'false'},
{name: 'isOptional', type: 'boolean', description: '字段是否可选。与 isRequired 互斥。', default: 'false'},
{name: 'isRequired', type: 'boolean', description: '复选框是否必填。与 isOptional 互斥。', default: 'false'},
{name: 'size', type: "'sm' | 'md'", description: '复选框尺寸。sm 用于紧凑布局,md 为默认。', default: "'md'"},
diff --git a/packages/core/src/List/List.doc.mjs b/packages/core/src/List/List.doc.mjs
index 70a4a59e78..e29a7c0517 100644
--- a/packages/core/src/List/List.doc.mjs
+++ b/packages/core/src/List/List.doc.mjs
@@ -61,6 +61,13 @@ export const docs = {
description: "List marker style. 'decimal' renders an <ol> element instead of <ul>.",
default: "'none'",
},
+ {
+ name: 'start',
+ type: 'number',
+ description:
+ "Starting number for ordered lists (listStyle='decimal'). Sets the CSS counter to begin at this value.",
+ default: '1',
+ },
{
name: 'xstyle',
type: 'StyleXStyles',