thaw/demo_markdown/docs/collapse/mod.md
luoxiaozero adcc0b6a54
Feat/collapse (#73)
* feat: add collapse component

* feat: collapse adds accordion prop

* fix(workflow): ci stable-cargo-leptos
2024-01-09 14:32:13 +08:00

53 lines
2.1 KiB
Markdown

# Collapse
```rust demo
use std::collections::HashSet;
let value = create_rw_signal(HashSet::from(["thaw".to_string()]));
view! {
<Collapse value>
<CollapseItem title="Leptos" key="leptos">
"Build fast web applications with Rust."
</CollapseItem>
<CollapseItem title="Thaw" key="thaw">
"An easy to use leptos component library"
</CollapseItem>
</Collapse>
}
```
### Accordion
Like an accordion.
```rust demo
view! {
<Collapse accordion=true>
<CollapseItem title="Leptos" key="leptos">
"Build fast web applications with Rust."
</CollapseItem>
<CollapseItem title="Thaw" key="thaw">
"An easy to use leptos component library"
</CollapseItem>
</Collapse>
}
```
### Collapse Props
| Name | Type | Default | Description |
| --------- | --------------------------- | -------------------- | ------------------------------------------- |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the collapse element. |
| value | `RwSignal<HashSet<String>>` | `Default::default()` | Currently active panel. |
| accordion | `bool` | `false` | Only allow one panel open at a time. |
| children | `Children` | | Collapse's content. |
### CollapseItem Props
| Name | Type | Default | Description |
| ------- | --------------------- | -------------------- | ------------------------------------------------ |
| class | `MaybeSignal<String>` | `Default::default()` | Addtional classes for the collapse item element. |
| title | `MaybeSignal<String>` | | The title of the CollapseItem. |
| key | `MaybeSignal<String>` | | The indentifier of CollapseItem. |
| chilren | `Children` | | CollapseItem's content. |