thaw/demo_markdown/docs/layout/mod.md
2024-07-10 16:37:38 +08:00

52 lines
2.2 KiB
Markdown

# Layout
```rust demo
view! {
<Layout>
<LayoutHeader attr:style="background-color: #0078ffaa; padding: 20px;">
"Header"
</LayoutHeader>
<Layout attr:style="background-color: #0078ff88; padding: 20px;">"Content"</Layout>
</Layout>
}
```
### Sider
```rust demo
view! {
<Layout has_sider=true>
<LayoutSider attr:style="background-color: #0078ff99; padding: 20px;">
"Sider"
</LayoutSider>
<Layout>
<LayoutHeader attr:style="background-color: #0078ffaa; padding: 20px;">
"Header"
</LayoutHeader>
<Layout attr:style="background-color: #0078ff88; padding: 20px;">
"Content"
</Layout>
</Layout>
</Layout>
}
```
### Layout Props
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Class of scrollable content node. |
| style | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Layout's style. |
| content_class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the layout element. |
| content_style | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Style of scrollable content node. |
| 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. |
### LayoutHeader, LayoutSider Props
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| class | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | Addtional classes for the layout header element. |
| style | `OptionalProp<MaybeSignal<String>>` | `Default::default()` | LayoutHeader's style. |
| children | `Children` | | LayoutHeader's content. |