shoelace/docs/components/divider.md

146 wiersze
3.2 KiB
Markdown
Czysty Zwykły widok Historia

2021-09-29 12:03:03 +00:00
# Divider
[component-header:sl-divider]
Dividers are used to visually separate or group elements.
```html preview
<sl-divider></sl-divider>
```
2021-11-04 22:12:47 +00:00
```jsx react
import { SlDivider } from '@shoelace-style/shoelace/dist/react';
2022-03-02 15:10:41 +00:00
const App = () => <SlDivider />;
2021-11-04 22:12:47 +00:00
```
2022-03-02 15:10:41 +00:00
2021-09-29 12:03:03 +00:00
## Examples
### Width
Use the `--width` custom property to change the width of the divider.
```html preview
<sl-divider style="--width: 4px;"></sl-divider>
```
2021-11-04 22:12:47 +00:00
```jsx react
import { SlDivider } from '@shoelace-style/shoelace/dist/react';
2022-03-02 15:10:41 +00:00
const App = () => <SlDivider style={{ '--width': '4px' }} />;
2021-11-04 22:12:47 +00:00
```
2021-09-29 12:03:03 +00:00
### Color
Use the `--color` custom property to change the color of the divider.
```html preview
<sl-divider style="--color: tomato;"></sl-divider>
```
2021-11-04 22:12:47 +00:00
```jsx react
import { SlDivider } from '@shoelace-style/shoelace/dist/react';
2022-03-02 15:10:41 +00:00
const App = () => <SlDivider style={{ '--color': 'tomato' }} />;
2021-11-04 22:12:47 +00:00
```
2021-09-29 12:03:03 +00:00
### Spacing
Use the `--spacing` custom property to change the amount of space between the divider and it's neighboring elements.
```html preview
<div style="text-align: center;">
Above
<sl-divider style="--spacing: 2rem;"></sl-divider>
Below
</div>
```
2021-11-04 22:12:47 +00:00
```jsx react
import { SlDivider } from '@shoelace-style/shoelace/dist/react';
const App = () => (
<>
Above
<SlDivider style={{ '--spacing': '2rem' }} />
Below
</>
);
```
2021-09-29 12:03:03 +00:00
### Vertical
Add the `vertical` attribute to draw the divider in a vertical orientation. The divider will span the full height of its container. Vertical dividers work especially well inside of a flex container.
```html preview
<div style="display: flex; align-items: center; height: 2rem;">
First
<sl-divider vertical></sl-divider>
Middle
<sl-divider vertical></sl-divider>
Last
</div>
```
2021-11-04 22:12:47 +00:00
```jsx react
import { SlDivider } from '@shoelace-style/shoelace/dist/react';
const App = () => (
2022-03-02 15:10:41 +00:00
<div
style={{
display: 'flex',
alignItems: 'center',
2021-11-04 22:12:47 +00:00
height: '2rem'
}}
>
First
<SlDivider vertical />
Middle
<SlDivider vertical />
Last
</div>
);
```
2021-09-29 12:03:03 +00:00
### Menu Dividers
Use dividers in [menus](/components/menu) to visually group menu items.
```html preview
2022-03-02 15:10:41 +00:00
<sl-menu
style="max-width: 200px; border: solid 1px var(--sl-panel-border-color); background: var(--sl-panel-background-color); border-radius: var(--sl-border-radius-medium);"
>
2021-09-29 12:03:03 +00:00
<sl-menu-item value="1">Option 1</sl-menu-item>
<sl-menu-item value="2">Option 2</sl-menu-item>
<sl-menu-item value="3">Option 3</sl-menu-item>
<sl-divider></sl-divider>
<sl-menu-item value="4">Option 4</sl-menu-item>
<sl-menu-item value="5">Option 5</sl-menu-item>
<sl-menu-item value="6">Option 6</sl-menu-item>
</sl-menu>
```
2021-11-04 22:12:47 +00:00
```jsx react
2022-03-02 15:10:41 +00:00
import { SlDivider, SlMenu, SlMenuItem } from '@shoelace-style/shoelace/dist/react';
2021-11-04 22:12:47 +00:00
const App = () => (
2022-03-02 15:10:41 +00:00
<SlMenu
2021-11-04 22:12:47 +00:00
style={{
maxWidth: '200px',
border: 'solid 1px var(--sl-panel-border-color)',
2021-11-04 22:12:47 +00:00
borderRadius: 'var(--sl-border-radius-medium)'
}}
>
<SlMenuItem value="1">Option 1</SlMenuItem>
<SlMenuItem value="2">Option 2</SlMenuItem>
<SlMenuItem value="3">Option 3</SlMenuItem>
<sl-divider />
<SlMenuItem value="4">Option 4</SlMenuItem>
<SlMenuItem value="5">Option 5</SlMenuItem>
<SlMenuItem value="6">Option 6</SlMenuItem>
</SlMenu>
);
```
2021-09-29 12:03:03 +00:00
[component-metadata:sl-divider]