adam/thaw
1
0
Fork 0
mirror of https://github.com/adoyle0/thaw.git synced 2025-02-02 08:34:15 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update (#99)

Browse source
This commit is contained in:
luoxiaozero 2024-02-09 22:44:22 +08:00
parent 5e2a385446
commit 396e654f0b
40 changed files with 225 additions and 219 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
demo_markdown/docs/_guide/installation.md
View file

@ -3,5 +3,5 @@
Installation thaw Installation thaw
```shell ```shell
cargo add thaw cargo add thaw --features=csr
``` ```

4
demo_markdown/docs/_guide/server_sider_rendering.md
View file

@ -3,11 +3,11 @@
To enable the ssr mode, the following configurations are required: To enable the ssr mode, the following configurations are required:
```toml ```toml
thaw = { ..., default-features = false, features = ["ssr"] } thaw = { ..., features = ["ssr"] }
``` ```
To enable the hydrate mode, the following configurations are required: To enable the hydrate mode, the following configurations are required:
```toml ```toml
thaw = { ..., default-features = false, features = ["hydrate"] } thaw = { ..., features = ["hydrate"] }
``` ```

14
demo_markdown/docs/_mobile/nav_bar/mod.md
View file

@ -17,7 +17,7 @@ view! {
on_click_right=on_click_right on_click_right=on_click_right
> >
<NavBarRight slot> <NavBarRight slot>
<Icon icon=icondata::AiCloseOutlined/> <Icon icon=icondata::AiCloseOutlined/>
</NavBarRight> </NavBarRight>
</NavBar> </NavBar>
<div style="padding-top: 50px">{move || click_text.get()}</div> <div style="padding-top: 50px">{move || click_text.get()}</div>
@ -29,16 +29,16 @@ view! {
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the NavBar element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the NavBar element. |
| title | `MaybeSignal<String>` | `Default::default()` | NavBar title. | | title | `MaybeSignal<String>` | `Default::default()` | NavBar title. |
| left_arrow | `MaybeSignal<bool>` | `false` | Whether to show left arrow. | | left_arrow | `MaybeSignal<bool>` | `false` | Whether to show left arrow. |
| left_text | `MaybeSignal<String>` | `Default::default()` | NavBar left text. | | left_text | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | NavBar left text. |
| on_click_left | `Option<Callback<ev::MouseEvent>>` | `Default::default()` | NavBar left click. | | on_click_left | `Option<Callback<ev::MouseEvent>>` | `Default::default()` | NavBar left click. |
| right_text | `MaybeSignal<String>` | `Default::default()` | NavBar right text. | | right_text | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | NavBar right text. |
| on_click_right | `Option<Callback<ev::MouseEvent>>` | `Default::default()` | NavBar right click. | | on_click_right | `Option<Callback<ev::MouseEvent>>` | `Default::default()` | NavBar right click. |
### NavBarLeft and NavBarRight Props ### NavBarLeft and NavBarRight Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | ----- | ----------------------------------- | -------------------- | ---------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the element. |

8
demo_markdown/docs/_mobile/tabbar/mod.md
View file

@ -21,10 +21,10 @@ view! {
### Tabbar Props ### Tabbar Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | ------------------ | -------------------- | ----------------- | | -------- | --------------- | -------------------- | ----------------- |
| value | `RwSignal<String>` | `Default::default()` | Tabbar's value. | | value | `Model<String>` | `Default::default()` | Tabbar's value. |
| children | `Children` | | Tabbar's content. | | children | `Children` | | Tabbar's content. |
### TabbarItem Props ### TabbarItem Props

12
demo_markdown/docs/alert/mod.md
View file

@ -18,9 +18,9 @@ view! {
### Alert Props ### Alert Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------------- | -------------------- | ----------------------------------------- | | -------- | ----------------------------------- | -------------------- | ----------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Additional classes for the alert element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Additional classes for the alert element. |
| title | `MaybeSignal<String>` | `Default::default()` | Title of the alert. | | title | `Option<MaybeSignal<String>>` | `Default::default()` | Title of the alert. |
| variant | `MaybeSignal<AlertVariant>` | | Alert variant. | | variant | `MaybeSignal<AlertVariant>` | | Alert variant. |
| children | `Children` | | The content of the alert. | | children | `Children` | | The content of the alert. |

6
demo_markdown/docs/auto_complete/mod.md
View file

@ -60,9 +60,9 @@ view! {
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Additional classes for the autocomplete element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Additional classes for the autocomplete element. |
| value | `RwSignal<String>` | `Default::default()` | Input of autocomplete. | | value | `Model<String>` | `Default::default()` | Input of autocomplete. |
| placeholder | `RwSignal<String>` | `Default::default()` | Autocomplete's placeholder. | | placeholder | `OptionalProp<RwSignal<String>>` | `Default::default()` | Autocomplete's placeholder. |
| options | `MaybeSignal<Vec<AutoCompleteOption>>` | `Default::default()` | Options to autocomplete from. | | options | `MaybeSignal<Vec<AutoCompleteOption>>` | `Default::default()` | Options to autocomplete from. |
| disabled | `MaybeSignal<bool>` | `false` | Whether the input is disabled. | | disabled | `MaybeSignal<bool>` | `false` | Whether the input is disabled. |
| invalid | `MaybeSignal<bool>` | `false` | Whether the input is invalid. | | invalid | `MaybeSignal<bool>` | `false` | Whether the input is invalid. |

12
demo_markdown/docs/avatar/mod.md
View file

@ -12,9 +12,9 @@ view! {
### Avatar Props ### Avatar Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ----- | --------------------- | -------------------- | ----------------------------------------- | | ----- | ----------------------------------- | -------------------- | ----------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the avatar element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the avatar element. |
| src | `MaybeSignal<String>` | `Default::default()` | Avatar's image source. | | src | `Option<MaybeSignal<String>>` | `Default::default()` | Avatar's image source. |
| round | `MaybeSignal<bool>` | `false` | Whether to display a rounded avatar. | | round | `MaybeSignal<bool>` | `false` | Whether to display a rounded avatar. |
| size | `MaybeSignal<u16>` | `30` | Avatar's size. | | size | `MaybeSignal<u16>` | `30` | Avatar's size. |

2
demo_markdown/docs/badge/mod.md
View file

@ -36,7 +36,7 @@ view! {
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the badge element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the badge element. |
| value | `MaybeSignal<u32>` | `0` | Badge's value. | | value | `MaybeSignal<u32>` | `0` | Badge's value. |
| max | `MaybeSignal<u32>` | `u32::MAX` | The maximum number of the badge when its value overflows. | | max | `MaybeSignal<u32>` | `u32::MAX` | The maximum number of the badge when its value overflows. |
| variant | `MaybeSignal<BadgeVariant>` | `BadgeVariant::Error` | Badge variant. | | variant | `MaybeSignal<BadgeVariant>` | `BadgeVariant::Error` | Badge variant. |

18
demo_markdown/docs/breadcrumb/mod.md
View file

@ -24,15 +24,15 @@ view! {
### Breadcrumb Props ### Breadcrumb Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --------- | --------------------- | -------------------- | --------------------------------------------- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the breadcrumb element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the breadcrumb element. |
| separator | `MaybeSignal<String>` | `/` | Breadcrumb separator. | | separator | `MaybeSignal<String>` | `/` | Breadcrumb separator. |
| children | `Children` | | Breadcrumb's content. | | children | `Children` | | Breadcrumb's content. |
### BreadcrumbItem Props ### BreadcrumbItem Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------- | -------------------- | -------------------------------------------------- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the breadcrumb link element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the breadcrumb link element. |
| children | `Children` | | BreadcrumbItem's content. | | children | `Children` | | BreadcrumbItem's content. |

13
demo_markdown/docs/button/mod.md
View file

@ -129,8 +129,8 @@ view! {
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Additional classes for the button element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Additional classes for the button element. |
| style | `MaybeSignal<String>` | `Default::default()` | Button's style. | | style | `Option<MaybeSignal<String>>` | `Default::default()` | Button's style. |
| variant | `MaybeSignal<ButtonVariant>` | `ButtonVariant::Primary` | Button's variant. | | variant | `MaybeSignal<ButtonVariant>` | `ButtonVariant::Primary` | Button's variant. |
| color | `MaybeSignal<ButtonColor>` | `ButtonColor::Primary` | Button's color. | | color | `MaybeSignal<ButtonColor>` | `ButtonColor::Primary` | Button's color. |
| round | `MaybeSignal<bool>` | `false` | Whether the button shows rounded corners. | | round | `MaybeSignal<bool>` | `false` | Whether the button shows rounded corners. |
@ -140,4 +140,11 @@ view! {
| disabled | `MaybeSignal<bool>` | `false` | Whether the button is disabled. | | disabled | `MaybeSignal<bool>` | `false` | Whether the button is disabled. |
| size | `MaybeSignal<ButtonSize>` | `ButtonSize::Medium` | Button size. | | size | `MaybeSignal<ButtonSize>` | `ButtonSize::Medium` | Button size. |
| on_click | `Option<Callback<ev::MouseEvent>>` | `None` | Listen for button click events. | | on_click | `Option<Callback<ev::MouseEvent>>` | `None` | Listen for button click events. |
| children | `Children` | | Button's content. | | children | `Option<Children>` | | Button's content. |
### ButtonGroup props
| Name | Type | Default | Description |
| -------- | ---------- | ------- | ----------------------------------- |
| vertical | `bool` | `false` | Directions of buttons in the group. |
| children | `Children` | | ButtonGroup's content. |

8
demo_markdown/docs/calendar/mod.md
View file

@ -11,7 +11,7 @@ view! {
### Calendar Props ### Calendar Props
| Name | Type | Default | Desciption | | Name | Type | Default | Desciption |
| ----- | ----------------------------- | -------------------- | ------------------------------------------- | | ----- | ----------------------------------- | -------------------- | ------------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the calendar element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the calendar element. |
| value | `RwSignal<Option<NaiveDate>>` | `Default::default()` | Set the calendar value | | value | `Model<Option<NaiveDate>>` | `Default::default()` | Set the calendar value |

10
demo_markdown/docs/card/mod.md
View file

@ -23,11 +23,11 @@ view! {
### Card Props ### Card Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------- | -------------------- | --------------------------------------- | | -------- | ----------------------------------- | -------------------- | --------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the card element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the card element. |
| title | `MaybeSignal<String>` | `Default::default()` | Card title. | | title | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Card title. |
| children | `Children` | | Card's content. | | children | `Children` | | Card's content. |
### Card Slots ### Card Slots

28
demo_markdown/docs/checkbox/mod.md
View file

@ -28,23 +28,23 @@ view! {
### Checkbox Props ### Checkbox Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------- | -------------------- | ------------------------------------------- | | -------- | ----------------------------------- | -------------------- | ------------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the checkbox element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the checkbox element. |
| value | `RwSignal<bool>` | `false` | Whether the checkbox is being checked. | | value | `Model<bool>` | `false` | Whether the checkbox is being checked. |
| children | `Children` | | Checkbox's content. | | children | `Children` | | Checkbox's content. |
### CheckboxGroup Props ### CheckboxGroup Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------------- | -------------------- | ------------------------------------- | | -------- | ------------------------ | -------------------- | ------------------------------------- |
| value | `RwSignal<HashSet<String>>` | `Default::default()` | Sets the value of the checkbox group. | | value | `Model<HashSet<String>>` | `Default::default()` | Sets the value of the checkbox group. |
| children | `Children` | | CheckboxGroup's content. | | children | `Children` | | CheckboxGroup's content. |
### CheckboxItem Props ### CheckboxItem Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ----- | --------------------- | -------------------- | ------------------------------------------------------- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the checkbox element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the checkbox element. |
| key | `String` | | The key of the checkbox to be used in a checkbox group. | | key | `String` | | The key of the checkbox to be used in a checkbox group. |
| label | `Option<String>` | `None` | Checkbox's label. | | label | `Option<String>` | `None` | Checkbox's label. |

24
demo_markdown/docs/collapse/mod.md
View file

@ -39,18 +39,18 @@ view! {
### Collapse Props ### Collapse Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --------- | --------------------------- | -------------------- | ------------------------------------------- | | --------- | ----------------------------------- | -------------------- | ------------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the collapse element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the collapse element. |
| value | `RwSignal<HashSet<String>>` | `Default::default()` | Currently active panel. | | value | `Model<HashSet<String>>` | `Default::default()` | Currently active panel. |
| accordion | `bool` | `false` | Only allow one panel open at a time. | | accordion | `bool` | `false` | Only allow one panel open at a time. |
| children | `Children` | | Collapse's content. | | children | `Children` | | Collapse's content. |
### CollapseItem Props ### CollapseItem Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ------- | --------------------- | -------------------- | ------------------------------------------------ | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the collapse item element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the collapse item element. |
| title | `MaybeSignal<String>` | | The title of the CollapseItem. | | title | `MaybeSignal<String>` | | The title of the CollapseItem. |
| key | `MaybeSignal<String>` | | The indentifier of CollapseItem. | | key | `MaybeSignal<String>` | | The indentifier of CollapseItem. |
| chilren | `Children` | | CollapseItem's content. | | chilren | `Children` | | CollapseItem's content. |

2
demo_markdown/docs/color_picker/mod.md
View file

@ -30,7 +30,7 @@ view! {
} }
``` ```
### DatePicker Props ### ColorPicker Props
| Name | Type | Default | Desciption | | Name | Type | Default | Desciption |
| ----- | ----------------------------------- | -------------------- | ----------------------------------------------- | | ----- | ----------------------------------- | -------------------- | ----------------------------------------------- |

4
demo_markdown/docs/date_picker/mod.md
View file

@ -13,6 +13,6 @@ view! {
| Name | Type | Default | Desciption | | Name | Type | Default | Desciption |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the date picker element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the date picker element. |
| value | `RwSignal<Option<NaiveDate>>` | `Default::default()` | Set the date picker value | | value | `Model<Option<NaiveDate>>` | `Default::default()` | Set the date picker value |
| attr: | `Vec<(&'static str, Attribute)>` | `Default::default()` | The dom attrs of the input element inside the component. | | attr: | `Vec<(&'static str, Attribute)>` | `Default::default()` | The dom attrs of the input element inside the component. |

6
demo_markdown/docs/divider/mod.md
View file

@ -10,6 +10,6 @@ view! {
### Divider Props ### Divider Props
| Name | Type | Default | Desciption | | Name | Type | Default | Desciption |
| ----- | --------------------- | -------------------- | ------------------------------------------ | | ----- | ----------------------------------- | -------------------- | ------------------------------------------ |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the divider element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the divider element. |

22
demo_markdown/docs/drawer/mod.md
View file

@ -39,14 +39,14 @@ view! {
### Drawer Props ### Drawer Props
| Name | Type | Default | Desciption | | Name | Type | Default | Desciption |
| --------- | ------------------------------ | ------------------------ | ----------------------------------------- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the drawer element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the drawer element. |
| show | `MaybeSignal<bool>` | | Whether to show drawer. | | show | `Model<bool>` | | Whether to show drawer. |
| title | `MaybeSignal<String>` | `Default::default()` | Drawer title. | | title | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Drawer title. |
| placement | `MaybeSignal<DrawerPlacement>` | `DrawerPlacement::Right` | Drawer placement. | | placement | `MaybeSignal<DrawerPlacement>` | `DrawerPlacement::Right` | Drawer placement. |
| width | `MaybeSignal<String>` | `520px` | Drawer width. | | width | `MaybeSignal<String>` | `520px` | Drawer width. |
| height | `MaybeSignal<String>` | `260px` | Drawer height. | | height | `MaybeSignal<String>` | `260px` | Drawer height. |
| z_index | `MaybeSignal<i16>` | `2000` | z-index of the drawer. | | z_index | `MaybeSignal<i16>` | `2000` | z-index of the drawer. |
| mount | `DrawerMount` | `DrawerMount::Body` | Container node of the drawer. | | mount | `DrawerMount` | `DrawerMount::Body` | Container node of the drawer. |
| children | `Children` | | Drawer content. | | children | `Children` | | Drawer content. |

22
demo_markdown/docs/grid/mod.md
View file

@ -95,17 +95,17 @@ view! {
### Grid Props ### Grid Props
| Name | Type | Default | Desciption | | Name | Type | Default | Desciption |
| ----- | --------------------- | -------------------- | --------------------------------------- | | ----- | ----------------------------------- | -------------------- | --------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the grid element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the grid element. |
| cols | `MaybeSignal<u16>` | `1` | Number of grids displayed. | | cols | `MaybeSignal<u16>` | `1` | Number of grids displayed. |
| x_gap | `MaybeSignal<u16>` | `0` | Horizontal gap. | | x_gap | `MaybeSignal<u16>` | `0` | Horizontal gap. |
| y_gap | `MaybeSignal<u16>` | `0` | Vertical gap. | | y_gap | `MaybeSignal<u16>` | `0` | Vertical gap. |
### GridItem Props ### GridItem Props
| Name | Type | Default | Desciption | | Name | Type | Default | Desciption |
| ------ | --------------------- | -------------------- | --------------------------------------------- | | ------ | ----------------------------------- | -------------------- | --------------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the grid item element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the grid item element. |
| column | `MaybeSignal<u16>` | `1` | Number of columns this grid item will occupy. | | column | `MaybeSignal<u16>` | `1` | Number of columns this grid item will occupy. |
| offset | `MaybeSignal<u16>` | `0` | Horizontal offset. | | offset | `MaybeSignal<u16>` | `0` | Horizontal offset. |

18
demo_markdown/docs/image/mod.md
View file

@ -9,12 +9,12 @@ view! {
### Image Props ### Image Props
| Name | Type | Default | Desciption | | Name | Type | Default | Desciption |
| ------------- | --------------------- | -------------------- | ---------------------------------------------- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the image element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the image element. |
| src | `MaybeSignal<String>` | `Default::default()` | Image source. | | src | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Image source. |
| alt | `MaybeSignal<String>` | `Default::default()` | Image alt information. | | alt | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Image alt information. |
| width | `MaybeSignal<String>` | `Default::default()` | Image width. | | width | `MaybeSignal<String>` | `Default::default()` | Image width. |
| height | `MaybeSignal<String>` | `Default::default()` | Image height. | | height | `MaybeSignal<String>` | `Default::default()` | Image height. |
| border_radius | `MaybeSignal<String>` | `Default::default()` | Image border radius. | | border_radius | `MaybeSignal<String>` | `Default::default()` | Image border radius. |
| object_fit | `MaybeSignal<String>` | `Default::default()` | Object-fit type of the image in the container. | | object_fit | `MaybeSignal<String>` | `Default::default()` | Object-fit type of the image in the container. |

6
demo_markdown/docs/input/mod.md
View file

@ -98,10 +98,10 @@ view! {
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the input element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the input element. |
| value | `RwSignal<String>` | `Default::default()` | Set the input value. | | value | `Model<String>` | `Default::default()` | Set the input value. |
| variant | `MaybeSignal<InputVariant>` | `InputVariant::Text` | Input's variant. | | variant | `MaybeSignal<InputVariant>` | `InputVariant::Text` | Input's variant. |
| placeholder | `MaybeSignal<String>` | `Default::default()` | Placeholder of input. | | placeholder | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Placeholder of input. |
| disabled | `MaybeSignal<bool>` | `false` | Whether the input is disabled. | | disabled | `MaybeSignal<bool>` | `false` | Whether the input is disabled. |
| invalid | `MaybeSignal<bool>` | `false` | Whether the input is invalid. | | invalid | `MaybeSignal<bool>` | `false` | Whether the input is invalid. |
| allow_value | `Option<Callback<String, bool>>` | `None` | Check the incoming value, if it returns false, input will not be accepted. | | allow_value | `Option<Callback<String, bool>>` | `None` | Check the incoming value, if it returns false, input will not be accepted. |

8
demo_markdown/docs/input_number/mod.md
View file

@ -36,9 +36,9 @@ view! {
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the input element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the input element. |
| value | `RwSignal<T>` | `T::default()` | Set the input value. | | value | `Model<T>` | `T::default()` | Set the input value. |
| placeholder | `MaybeSignal<String>` | `Default::default()` | Placeholder of input number. | | placeholder | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Placeholder of input number. |
| step | `MaybeSignal<T>` | | The number which the current value is increased or decreased on key or button press. | | step | `MaybeSignal<T>` | | The number which the current value is increased or decreased on key or button press. |
| disabled | `MaybeSignal<bool>` | `false` | Whether the input is disabled. | | disabled | `MaybeSignal<bool>` | `false` | Whether the input is disabled. |
| invalid | `MaybeSignal<bool>` | `false` | Whether the input is invalid. | | invalid | `MaybeSignal<bool>` | `false` | Whether the input is invalid. |
@ -53,4 +53,4 @@ view! {
| Name | Type | Description | | Name | Type | Description |
| ----- | ----------- | ------------------------ | | ----- | ----------- | ------------------------ |
| focus | `Fn(&self)` | Focus the input element. | | focus | `Fn(&self)` | Focus the input element. |
| blur | `Fn(&self)` | Blur the input element. | | blur | `Fn(&self)` | Blur the input element. |

15
demo_markdown/docs/layout/mod.md
View file

@ -35,15 +35,16 @@ view! {
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the layout element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the layout element. |
| style | `MaybeSignal<String>` | `Default::default()` | Layout's style. | | style | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Layout's style. |
| position | `LayoutPosition` | `LayoutPosition::Static` | static position will make it css position set to static. absolute position will make it css position set to absolute and left, right, top, bottom to 0. absolute position is very useful when you want to make content scroll in a fixed container or make the whole page's layout in a fixed position. You may need to change the style of the component to make it display as you expect. | | position | `LayoutPosition` | `LayoutPosition::Static` | static position will make it css position set to static. absolute position will make it css position set to absolute and left, right, top, bottom to 0. absolute position is very useful when you want to make content scroll in a fixed container or make the whole page's layout in a fixed position. You may need to change the style of the component to make it display as you expect. |
| has_sider | `MaybeSignal<bool>` | `false` | Whether the component has sider inside. If so it must be true. |
| children | `Children` | | Layout's content. | | children | `Children` | | Layout's content. |
### LayoutHeader, LayoutSider Props ### LayoutHeader, LayoutSider Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------- | -------------------- | ------------------------------------------------ | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the layout header element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the layout header element. |
| style | `MaybeSignal<String>` | `Default::default()` | LayoutHeader's style. | | style | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | LayoutHeader's style. |
| children | `Children` | | LayoutHeader's content. | | children | `Children` | | LayoutHeader's content. |

30
demo_markdown/docs/menu/mod.md
View file

@ -13,24 +13,24 @@ view! {
### Menu Props ### Menu Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------- | -------------------- | --------------------------------------- | | -------- | ----------------------------------- | -------------------- | --------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the menu element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the menu element. |
| value | `MaybeSignal<String>` | `Default::default()` | The selected item key of the menu. | | value | `Model<String>` | `Default::default()` | The selected item key of the menu. |
| children | `Children` | | Menu's content. | | children | `Children` | | Menu's content. |
### MenuGroup Props ### MenuGroup Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------- | -------------------- | --------------------------------------------- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the menu group element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the menu group element. |
| label | `String` | | The label of the menu group. | | label | `String` | | The label of the menu group. |
| children | `Children` | | MenuGroup's content. | | children | `Children` | | MenuGroup's content. |
### MenuItem Props ### MenuItem Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ----- | --------------------- | -------------------- | -------------------------------------------- | | ----- | ----------------------------------- | -------------------- | -------------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the menu item element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the menu item element. |
| label | `MaybeSignal<String>` | `Default::default()` | The label of the menu item. | | label | `MaybeSignal<String>` | `Default::default()` | The label of the menu item. |
| key | `MaybeSignal<String>` | `Default::default()` | The indentifier of the menu item. | | key | `MaybeSignal<String>` | `Default::default()` | The indentifier of the menu item. |

14
demo_markdown/docs/message/mod.md
View file

@ -35,9 +35,9 @@ view! {
### MessageProvider Props ### MessageProvider Props
| Name | Type | Default | Desciption | | Name | Type | Default | Desciption |
| --------- | ----------------------------- | ----------------------- | ------------------------------- | | --------- | ------------------ | ----------------------- | ------------------------------- |
| placement | `MessagePlacement` | `MessagePlacement::Top` | Position to place the messages. | | placement | `MessagePlacement` | `MessagePlacement::Top` | Position to place the messages. |
### MessageProvider Injection Methods ### MessageProvider Injection Methods
@ -47,7 +47,7 @@ view! {
### MessageOptions fields ### MessageOptions fields
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | ----------------- | ------------------------- | --------------------------------------------------------------- | | --- | --- | --- | --- |
| duration | `Duration` | `Duration::from_secs(3)` | How long the message will be displayed. 0 for permanent message | | duration | `Duration` | `std::time::Duration::from_secs(3)` | How long the message will be displayed. 0 for permanent message |
| closable | `bool` | `false` | Can the message be manually closed. | | closable | `bool` | `false` | Can the message be manually closed. |

2
demo_markdown/docs/modal/mod.md
View file

@ -15,7 +15,7 @@ view! {
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------- | -------------------- | ---------------------- | | -------- | --------------------- | -------------------- | ---------------------- |
| show | `MaybeSignal<bool>` | | Whether to show modal. | | show | `Model<bool>` | | Whether to show modal. |
| title | `MaybeSignal<String>` | `Default::default()` | Modal title. | | title | `MaybeSignal<String>` | `Default::default()` | Modal title. |
| children | `Children` | | Modal's content. | | children | `Children` | | Modal's content. |

10
demo_markdown/docs/popover/mod.md
View file

@ -131,11 +131,11 @@ view! {
### Popover Props ### Popover Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --------- | --------------------- | ----------------------- | ----------------------------- | | --------- | ----------------------------------- | ----------------------- | ----------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Content class of the popover. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Content class of the popover. |
| placement | `PopoverPlacement` | `PopoverPlacement::Top` | Popover placement. | | placement | `PopoverPlacement` | `PopoverPlacement::Top` | Popover placement. |
| children | `Children` | | The content inside popover. | | children | `Children` | | The content inside popover. |
### Popover Slots ### Popover Slots

10
demo_markdown/docs/radio/mod.md
View file

@ -10,8 +10,8 @@ view! {
### Radio Props ### Radio Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------- | -------------------- | ---------------------------------------- | | -------- | ----------------------------------- | -------------------- | ---------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the radio element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the radio element. |
| value | `RwSignal<bool>` | `false` | Checked value. | | value | `Model<bool>` | `false` | Checked value. |
| children | `Children` | | Radio's content. | | children | `Children` | | Radio's content. |

4
demo_markdown/docs/select/mod.md
View file

@ -23,6 +23,6 @@ view! {
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ------- | ----------------------------------- | -------------------- | ----------------------------------------- | | ------- | ----------------------------------- | -------------------- | ----------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the select element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the select element. |
| value | `RwSignal<Option<T>>` | `None` | Checked value. | | value | `Model<Option<T>>` | `None` | Checked value. |
| options | `MaybeSignal<Vec<SelectOption<T>>>` | `vec![]` | Options that can be selected. | | options | `MaybeSignal<Vec<SelectOption<T>>>` | `vec![]` | Options that can be selected. |

14
demo_markdown/docs/slider/mod.md
View file

@ -40,13 +40,13 @@ view! {
### Slider Props ### Slider Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------- | -------------------- | ----------------------------------------- | | -------- | ----------------------------------- | -------------------- | ----------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the slider element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the slider element. |
| value | `MaybeSignal<f64>` | `Default::default()` | Value of the slider. | | value | `MaybeSignal<f64>` | `Default::default()` | Value of the slider. |
| max | `MaybeSignal<f64>` | `100` | Max value of the slider. | | max | `MaybeSignal<f64>` | `100` | Max value of the slider. |
| step | `MaybeSignal<f64>` | `Default::default()` | The step in which value is incremented. | | step | `MaybeSignal<f64>` | `Default::default()` | The step in which value is incremented. |
| children | `Option<Children>` | `None` | Slider's content. | | children | `Option<Children>` | `None` | Slider's content. |
### SliderLabel props ### SliderLabel props

12
demo_markdown/docs/space/mod.md
View file

@ -41,9 +41,9 @@ view! {
### Space Props ### Space Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------- | -------------------- | ---------------------------------------- | | -------- | ----------------------------------- | -------------------- | ---------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the space element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the space element. |
| vertical | `bool` | `false` | Whether to lay out vertically. | | vertical | `bool` | `false` | Whether to lay out vertically. |
| gap | `SpaceGap` | `SpaceGap::Medium` | Space's gap. | | gap | `SpaceGap` | `SpaceGap::Medium` | Space's gap. |
| children | `Children` | | Space's content. | | children | `Children` | | Space's content. |

8
demo_markdown/docs/spinner/mod.md
View file

@ -21,7 +21,7 @@ view! {
### Spinner Props ### Spinner Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ----- | -------------------------- | --------------------- | ------------------------------------------- | | ----- | ----------------------------------- | --------------------- | ------------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Additional classes for the spinner element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Additional classes for the spinner element. |
| size | `MaybeSignal<SpinnerSize>` | `SpinnerSize::Medium` | Spinner size. | | size | `MaybeSignal<SpinnerSize>` | `SpinnerSize::Medium` | Spinner size. |

8
demo_markdown/docs/switch/mod.md
View file

@ -10,7 +10,7 @@ view! {
### Switch Props ### Switch Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ----- | --------------------- | -------------------- | ----------------------------------------- | | ----- | ----------------------------------- | -------------------- | ----------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the switch element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the switch element. |
| value | `RwSignal<bool>` | `Default::default()` | Switch's value. | | value | `Model<bool>` | `false` | Switch's value. |

14
demo_markdown/docs/table/mod.md
View file

@ -28,10 +28,10 @@ view! {
### Table Props ### Table Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ------------- | --------------------- | -------------------- | ------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the table element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the table element. |
| style | `MaybeSignal<String>` | `Default::default()` | Table's style. | | style | `MaybeSignal<String>` | `Default::default()` | Table's style. |
| single_row | `RwSignal<bool>` | `true` | Whether columns are not divided. If the prop is true, table cell has no border-right. | | single_row | `MaybeSignal<bool>` | `true` | Whether columns are not divided. If the prop is true, table cell has no border-right. |
| single_column | `RwSignal<bool>` | `false` | Whether rows are not divided. If the prop is true, table cell has no border-bottom. | | single_column | `MaybeSignal<bool>` | `false` | Whether rows are not divided. If the prop is true, table cell has no border-bottom. |
| children | `Children` | | Table's content. | | children | `Children` | | Table's content. |

22
demo_markdown/docs/tabs/mod.md
View file

@ -44,20 +44,20 @@ view! {
### Tabs Props ### Tabs Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------- | --------------------- | --------------------------------------- | | -------- | ----------------------------------- | -------------------- | --------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the tabs element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the tabs element. |
| value | `RwSignal<String>` | `TagVariant::Default` | Tabs value. | | value | `Model<String>` | `Default::default()` | Tabs value. |
| children | `Children` | | Tabs content. | | children | `Children` | | Tabs content. |
### Tab Props ### Tab Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------- | -------------------- | -------------------------------------- | | -------- | ----------------------------------- | -------------------- | -------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the tab element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the tab element. |
| key | `String` | | The indentifier of the tab. | | key | `String` | | The indentifier of the tab. |
| label | `String` | `Default::default()` | The label of the tab. | | label | `String` | `Default::default()` | The label of the tab. |
| children | `Children` | | Tabs content. | | children | `Children` | | Tabs content. |
### Tab Slots ### Tab Slots

10
demo_markdown/docs/tag/mod.md
View file

@ -13,8 +13,8 @@ view! {
### Tag Props ### Tag Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | ------------------------- | --------------------- | -------------------------------------- | | -------- | ----------------------------------- | --------------------- | -------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the tag element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the tag element. |
| variant | `MaybeSignal<TagVariant>` | `TagVariant::Default` | Tag's variant. | | variant | `MaybeSignal<TagVariant>` | `TagVariant::Default` | Tag's variant. |
| children | `Children` | | Tag's content. | | children | `Children` | | Tag's content. |

8
demo_markdown/docs/time_picker/mod.md
View file

@ -12,8 +12,8 @@ view! {
## TimePicker Props ## TimePicker Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ----- | -------------------------------- | -------------------- | -------------------------------------------------------- | | --- | --- | --- | --- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the time picker element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the time picker element. |
| value | `RwSignal<Option<NaiveTime>>` | `Default::default()` | Set the TimePicker value. | | value | `Model<Option<NaiveTime>>` | `Default::default()` | Set the TimePicker value. |
| attr: | `Vec<(&'static str, Attribute)>` | `Default::default()` | The dom attrs of the input element inside the component. | | attr: | `Vec<(&'static str, Attribute)>` | `Default::default()` | The dom attrs of the input element inside the component. |

10
demo_markdown/docs/typography/mod.md
View file

@ -11,8 +11,8 @@ view! {
## Text Props ## Text Props
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------- | --------------------- | -------------------- | --------------------------------------- | | -------- | ----------------------------------- | -------------------- | --------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the text element. | | class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the text element. |
| code | `bool` | `false` | Use the code tag and style. | | code | `bool` | `false` | Use the code tag and style. |
| children | `Children` | | Text's content. | | children | `Children` | | Text's content. |

1
thaw/src/message/message_provider.rs
View file

@ -1,5 +1,4 @@
use std::time::Duration; use std::time::Duration;
use super::{message_environment::MessageEnvironment, MessageVariant}; use super::{message_environment::MessageEnvironment, MessageVariant};
use crate::{ use crate::{
components::Teleport, components::Teleport,

3
thaw/src/slider/slider_label.rs
View file

@ -1,6 +1,5 @@
use leptos::*;
use crate::utils::mount_style; use crate::utils::mount_style;
use leptos::*;
#[component] #[component]
pub fn SliderLabel(#[prop(into)] value: MaybeSignal<f64>, children: Children) -> impl IntoView { pub fn SliderLabel(#[prop(into)] value: MaybeSignal<f64>, children: Children) -> impl IntoView {