thaw/demo_markdown/docs/checkbox/mod.md

51 lines
1.9 KiB
Markdown
Raw Normal View History

# Checkbox
```rust demo
2024-05-21 17:25:22 +08:00
let checked = RwSignal::new(false);
view! {
2024-05-23 16:05:06 +08:00
<Checkbox checked label="Click"/>
2024-01-29 17:31:20 +08:00
<Checkbox />
}
```
### Group
```rust demo
use std::collections::HashSet;
2024-05-21 17:25:22 +08:00
let value = RwSignal::new(HashSet::new());
view! {
<CheckboxGroup value>
2024-05-23 16:05:06 +08:00
<Checkbox label="apple" value="a"/>
<Checkbox label="b" value="b"/>
<Checkbox label="c" value="c"/>
</CheckboxGroup>
<div style="margin-top: 1rem">"value: " {move || format!("{:?}", value.get())}</div>
}
```
### Checkbox Props
2024-02-09 22:44:22 +08:00
| Name | Type | Default | Description |
| -------- | ----------------------------------- | -------------------- | ------------------------------------------- |
| class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the checkbox element. |
| value | `Model<bool>` | `false` | Whether the checkbox is being checked. |
| children | `Children` | | Checkbox's content. |
### CheckboxGroup Props
2024-02-09 22:44:22 +08:00
| Name | Type | Default | Description |
| -------- | ------------------------ | -------------------- | ------------------------------------- |
| value | `Model<HashSet<String>>` | `Default::default()` | Sets the value of the checkbox group. |
| children | `Children` | | CheckboxGroup's content. |
### CheckboxItem Props
2024-02-09 22:44:22 +08:00
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| 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. |
| label | `Option<String>` | `None` | Checkbox's label. |