Skip to content

Fix: dropdown.md documentation (close inside example, slots) #333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 7, 2025
Merged

Fix: dropdown.md documentation (close inside example, slots) #333

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0adf0d
Fix: dropdown.md documentation (close inside example, slots)
tho-dan Nov 26, 2024
948b319
chore: fix code style
tho-dan Dec 9, 2024
50b2ccf
Merge branch 'main' into 332-fix-dropdown-documentation
Sqrcz Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions docs/components/dropdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import FwbDropdownExamplePlacement from './dropdown/examples/FwbDropdownExampleP
import FwbDropdownExampleAlignment from './dropdown/examples/FwbDropdownExampleAlignment.vue'
import FwbDropdownExampleListGroup from './dropdown/examples/FwbDropdownExampleListGroup.vue'
import FwbDropdownExampleTrigger from './dropdown/examples/FwbDropdownExampleTrigger.vue'
import FwbDropdownExampleCloseInside from './dropdown/examples/FwbDropdownExampleCloseInside.vue'
</script>

# Vue Dropdown - Flowbite
Expand Down Expand Up @@ -232,7 +233,7 @@ import { FwbDropdown, FwbListGroup, FwbListGroupItem } from 'flowbite-vue'

## Dropdown - close inside

<fwb-dropdown-example-trigger />
<fwb-dropdown-example-close-inside />
```vue
<template>
<fwb-dropdown text="Bottom" close-inside>
Expand Down Expand Up @@ -261,13 +262,13 @@ import { FwbDropdown, ListGroup, ListGroupItem } from 'flowbite-vue'
## API

### Props
| Name | Values | Default |
|----------|--------|---------|
| placement | `DropdownPlacement` | `'bottom'` |
| text | `string` | `''` |
| transition | `string` | `''` |
| closeInside | `boolean` | `false` |
| alignToEnd | `boolean` | `false` |
| Name | Values | Default |
|-------------|---------------------|-------------|
| placement | `DropdownPlacement` | `'bottom'` |
| text | `string` | `''` |
| transition | `string` | `''` |
| closeInside | `boolean` | `false` |
| alignToEnd | `boolean` | `false` |

### Events
| Name | Description |
Expand All @@ -276,7 +277,7 @@ import { FwbDropdown, ListGroup, ListGroupItem } from 'flowbite-vue'
| hide | the dropdown is closed |

### Slots
| Name | Description |
|------------|-------------------|
| default | dropdown content |
| suffix | button suffix |
| Name | Description |
|---------|--------------------------------------------|
| default | dropdown content |
| trigger | replace button with custom trigger element |
13 changes: 8 additions & 5 deletions docs/components/dropdown/examples/FwbDropdownExampleCloseInside.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
<template>
<div class="vp-raw">
<fwb-dropdown>
<fwb-dropdown
close-inside
text="Closes after click on child"
>
<fwb-list-group>
<fwb-list-group-item>
<fwb-list-group-item hover>
Profile
</fwb-list-group-item>
<fwb-list-group-item>
<fwb-list-group-item hover>
Settings
</fwb-list-group-item>
<fwb-list-group-item>
<fwb-list-group-item hover>
Messages
</fwb-list-group-item>
<fwb-list-group-item>
<fwb-list-group-item hover>
Download
</fwb-list-group-item>
</fwb-list-group>
Expand Down
Loading