List Item

The ListItem component is a very flexible tool to display an image together with a title (text) some meta information (info) and a dropdown with options in a line. It's the counter part to our cards.

Example

<k-list-item
  :image="{
    ratio: '3/2',
    cover: true,
    back: 'pattern',
    url: 'https://picsum.photos/400/400?random'
  }"
  :options="[
    {icon: 'edit', text: 'Edit'},
    {icon: 'trash', text: 'Delete'}
  ]"
  text="Some image from unsplash"
  info="random-unsplash.jpg"
  link="https://unsplash.com/"
  target="_blank"
/>

Props

flag

Object (default: null)

An additional button left next to the options toggle, which can be used to define any additional "flag" or option for the list item.

<k-list-item
  :flag="{
    icon: 'trash',
    click: someClickHandler
  }"
/>

icon

String (default: null)

Defines the list item icon instead of an image. If an image is still defined,
the image will be used instead of the icon and this setting will be ignored.

<k-list-item
  :icon="{
    type: 'file',
    back: 'black'
  }"
/>

image

Object (default: null)

Defines the list item image

<k-list-item
  :image="{
    url: 'https://picsum.photos/400/400?random',
    ratio: '1/1',
    back: 'pattern',
    cover: true
  }"
/>

info

String (default: null)

Sets the secondary info text

link

String (default: null)

Sets the link for the list item

options

Array|Function (default: null)

Defines the options dropdown.

<k-list-item
  :options="[
    {icon: 'edit', text: 'Edit'},
    {icon: 'trash', text: 'Delete'}
  ]"
/>

target

String (default: null)

Sets the link target

text

String (default null)

Sets the list item text

Slots

options

You can overwrite the options button and dropdown with your own elements:

<k-list-item text="Some text" image="{ url: 'https://picsum.photos/400/400?random' }">
  <k-button slot="options" type="check" />
</k-list-item>

Events

action

If you've defined the options dropdown, each click on a dropdown item will emmit the action event.

<template>
  <k-list-item
    :options="[
      {icon: 'edit', text: 'Edit', click: 'edit'},
      {icon: 'trash', text: 'Delete', click: 'delete'}
    ]"
    @action="action"
  />
</template>

<script>
export default {
  methods: {
    action(type) {
      switch(type) {
        case 'edit':
          // edit the item here
          break;
        case 'delete':
          // delete the item here
          break;
      }
    }
  }
};
</script>

CSS class

.k-list-item