From d50ff53e7eec47e2a535dd4de89c6e725440524f Mon Sep 17 00:00:00 2001 From: luoxiao Date: Thu, 22 Aug 2024 16:59:45 +0800 Subject: [PATCH] docs: Field docs --- thaw/src/checkbox/docs/mod.md | 13 ++++++++----- thaw/src/combobox/docs/mod.md | 3 +++ thaw/src/field/docs/mod.md | 16 ++++++++++++++++ thaw/src/radio/docs/mod.md | 15 +++++++++------ thaw/src/time_picker/docs/mod.md | 9 ++++++--- 5 files changed, 42 insertions(+), 14 deletions(-) diff --git a/thaw/src/checkbox/docs/mod.md b/thaw/src/checkbox/docs/mod.md index 1945f29..546a326 100644 --- a/thaw/src/checkbox/docs/mod.md +++ b/thaw/src/checkbox/docs/mod.md @@ -37,8 +37,11 @@ view! { ### CheckboxGroup Props -| Name | Type | Default | Description | -| -------- | ------------------------ | -------------------- | ------------------------------------- | -| class | `MaybeProp` | `Default::default()` | | -| value | `Model>` | `Default::default()` | Sets the value of the checkbox group. | -| children | `Children` | | | +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| class | `MaybeProp` | `Default::default()` | | +| id | `MaybeProp` | `Default::default()` | | +| name | `MaybeProp` | `Default::default()` | A string specifying a name for the input control. This name is submitted along with the control's value when the form data is submitted. | +| rules | `Vec` | `vec![]` | The rules to validate Field. | +| value | `Model>` | `Default::default()` | Sets the value of the checkbox group. | +| children | `Children` | | | diff --git a/thaw/src/combobox/docs/mod.md b/thaw/src/combobox/docs/mod.md index 81f814a..87e838f 100644 --- a/thaw/src/combobox/docs/mod.md +++ b/thaw/src/combobox/docs/mod.md @@ -80,6 +80,9 @@ view! { | Name | Type | Default | Desciption | | --- | --- | --- | --- | | class | `MaybeProp` | `Default::default()` | | +| id | `MaybeProp` | `Default::default()` | | +| name | `MaybeProp` | `Default::default()` | A string specifying a name for the input control. This name is submitted along with the control's value when the form data is submitted. | +| rules | `Vec` | `vec![]` | The rules to validate Field. | | value | `Model` | `Default::default()` | | | selected_options | `VecModel` | `Default::default()` | Selected option. | | disabled | `MaybeSignal` | `false` | Whether the input is disabled. | diff --git a/thaw/src/field/docs/mod.md b/thaw/src/field/docs/mod.md index 8341144..3029bdd 100644 --- a/thaw/src/field/docs/mod.md +++ b/thaw/src/field/docs/mod.md @@ -106,3 +106,19 @@ view! { } ``` + +### Field Props + +| Name | Type | Default | Desciption | +| --- | --- | --- | --- | +| class | `MaybeProp` | `Default::default()` | | +| label | `MaybeProp` | `Default::default()` | The label associated with the field. | +| name | `MaybeProp` | `Default::default()` | A string specifying a name for the input control. This name is submitted along with the control's value when the form data is submitted. | +| orientation | `MaybeSignal` | `FieldOrientation::Vertical` | The orientation of the label relative to the field component. | +| children | `Children` | | | + +### FieldContextProvider Props + +| Name | Type | Default | Desciption | +| -------- | ---------- | ------- | ---------- | +| children | `Children` | | | diff --git a/thaw/src/radio/docs/mod.md b/thaw/src/radio/docs/mod.md index bd2c153..bf61d8c 100644 --- a/thaw/src/radio/docs/mod.md +++ b/thaw/src/radio/docs/mod.md @@ -34,9 +34,12 @@ view! { ### RadioGroup Props -| Name | Type | Default | Description | -| -------- | --------------------- | -------------------- | -------------------------------------- | -| class | `MaybeProp` | `Default::default()` | | -| value | `OptionModel` | `Default::default()` | The selected Radio item in this group. | -| name | `MaybeProp` | `None` | The name of this radio group. | -| children | `Children` | | | +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| class | `MaybeProp` | `Default::default()` | | +| id | `MaybeProp` | `Default::default()` | | +| name | `MaybeProp` | `Default::default()` | A string specifying a name for the input control. This name is submitted along with the control's value when the form data is submitted. | +| rules | `Vec` | `vec![]` | The rules to validate Field. | +| value | `OptionModel` | `Default::default()` | The selected Radio item in this group. | +| name | `MaybeProp` | `None` | The name of this radio group. | +| children | `Children` | | | diff --git a/thaw/src/time_picker/docs/mod.md b/thaw/src/time_picker/docs/mod.md index 0cf19f9..ab9cc14 100644 --- a/thaw/src/time_picker/docs/mod.md +++ b/thaw/src/time_picker/docs/mod.md @@ -16,7 +16,10 @@ view! { ## TimePicker Props -| Name | Type | Default | Description | -| ----- | ------------------------ | -------------------- | ------------------------- | -| class | `MaybeProp` | `Default::default()` | | +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| class | `MaybeProp` | `Default::default()` | | +| id | `MaybeProp` | `Default::default()` | | +| name | `MaybeProp` | `Default::default()` | A string specifying a name for the input control. This name is submitted along with the control's value when the form data is submitted. | +| rules | `Vec` | `vec![]` | The rules to validate Field. | | value | `OptionModel` | `Default::default()` | Set the TimePicker value. |