Files
webawesome/docs/components/dropdown.md
Cory LaViska 8c01ef4c4f Update docs
2020-06-30 07:44:31 -04:00

114 lines
3.4 KiB
Markdown

# Dropdown
[component-header:sl-dropdown]
Dropdowns expose additional content that "drops down" in a panel.
Dropdowns consist of a trigger and a panel. Activating the trigger will open the panel and interacting outside of the panel will close it.
Dropdowns are designed to work well with [menus](/components/menu.md) to provide a list of options the user can select from. However, dropdowns can also be used in lower-level applications (e.g. [color picker](/components/color-picker.md) and [select](/components/select.md)). The API gives you complete control over showing, hiding, and positioning the panel.
```html preview
<sl-dropdown>
<sl-button slot="trigger" caret>Dropdown</sl-button>
<sl-menu>
<sl-menu-item>Dropdown Item 1</sl-menu-item>
<sl-menu-item>Dropdown Item 2</sl-menu-item>
<sl-menu-item>Dropdown Item 3</sl-menu-item>
<sl-menu-divider></sl-menu-divider>
<sl-menu-item checked>Checked</sl-menu-item>
<sl-menu-item disabled>Disabled</sl-menu-item>
<sl-menu-divider></sl-menu-divider>
<sl-menu-item>
Prefix
<sl-icon slot="prefix" name="gift"></sl-icon>
</sl-menu-item>
<sl-menu-item>
Suffix Icon
<sl-icon slot="suffix" name="heart"></sl-icon>
</sl-menu-item>
</sl-menu>
</sl-dropdown>
```
[component-metadata:sl-dropdown]
## Examples
### Placement
```html preview
<sl-dropdown placement="top-start">
<sl-button slot="trigger" caret>Edit</sl-button>
<sl-menu>
<sl-menu-item>Cut</sl-menu-item>
<sl-menu-item>Copy</sl-menu-item>
<sl-menu-item>Paste</sl-menu-item>
<sl-menu-divider></sl-menu-divider>
<sl-menu-item>Find</sl-menu-item>
<sl-menu-item>Replace</sl-menu-item>
</sl-menu>
</sl-dropdown>
```
### Distance
```html preview
<sl-dropdown distance="30">
<sl-button slot="trigger" caret>Edit</sl-button>
<sl-menu>
<sl-menu-item>Cut</sl-menu-item>
<sl-menu-item>Copy</sl-menu-item>
<sl-menu-item>Paste</sl-menu-item>
<sl-menu-divider></sl-menu-divider>
<sl-menu-item>Find</sl-menu-item>
<sl-menu-item>Replace</sl-menu-item>
</sl-menu>
</sl-dropdown>
```
### Skidding
```html preview
<sl-dropdown skidding="30">
<sl-button slot="trigger" caret>Edit</sl-button>
<sl-menu>
<sl-menu-item>Cut</sl-menu-item>
<sl-menu-item>Copy</sl-menu-item>
<sl-menu-item>Paste</sl-menu-item>
<sl-menu-divider></sl-menu-divider>
<sl-menu-item>Find</sl-menu-item>
<sl-menu-item>Replace</sl-menu-item>
</sl-menu>
</sl-dropdown>
```
### Scrolling Content
```html preview
<sl-dropdown>
<sl-button slot="trigger" caret>Scrolling Menu</sl-button>
<sl-menu>
<sl-menu-item>Item 1</sl-menu-item>
<sl-menu-item>Item 2</sl-menu-item>
<sl-menu-item>Item 3</sl-menu-item>
<sl-menu-item>Item 4</sl-menu-item>
<sl-menu-item>Item 5</sl-menu-item>
<sl-menu-item>Item 6</sl-menu-item>
<sl-menu-item>Item 7</sl-menu-item>
<sl-menu-item>Item 8</sl-menu-item>
<sl-menu-item>Item 9</sl-menu-item>
<sl-menu-item>Item 10</sl-menu-item>
<sl-menu-item>Item 11</sl-menu-item>
<sl-menu-item>Item 12</sl-menu-item>
<sl-menu-item>Item 13</sl-menu-item>
<sl-menu-item>Item 14</sl-menu-item>
<sl-menu-item>Item 15</sl-menu-item>
<sl-menu-item>Item 16</sl-menu-item>
<sl-menu-item>Item 17</sl-menu-item>
<sl-menu-item>Item 18</sl-menu-item>
<sl-menu-item>Item 19</sl-menu-item>
<sl-menu-item>Item 20</sl-menu-item>
</sl-menu>
</sl-dropdown>
```