Svelte Dropdown - Flowbite
Get started with the dropdown component to show a list of menu items when clicking on the trigger element based on multiple layouts, styles, and placements
The dropdown component can be used to show a list of menu items when clicking on an element such as a button and hiding it when clicking outside of the triggering element.
Setup #
- Svelte
<script>
import { Dropdown, DropdownItem, DropdownDivider, DropdownHeader } from 'flowbite-svelte';
</script>
Examples #
If you want to show a dropdown menu when clicking on an element add the Dropdown
and DropdownItem
components.
- Svelte
<script>
import { Button, Dropdown, DropdownItem } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
</script>
<Button>Dropdown button<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown>
<DropdownItem>Dashboard</DropdownItem>
<DropdownItem>Settings</DropdownItem>
<DropdownItem>Earnings</DropdownItem>
<DropdownItem>Sign out</DropdownItem>
</Dropdown>
Adding links and active class #
Utilize the href
prop within the DropdownItem
component to incorporate a hyperlink. To initiate the application of the active class, include the activeUrl
prop within the Dropdown
component:
- Svelte
<script>
import { Button, Dropdown, DropdownItem } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
import { page } from '$app/stores';
$: activeUrl = $page.url.pathname;
</script>
<Button>Dropdown button<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown {activeUrl}>
<DropdownItem href="/">Home</DropdownItem>
<DropdownItem href="/docs/components/dropdown">Dropdown</DropdownItem>
<DropdownItem href="/docs/components/accordion">Accordion</DropdownItem>
<DropdownItem href="/docs/components/alert">Alert</DropdownItem>
</Dropdown>
To change the active class, use the activeClass
prop:
- Svelte
<script>
import { Button, Dropdown, DropdownItem } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
import { page } from '$app/stores';
$: activeUrl = $page.url.pathname;
let activeClass = 'text-green-700 dark:text-green-300 hover:text-green-900 dark:hover:text-green-500';
</script>
<Button>Dropdown button<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown {activeUrl} {activeClass}>
<DropdownItem href="/">Home</DropdownItem>
<DropdownItem href="/docs/components/dropdown">Dropdown</DropdownItem>
<DropdownItem href="/docs/components/accordion">Accordion</DropdownItem>
<DropdownItem href="/docs/components/alert">Alert</DropdownItem>
</Dropdown>
Dropdown divider #
You can use the DropdownDivider
component to add separate elements inside the dropdown menu. Note that you have a natural divider between main content of the Dropdown
and its header and footer.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, DropdownDivider } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
</script>
<Button>Dropdown button<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown>
<DropdownItem>Dashboard</DropdownItem>
<DropdownDivider />
<DropdownItem>Settings</DropdownItem>
<DropdownItem>Earnings</DropdownItem>
<DropdownItem slot="footer">Separated link</DropdownItem>
</Dropdown>
Dropdown header #
Use this example to show extra information outside of the list of menu items inside the dropdown.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, DropdownDivider, DropdownHeader } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
</script>
<Button>Dropdown button<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown>
<div slot="header" class="px-4 py-2">
<span class="block text-sm text-gray-900 dark:text-white">Bonnie Green</span>
<span class="block truncate text-sm font-medium">name@flowbite.com</span>
</div>
<DropdownItem>Dashboard</DropdownItem>
<DropdownItem>Settings</DropdownItem>
<DropdownItem>Earnings</DropdownItem>
<DropdownItem slot="footer">Sign out</DropdownItem>
</Dropdown>
Multi-level dropdown #
Use this example to enable multi-level dropdown menus by adding stacked elements inside of each other.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, DropdownDivider } from 'flowbite-svelte';
import { ChevronDownSolid, ChevronRightSolid } from 'flowbite-svelte-icons';
</script>
<Button>Dropdown button<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown>
<DropdownItem>Dashboard</DropdownItem>
<DropdownItem class="flex items-center justify-between">
Dropdown<ChevronRightSolid class="w-3 h-3 ml-2 text-primary-700 dark:text-white" />
</DropdownItem>
<Dropdown placement="right-start">
<DropdownItem>Overview</DropdownItem>
<DropdownItem>My downloads</DropdownItem>
<DropdownItem>Billing</DropdownItem>
</Dropdown>
<DropdownItem>Earnings</DropdownItem>
<DropdownItem slot="footer">Sign out</DropdownItem>
</Dropdown>
Programatic open/close #
When you want to control your dropdown open status via javascript code you can bind to open
property.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, DropdownDivider } from 'flowbite-svelte';
import { ChevronDownSolid, ChevronRightSolid } from 'flowbite-svelte-icons';
let dropdownOpen = false;
</script>
<Button>Dropdown button<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown bind:open={dropdownOpen}>
<DropdownItem on:click={() => (dropdownOpen = false)}>Dashboard (close)</DropdownItem>
<DropdownItem class="flex items-center justify-between">
Dropdown<ChevronRightSolid class="w-3 h-3 ml-2 text-primary-700 dark:text-white" />
</DropdownItem>
<Dropdown placement="right-start">
<DropdownItem on:click={() => (dropdownOpen = false)}>Overview (close)</DropdownItem>
<DropdownItem>My downloads</DropdownItem>
<DropdownItem>Billing</DropdownItem>
</Dropdown>
<DropdownItem>Earnings</DropdownItem>
<DropdownItem slot="footer">Sign out</DropdownItem>
</Dropdown>
Dropdown with checkbox #
Add multiple checkbox elements inside your dropdown menu to enable more advanced input interaction.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, Checkbox } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
</script>
<Button>Dropdown checkbox<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown class="w-44 p-3 space-y-3 text-sm">
<li>
<Checkbox>Default checkbox</Checkbox>
</li>
<li>
<Checkbox checked>Checked state</Checkbox>
</li>
<li>
<Checkbox>Default checkbox</Checkbox>
</li>
</Dropdown>
Background hover #
Use this example to update the background color of a menu item when using a list of checkbox elements.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, Checkbox } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
</script>
<Button>Dropdown checkbox<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown class="w-48 p-3 space-y-1 text-sm">
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Checkbox>Default checkbox</Checkbox>
</li>
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Checkbox checked>Checked state</Checkbox>
</li>
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Checkbox>Default checkbox</Checkbox>
</li>
</Dropdown>
Helper text #
Add an extra helper text to each checkbox element inside the dropdown menu list with this example.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, Checkbox, Helper } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
</script>
<Button>Dropdown checkbox<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown class="w-60 p-3 space-y-1 text-sm">
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Checkbox>Enable notifications</Checkbox>
<Helper class="pl-6">Some helpful instruction goes over here.</Helper>
</li>
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Checkbox checked>Enable 2FA auth</Checkbox>
<Helper class="pl-6">Some helpful instruction goes over here.</Helper>
</li>
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Checkbox>Subscribe newsletter</Checkbox>
<Helper class="pl-6">Some helpful instruction goes over here.</Helper>
</li>
</Dropdown>
Dropdown with radio #
Add multiple radio elements inside your dropdown menu to enable more advanced input interaction.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, Radio } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
let group1 = 2;
</script>
<Button>
Dropdown radio {group1}<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" />
</Button>
<Dropdown class="w-44 p-3 space-y-3 text-sm">
<li>
<Radio name="group1" bind:group={group1} value={1}>Default radio</Radio>
</li>
<li>
<Radio name="group1" bind:group={group1} value={2}>Checked state</Radio>
</li>
<li>
<Radio name="group1" bind:group={group1} value={3}>Default radio</Radio>
</li>
</Dropdown>
Background hover #
Use this example to update the background color of a menu item when using a list of radio elements.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, Radio } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
let group2 = 2;
</script>
<Button>Dropdown radio<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown class="w-48 p-3 space-y-1">
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Radio name="group2" bind:group={group2} value={1}>Default radio</Radio>
</li>
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Radio name="group2" bind:group={group2} value={2}>Checked state</Radio>
</li>
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Radio name="group2" bind:group={group2} value={3}>Default radio</Radio>
</li>
</Dropdown>
Helper text #
Add an extra helper text to each radio element inside the dropdown menu list with this example.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, Radio, Helper } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
let group3 = 2;
</script>
<Button>Dropdown radio<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown class="w-60 p-3 space-y-1">
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Radio name="group3" bind:group={group3} value={1}>Enable notifications</Radio>
<Helper class="pl-6">Some helpful instruction goes over here.</Helper>
</li>
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Radio name="group3" bind:group={group3} value={2}>Enable 2FA auth</Radio>
<Helper class="pl-6">Some helpful instruction goes over here.</Helper>
</li>
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Radio name="group3" bind:group={group3} value={3}>Subscribe newsletter</Radio>
<Helper class="pl-6">Some helpful instruction goes over here.</Helper>
</li>
</Dropdown>
Dropdown with toggle switch #
Show a list of toggle switch elements inside the dropdown menu to enable a yes or no type of choice.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, Toggle } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
let group2 = 2;
</script>
<Button>Dropdown toggle<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown class="w-56 p-3 space-y-1">
<li>
<Toggle class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">Default toggle</Toggle>
</li>
<li>
<Toggle class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600" checked>Checked state</Toggle>
</li>
<li>
<Toggle class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">Default toggle</Toggle>
</li>
</Dropdown>
Dropdown navbar #
You can also use the dropdown element inside a navigation bar and add a second level of navigation hierarchy, but make sure to use Navbar components.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, DropdownDivider, Navbar, NavBrand, NavHamburger, NavUl, NavLi } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
let group3 = 2;
</script>
<Navbar let:hidden let:toggle>
<NavBrand href="/">
<img src="/images/flowbite-svelte-icon-logo.svg" class="mr-3 h-6 sm:h-9" alt="Flowbite Logo" />
<span class="self-center whitespace-nowrap text-xl font-semibold dark:text-white">Flowbite</span>
</NavBrand>
<NavHamburger on:click={toggle} />
<NavUl {hidden} class="ml-3">
<NavLi href="/" active={true}>Home</NavLi>
<NavLi class="cursor-pointer">
Dropdown<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" />
</NavLi>
<Dropdown offset="18">
<DropdownItem>Dashboard</DropdownItem>
<DropdownItem>Settings</DropdownItem>
<DropdownItem>Earnings</DropdownItem>
<DropdownItem slot="footer">Sign out</DropdownItem>
</Dropdown>
<NavLi href="/services">Services</NavLi>
<NavLi href="/pricing">Pricing</NavLi>
<NavLi href="/contact">Contact</NavLi>
</NavUl>
</Navbar>
Dropdown with scrolling #
This example can be used when you want to show a long list of items that won’t affect the height of the dropdown menu by enabling a scrolling behaviour.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, Avatar } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
</script>
<Button>Project users<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown class="w-48 overflow-y-auto py-1 h-48">
<DropdownItem class="flex items-center text-base font-semibold gap-2">
<Avatar src="/images/profile-picture-1.webp" size="xs" />Jese Leos
</DropdownItem>
<DropdownItem class="flex items-center text-base font-semibold gap-2">
<Avatar src="/images/profile-picture-2.webp" size="xs" />Robert Gouth
</DropdownItem>
<DropdownItem class="flex items-center text-base font-semibold gap-2">
<Avatar src="/images/profile-picture-3.webp" size="xs" />Bonnie Green
</DropdownItem>
<DropdownItem class="flex items-center text-base font-semibold gap-2">
<Avatar src="/images/profile-picture-1.webp" size="xs" />Robert Wall
</DropdownItem>
<DropdownItem class="flex items-center text-base font-semibold gap-2">
<Avatar src="/images/profile-picture-2.webp" size="xs" />Joseph Mcfall
</DropdownItem>
<DropdownItem class="flex items-center text-base font-semibold gap-2">
<Avatar src="/images/profile-picture-3.webp" size="xs" />Leslie Livingston
</DropdownItem>
<a slot="footer" href="/" class="flex items-center px-3 py-2 -mb-1 text-sm font-medium text-primary-600 bg-gray-50 hover:bg-gray-100 dark:bg-gray-700 dark:hover:bg-gray-600 dark:text-primary-500 hover:underline">
<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" />Add new user
</a>
</Dropdown>
Dropdown with search #
Use this example if you want to add a search bar inside the dropdown menu to be able to filter through a long list of menu items with scrolling behaviour.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, Checkbox, Search } from 'flowbite-svelte';
import { ChevronDownSolid, UserRemoveSolid } from 'flowbite-svelte-icons';
</script>
<Button>Dropdown search<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown class="overflow-y-auto px-3 pb-3 text-sm h-44">
<div slot="header" class="p-3">
<Search size="md" />
</div>
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Checkbox>Robert Gouth</Checkbox>
</li>
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Checkbox>Jese Leos</Checkbox>
</li>
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Checkbox checked>Bonnie Green</Checkbox>
</li>
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Checkbox>Jese Leos</Checkbox>
</li>
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Checkbox>Robert Gouth</Checkbox>
</li>
<li class="rounded p-2 hover:bg-gray-100 dark:hover:bg-gray-600">
<Checkbox>Bonnie Green</Checkbox>
</li>
<a slot="footer" href="/" class="flex items-center p-3 -mb-1 text-sm font-medium text-red-600 bg-gray-50 hover:bg-gray-100 dark:bg-gray-700 dark:hover:bg-gray-600 dark:text-red-500 hover:underline">
<UserRemoveSolid class="w-4 h-4 mr-2 text-primary-700 dark:text-primary-700" />Delete user
</a>
</Dropdown>
Menu icon #
Use the menu icon trigger element on components such as cards as an alternative element to the button.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, ToolbarButton, DropdownDivider } from 'flowbite-svelte';
import { DotsHorizontalOutline, DotsVerticalOutline } from 'flowbite-svelte-icons';
</script>
<DotsHorizontalOutline class="dots-menu dark:text-white" />
<DotsVerticalOutline class="dots-menu dark:text-white" />
<Dropdown triggeredBy=".dots-menu">
<DropdownItem>Dashboard</DropdownItem>
<DropdownItem>Settings</DropdownItem>
<DropdownItem>Earnings</DropdownItem>
<DropdownItem slot="footer">Sign out</DropdownItem>
</Dropdown>
Notification bell #
Use this example to show a list of notifications inside your application by providing more detailed information such as the user avatar, content and time of notification triggered by a notification bell icon.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, DropdownHeader, Avatar } from 'flowbite-svelte';
import { BellSolid, EyeSolid } from 'flowbite-svelte-icons';
</script>
<div id="bell" class="inline-flex items-center text-sm font-medium text-center text-gray-500 hover:text-gray-900 focus:outline-none dark:hover:text-white dark:text-gray-400">
<BellSolid class="w-5 h-5kj" />
<div class="flex relative">
<div class="inline-flex relative -top-2 right-3 w-3 h-3 bg-red-500 rounded-full border-2 border-white dark:border-gray-900" />
</div>
</div>
<Dropdown triggeredBy="#bell" class="w-full max-w-sm rounded divide-y divide-gray-100 shadow dark:bg-gray-800 dark:divide-gray-700">
<div slot="header" class="text-center py-2 font-bold">Notifications</div>
<DropdownItem class="flex space-x-4">
<Avatar src="/images/profile-picture-1.webp" dot={{ color: 'bg-gray-300' }} rounded />
<div class="pl-3 w-full">
<div class="text-gray-500 text-sm mb-1.5 dark:text-gray-400">
New message from <span class="font-semibold text-gray-900 dark:text-white">Jese Leos</span>
: "Hey, what's up? All set for the presentation?"
</div>
<div class="text-xs text-primary-600 dark:text-primary-500">a few moments ago</div>
</div>
</DropdownItem>
<DropdownItem class="flex space-x-4">
<Avatar src="/images/profile-picture-2.webp" dot={{ color: 'bg-red-400' }} rounded />
<div class="pl-3 w-full">
<div class="text-gray-500 text-sm mb-1.5 dark:text-gray-400">
<span class="font-semibold text-gray-900 dark:text-white">Joseph Mcfall</span>
and
<span class="font-medium text-gray-900 dark:text-white">5 others</span>
started following you.
</div>
<div class="text-xs text-primary-600 dark:text-primary-500">10 minutes ago</div>
</div>
</DropdownItem>
<DropdownItem class="flex space-x-4">
<Avatar src="/images/profile-picture-3.webp" dot={{ color: 'bg-green-400' }} rounded />
<div class="pl-3 w-full">
<div class="text-gray-500 text-sm mb-1.5 dark:text-gray-400">
<span class="font-semibold text-gray-900 dark:text-white">Bonnie Green</span>
and
<span class="font-medium text-gray-900 dark:text-white">141 others</span>
love your story. See it and view more stories.
</div>
<div class="text-xs text-primary-600 dark:text-primary-500">44 minutes ago</div>
</div>
</DropdownItem>
<a slot="footer" href="/" class="block py-2 -my-1 text-sm font-medium text-center text-gray-900 bg-gray-50 hover:bg-gray-100 dark:bg-gray-800 dark:hover:bg-gray-700 dark:text-white">
<div class="inline-flex items-center">
<EyeSolid class="mr-2 w-4 h-4 text-gray-500 dark:text-gray-400" />
View all
</div>
</a>
</Dropdown>
User avatar #
This example can be used to show a list of menu items and options when a user is logged into your application.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, Avatar, DropdownHeader, DropdownDivider } from 'flowbite-svelte';
</script>
<Avatar class="acs" src="/images/profile-picture-3.webp" dot={{ color: 'green' }} />
<Dropdown triggeredBy=".acs">
<div slot="header" class="px-4 py-2">
<span class="block text-sm text-gray-900 dark:text-white">Bonnie Green</span>
<span class="block truncate text-sm font-medium">name@flowbite.com</span>
</div>
<DropdownItem>Dashboard</DropdownItem>
<DropdownItem>Settings</DropdownItem>
<DropdownItem>Earnings</DropdownItem>
<DropdownItem slot="footer">Sign out</DropdownItem>
</Dropdown>
Avatar with name #
Use this example to also show the name or email of the user next to the avatar for the dropdown menu.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, Avatar, DropdownHeader, DropdownDivider } from 'flowbite-svelte';
</script>
<Button pill color="light" id="avatar_with_name" class="!p-1">
<Avatar src="/images/profile-picture-3.webp" class="mr-2" />
Bonnie Green
</Button>
<Dropdown inline triggeredBy="#avatar_with_name">
<div slot="header" class="px-4 py-2">
<span class="block text-sm text-gray-900 dark:text-white">Bonnie Green</span>
<span class="block truncate text-sm font-medium">name@flowbite.com</span>
</div>
<DropdownItem>Dashboard</DropdownItem>
<DropdownItem>Settings</DropdownItem>
<DropdownItem>Earnings</DropdownItem>
<DropdownItem slot="footer">Sign out</DropdownItem>
</Dropdown>
Sizes #
The dropdown menus work with buttons of all sizes including smaller or larger ones.
- Svelte
<script>
import { Button, Dropdown, DropdownItem } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
</script>
<Dropdown triggeredBy=".sizes">
<DropdownItem>Dashboard</DropdownItem>
<DropdownItem>Settings</DropdownItem>
<DropdownItem>Earnings</DropdownItem>
<DropdownItem slot="footer">Sign out</DropdownItem>
</Dropdown>
<Button class="sizes" size="sm">
Small dropdown<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" />
</Button>
<Button class="sizes" size="lg">
Large dropdown<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" />
</Button>
Placement #
You can also use the placement={top|right|bottom|left}
options to choose the placement of the dropdown menu. By default the positioning is set to the bottom side of the button.
- Svelte
<script>
import { Button, Dropdown, DropdownItem } from 'flowbite-svelte';
import { ChevronDownSolid, ChevronUpSolid, ChevronRightSolid, ChevronLeftSolid } from 'flowbite-svelte-icons';
let placement = 'left';
</script>
<Dropdown {placement} triggeredBy="#placements button" on:show={(e) => (placement = e.target.textContent.trim().split(' ')[1])}>
<DropdownItem>Dashboard</DropdownItem>
<DropdownItem>Settings</DropdownItem>
<DropdownItem>Earnings</DropdownItem>
<DropdownItem slot="footer">Sign out</DropdownItem>
</Dropdown>
<div id="placements" class="flex flex-col justify-center items-center gap-2 h-96 my-8">
<Button>Dropdown top<ChevronUpSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<div class="space-x-2">
<Button><ChevronLeftSolid class="w-3 h-3 mr-2 text-white dark:text-white" />Dropdown left</Button>
<Button>Dropdown right<ChevronRightSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
</div>
<Button>Dropdown bottom<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
</div>
Double placement #
- Svelte
<script>
import { Button, Dropdown, DropdownItem } from 'flowbite-svelte';
import { ChevronDownSolid, ChevronUpSolid } from 'flowbite-svelte-icons';
let placement = 'left';
</script>
<Button data-placement="left-start">
Dropdown left start<ChevronUpSolid class="w-3 h-3 ml-2 text-white dark:text-white" />
</Button>
<Button data-placement="right-end">
Dropdown right end<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" />
</Button>
<Dropdown {placement} triggeredBy="[data-placement]" on:show={(e) => (placement = e.target.dataset.placement)}>
<DropdownItem>Dashboard</DropdownItem>
<DropdownItem>Settings</DropdownItem>
<DropdownItem>Earnings</DropdownItem>
<DropdownItem slot="footer">Sign out</DropdownItem>
</Dropdown>
Events #
DropdownItem
renders to link or button wrapped with <li/>
element depending whether you supplied the href
property. Therefore you can catch standard events on it like on:click
.
- Svelte
<script>
import { Button, Dropdown, DropdownItem, Checkbox } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
const handleClick = (e) => {
e.preventDefault();
alert('Clicked on: ' + e.target);
};
</script>
<Button>Dropdown button<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown>
<DropdownItem href="/link" on:click={handleClick}>Rendered as link</DropdownItem>
<DropdownItem on:click={handleClick}>Rendered as button</DropdownItem>
</Dropdown>
Adding links and active class #
When you need to include a link with an active class, you can follow the example below:
- Svelte
<script>
import { page } from '$app/stores';
import { Button, Dropdown, DropdownItem } from 'flowbite-svelte';
import { ChevronDownSolid } from 'flowbite-svelte-icons';
$: activeUrl = $page.url.pathname;
</script>
<Button>Dropdown button<ChevronDownSolid class="w-3 h-3 ml-2 text-white dark:text-white" /></Button>
<Dropdown>
<DropdownItem href="/home" active={activeUrl === '/'}>Home</DropdownItem>
<DropdownItem href="/docs/pages/quickstart" active={activeUrl === '/docs/pages/quickstart'}>Quickstart</DropdownItem>
<DropdownItem href="/docs/components/dropdown" active={activeUrl === '/docs/components/dropdown'}>Dropdown</DropdownItem>
<DropdownItem href="/docs/components/accordion" active={activeUrl === '/docs/components/accordion'}>Accordion</DropdownItem>
</Dropdown>
The active prop is utilized to dynamically apply an active class to the link when the activeUrl variable matches the current URL. Remember to customize the href value and the condition in the active prop based on your specific use case.
Component data #
The component has the following props, type, and default values. See types page for type information.
Dropdown styling #
- Use the
class
prop to style underlyingul
element. - Use the
classContainer
prop to overwritecontainerClass
. - Use the
classHeader
prop to overwriteheaderClass
. - Use the
classFooter
prop to overwritefooterClass
.
DropdownDivider styling #
- Use the
class
prop to overwritedivClass
.
DropdownHeader styling #
- Use the
class
prop to overwritedivClass
.
DropdownItem styling #
- Use the
class
prop to overwritedefaultClass
.