Svelte List Group - Flowbite

Use the list group component to display a series of items, buttons or links inside a single element

The list group component can be used to display a series of elements, buttons or links inside a single card component similar to a sidebar.

Setup #

Svelte
<script>
  import { Listgroup, ListgroupItem } from 'flowbite-svelte';
</script>

Default list group #

Here’s an example of a list group that you can use right away.

Profile
Settings
Messages
Download
  
Svelte
<script>
  import { Listgroup } from 'flowbite-svelte';
  let simpleList = ['Profile', 'Settings', 'Messages', 'Download'];
</script>

<Listgroup items={simpleList} let:item class="w-48">
  {item}
</Listgroup>

List group with links #

You can also display a series of links inside the list group element. Notice how items provide the href field.

You need to set the list to active mode to enable hovering, focus and links.

If list is active and data items contain href field entries are presented as <a> elements.

<div class="w-full mx-auto bg-gradient-to-r bg-white dark:bg-gray-900 p-6 flex justify-center"><div class="bg-white dark:bg-gray-800 text-gray-500 dark:text-gray-400 rounded-lg border border-gray-200 dark:border-gray-700 divide-y divide-gray-200 dark:divide-gray-600 w-48"><a href="/accordion" class="block py-2 px-4 w-full text-sm font-medium list-none first:rounded-t-lg last:rounded-b-lg text-white bg-primary-700 dark:text-white dark:bg-gray-800" aria-current="true">Accordions</a> <a href="/alerts" class="block py-2 px-4 w-full text-sm font-medium list-none first:rounded-t-lg last:rounded-b-lg hover:bg-gray-100 hover:text-primary-700 dark:hover:bg-gray-600 dark:hover:text-white focus:z-40 focus:outline-none focus:ring-2 focus:ring-primary-700 focus:text-primary-700 dark:focus:ring-gray-500 dark:focus:text-white" aria-current="false">Alerts</a> <a href="/badges" class="block py-2 px-4 w-full text-sm font-medium list-none first:rounded-t-lg last:rounded-b-lg hover:bg-gray-100 hover:text-primary-700 dark:hover:bg-gray-600 dark:hover:text-white focus:z-40 focus:outline-none focus:ring-2 focus:ring-primary-700 focus:text-primary-700 dark:focus:ring-gray-500 dark:focus:text-white" aria-current="false">Badges</a> <a href="/breadcrumbs" class="block py-2 px-4 w-full text-sm font-medium list-none first:rounded-t-lg last:rounded-b-lg hover:bg-gray-100 hover:text-primary-700 dark:hover:bg-gray-600 dark:hover:text-white focus:z-40 focus:outline-none focus:ring-2 focus:ring-primary-700 focus:text-primary-700 dark:focus:ring-gray-500 dark:focus:text-white" aria-current="false">Breadcrumbs</a> </div>  </div>
Svelte
<script>
  import { Listgroup } from 'flowbite-svelte';
  let links = [
    { name: 'Accordions', href: '/accordion', current: true },
    { name: 'Alerts', href: '/alerts' },
    { name: 'Badges', href: '/badges' },
    { name: 'Breadcrumbs', href: '/breadcrumbs' }
  ];
</script>

<Listgroup active items={links} let:item class="w-48">
  {item.name}
</Listgroup>

List group with buttons #

It is also possible to display a list of button element inside the list group component. The following example includes an active and disabled item as well.

You need to set the list to active mode to enable hovering, focus and on:click.

If list is active and data items do not contain href field entries are presented as <button> elements triggering on:click events.

    
Svelte
<script>
  import { Listgroup } from 'flowbite-svelte';
  let buttons = [
    { name: 'Profile', mycustomfield: 'data1', current: true },
    { name: 'Settings', mycustomfield: 'data2' },
    { name: 'Messages', mycustomfield: 'data3' },
    { name: 'Download', mycustomfield: 'data4', disabled: true }
  ];
</script>

<Listgroup active items={buttons} let:item class="w-48" on:click={(e) => alert(Object.entries(e.detail))}>
  {item.name}
</Listgroup>

List group with icons #

Use the following example to create a list of buttons as a menu together with SVG icons.

    
Svelte
<script>
  import { Listgroup } from 'flowbite-svelte';
  import { IconSolid } from 'flowbite-svelte-icons';
  let icons = [
    { name: 'Profile', icon: 'user-circle-solid' },
    { name: 'Settings', icon: 'adjustments-horizontal-outline' },
    { name: 'Messages', icon: 'messages-solid' },
    { name: 'Download', icon: 'download-solid' }
  ];
</script>

<Listgroup active items={icons} let:item class="w-48" on:click={console.log}>
  <svelte:component this={IconSolid} name={item.icon} class="w-3 h-3 mr-2.5" />
  {item.name}
</Listgroup>

Advanced #

When non standard usage is needed you can omit the items props and add elements directly to the list. Usage of hidden so far ListgroupItem helps you with proper layout.

User list        
Delete user
Svelte
<script>
  import { Listgroup, ListgroupItem, Avatar } from 'flowbite-svelte';
  import { TrashBinSolid } from 'flowbite-svelte-icons';
</script>

<Listgroup active class="w-48">
  <h3 class="p-1 text-center text-xl font-medium text-gray-900 dark:text-white">User list</h3>
  <ListgroupItem class="text-base font-semibold gap-2">
    <Avatar src="/images/profile-picture-1.webp" size="xs" />Jese Leos
  </ListgroupItem>
  <ListgroupItem class="text-base font-semibold gap-2">
    <Avatar src="/images/profile-picture-2.webp" size="xs" />Robert Gouth
  </ListgroupItem>
  <ListgroupItem class="text-base font-semibold gap-2">
    <Avatar src="/images/profile-picture-3.webp" size="xs" />Bonnie Green
  </ListgroupItem>
  <a href="/" class="flex items-center p-3 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 rounded-b-lg">
    <TrashBinSolid class="w-6 h-6 ml-1 mr-2" />
    Delete user
  </a>
</Listgroup>

Component data #

The component has the following props, type, and default values. See types page for type information.

Listgroup styling #

Use the class prop to overwrite defaultClass.

ListgroupItem styling #

Use the class prop to overwrite the li tag class.

References #

Flowbite List Group

KBD

Mega menu