List Item Vue Component

List Item Components

There are following components included:

  • f7-list-item - main list item element
  • f7-list-item-row - list item row element for custom layout
  • f7-list-item-cell - list item cell element for custom layout

List Item Properties

PropTypeDefaultDescription
<f7-list-item> properties
titlestringList item title
subtitlestringList item subtitle (only for Media List)
textstringList item text (only for Media List)
headerstringList item header text
footerstringList item footer text
mediastringList item media image URL
afterstringList item label
badgestring
number
List item Badge
badge-colorstringList item Badge color. One of the default colors
media-itembooleanEnables Media list item for the current list item
dividerbooleanConverts list item to list item divider
group-titlebooleanConverts list item to list group title
no-fast-clickbooleanDisables fast click
targetbooleanList item link target attribute
no-chevronbooleanfalseRemoves "chevron" icon on list item link
chevron-centerbooleanfalseSets "chevron" icon on media list item on center (vertically)
tooltipstringList button tooltip text to show on button hover/press
<f7-list-item> Form inputs specific properties
inline-labelbooleanfalseEnables inline-styled labels for Form Inputs. By default inherirt inline-labels prop on parent <f7-list>
item-inputbooleanfalseEnables additional styling for Form Inputs inside. By default will try to detect based on content
item-input-with-infobooleanfalseEnables additional styling for Form Inputs with additional info. By default will try to detect based on content
<f7-list-item> Swipeout specific properties
swipeoutbooleanConverts list item to swipeout list item
swipeout-openedbooleanDefines whether swipe actions should be opened or not. Note, only one swipeout item can be opened at same time
<f7-list-item> Accordion specific properties
accordion-itembooleanfalseConverts list item to accordion list item
accordion-item-openedbooleanfalseMakes accordion item opened
<f7-list-item> Virtual List specific properties
virtual-list-indexnumberAllows to pass list item index (from whole collection) when used in Virtual List. Useful to be used together with Sortable to know correct changed indexes
<f7-list-item> Smart Select specific properties
smart-selectbooleanfalseEnables Smart Select behavior
smart-select-paramsobjectObject with Smart Select Parameters
<f7-list-item> Checkboxes & Radios specific properties
checkboxbooleanfalseEnables checkbox-item
radiobooleanfalseEnables radio-item
checkedbooleanfalseWhether the checkbox/radio input is checked
indeterminatebooleanDefines whether the checkbox input is in indeterminate state or not
namestringCheckbox/radio input name
valuestring
number
Checkbox/radio input value
readonlybooleanfalseWhether the checkbox/radio input is readonly
disabledbooleanfalseWhether the checkbox/radio input is disabled
requiredbooleanfalseWhether the checkbox/radio input is required
<f7-list-item> navigation/router related properties
linkboolean
string
Enables link and link URL if specified as string. Same as href prop
hrefstring
boolean
#URL of the page to load. In case of boolean href="false" it won't add href tag
targetstringValue of link target attribute, e.g. _blank, _self, etc.
viewstringCSS selector of the View to load the page
externalbooleanEnable to bypass Framework7's link click handler
backbooleanEnables back navigation link
forcebooleanForce page to load and ignore previous page in history (use together with back prop)
reload-currentbooleanReloads new page instead of the currently active one
reload-previousbooleanReplace the previous page in history with the new one from route
reload-allbooleanLoad new page and remove all previous pages from history and DOM
reload-detailbooleanReload Detail page in Master Detail view
animatebooleanDisables pages animation
ignore-cachebooleanIgnores caching
route-tab-idstringRoutable Tab id
route-propsobjectObject with additional props that will be passed to target route component
prevent-routerbooleanfalseIf set, then it won't be processed by Framework7 router
<f7-list-item> action related properties
panel-openstring
boolean
Defines panel to open. Can be left or right
panel-closebooleanCloses panel on click
panel-togglebooleanToggle (open/close) panel on click
actions-openstring
boolean
CSS selector of the action sheet to open on click
actions-closestring
boolean
CSS selector of the action sheet to close on click. Or boolean property to close currently opened action sheet
popup-openstring
boolean
CSS selector of the popup to open on click
popup-closestring
boolean
CSS selector of the popup to close on click. Or boolean property to close currently opened popup
popover-openstring
boolean
CSS selector of the popover to open on click
popover-closestring
boolean
CSS selector of the popover to close on click. Or boolean property to close currently opened popover
sheet-openstring
boolean
CSS selector of the sheet modal to open on click
sheet-closestring
boolean
CSS selector of the sheet modal to close on click. Or boolean property to close currently opened sheet modal
login-screen-openstring
boolean
CSS selector of the login screen to open on click
login-screen-closestring
boolean
CSS selector of the login screen to close on click. Or boolean property to close currently opened login screen
sortable-enablestring
boolean
CSS selector of the Sortable list to open on click
sortable-disablestring
boolean
CSS selector of the Sortable list to close on click. Or boolean property to close currently opened Sortable list
sortable-togglestring
boolean
CSS selector of the Sortable list to toggle on click. Or boolean property to toggle currently opened/closed Sortable list
searchbar-enablestring
boolean
CSS selector of the Expandable Searchbar to be enabled on click. Or boolean property to enable the first found Searchbar
searchbar-disablestring
boolean
CSS selector of the Expandable Searchbar to be disabled on click. Or boolean property to disable the first found Searchbar
searchbar-togglestring
boolean
CSS selector of the Expandable Searchbar to toggle on click. Or boolean property to toggle the first found Searchbar
searchbar-clearstring
boolean
CSS selector of the Expandable Searchbar to clear on click. Or boolean property to clear the first found Searchbar
card-openstring
boolean
CSS selector of the expandable card to open on click. Or boolean to open first found expandable card
card-closestring
boolean
CSS selector of the expandable card to close on click. Or boolean property to close currently opened expandable card
card-prevent-openbooleanClick on element with this prop won't open its parent expandable card
menu-closebooleanCloses Menu dropdown on click

List Item Events

EventDescription
<f7-list-item> events
clickEvent will be triggeres when user clicks on list item
changeEvent will be triggeres when "change" event occurs on list item input (radio or checkbox)
swipeoutEvent will be triggered while you move swipeout element. event.detail.progress contains current opened progress percentage
swipeout:openEvent will be triggered when swipeout element starts its opening animation
swipeout:openedEvent will be triggered after swipeout element completes its opening animation
swipeout:closeEvent will be triggered when swipeout element starts its closing animation
swipeout:closedEvent will be triggered after swipeout element completes its closing animation
swipeout:deleteEvent will be triggered after swipeout element starts its delete animation
swipeout:deletedEvent will be triggered after swipeout element completes its delete animation right before it will be removed from DOM
accordion:beforeopenEvent will be triggered right before accordion content starts its opening animation. event.detail.prevent contains function that will prevent accordion from opening when called
accordion:openEvent will be triggered when accordion content starts its opening animation.
accordion:openedEvent will be triggered after accordion content completes its opening animation.
accordion:beforecloseEvent will be triggered right before accordion content starts its closing animation. event.detail.prevent contains function that will prevent accordion from closing when called
accordion:closeEvent will be triggered when accordion content starts its closing animation.
accordion:closedEvent will be triggered after accordion content completes its closing animation.

List Item Slots

List Item Vue component (<f7-list-item>) has additional slots for custom elements:

  • root-start - element will be inserted in the beginning of <li> element
  • root / root-end - element will be inserted in the end of <li> element
  • content-start - element will be inserted in the beginning of <div class="item-content"> element
  • content / content-end - element will be inserted in the end of <div class="item-content"> element
  • inner-start - element will be inserted in the beginning of <div class="item-inner"> element
  • default / inner / inner-end - element will be inserted in the end of <div class="item-inner"> element
  • media - element will be inserted inside of <div class="item-media"> element
  • before-title - element will be inserted before <div class="item-title"> element
  • title - element will be inserted inside of <div class="item-title"> element
  • after-title - element will be inserted after <div class="item-title"> element
  • subtitle - element will be inserted inside of <div class="item-subtitle"> element
  • text - element will be inserted inside of <div class="item-text"> element
  • header - element will be inserted inside of <div class="item-header"> element
  • footer - element will be inserted inside of <div class="item-footer"> element
  • after-start - element will be inserted in the beginning of <div class="item-after"> element
  • after / after-end - element will be inserted in the end of <div class="item-after"> element
<f7-list media-list>
  <f7-list-item
    link="/home/"
    title="Item Title"
    subtitle="Item Subtitle"
    text="Text"
    after="Read more"
    >
      <img src="path-to-my-image.jpg" slot="media">
      <div slot="root-start">Root Start</div>
      <div slot="root">Root End</div>
      <div slot="content-start">Content Start</div>
      <div slot="content">Content End</div>
      <div slot="media-start">Media Start</div>
      <div slot="media">Media</div>
      <span slot="after-start">After Start</span>
      <span slot="after">After End</span>
      <div slot="inner-start">Inner Start</div>
      <div slot="inner">Inner End</div>
      <div slot="before-title">Before Title</div>
      <div slot="after-title">After Title</div>
  </f7-list-item>
</f7-list>

<!-- Renders to: -->

<div class="list media-list">
  <ul>
    <li>
      <div>Root Start</div>
      <a href="/home/" class="item-link">
        <div class="item-content">
          <div>Content Start</div>
          <div class="item-media">
            <img src="path-to-my-image.jpg">
          </div>
          <div class="item-inner">
            <div>Inner Start</div>
            <div class="item-title-row">
              <div>Before Title</div>
              <div class="item-title">Item Title</div>
              <div>After Title</div>
              <div class="item-after">
                <span>After Start</span>
                <span>Read more</span>
                <span>After End</span>
              </div>
            </div>
            <div class="item-subtitle">Item Subtitle</div>
            <div class="item-text">Text</div>
            <div>Inner End</div>
          </div>
          <div>Content End</div>
        </div>
      </a>
      <div>Root End</div>
    </li>
  </ul>
</div>

Examples

Simple List

<f7-block-title>Simple List</f7-block-title>
<f7-list simple-list>
  <f7-list-item title="Item 1"></f7-list-item>
  <f7-list-item title="Item 2"></f7-list-item>
  <f7-list-item title="Item 3"></f7-list-item>
</f7-list>

Simple List Links

<f7-block-title>Simple Links List</f7-block-title>
<f7-list>
  <f7-list-item title="Link 1" link="#"></f7-list-item>
  <f7-list-item title="Link 2" link="#"></f7-list-item>
  <f7-list-item title="Link 3" link="#"></f7-list-item>
</f7-list>

Data list, with icons

<f7-block-title>Data list, with icons</f7-block-title>
<f7-list>
  <f7-list-item title="Ivan Petrov" after="CEO">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item title="John Doe" badge="5">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item title="Jenna Smith">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
</f7-list>

Links

<f7-block-title>Links</f7-block-title>
<f7-list>
  <f7-list-item link="#" title="Ivan Petrov" after="CEO">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item link="#" title="John Doe" after="Cleaner">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item link="#" title="Jenna Smith">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
</f7-list>

Links, Header, Footer

<f7-block-title>Links, Header, Footer</f7-block-title>
<f7-list>
  <f7-list-item link="#" header="Name" title="John Doe" after="Edit">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item link="#" header="Phone" title="+7 90 111-22-3344" after="Edit">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item link="#" header="Email" title="[email protected]" footer="Home" after="Edit">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item link="#" header="Email" title="[email protected]" footer="Work" after="Edit">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
</f7-list>

Links, no icons

<f7-block-title>Links, no icons</f7-block-title>
<f7-list>
  <f7-list-item link="#" title="Ivan Petrov"></f7-list-item>
  <f7-list-item link="#" title="John Doe"></f7-list-item>
  <f7-list-item divider title="Divider Here"></f7-list-item>
  <f7-list-item link="#" title="Ivan Petrov"></f7-list-item>
  <f7-list-item link="#" title="Jenna Smith"></f7-list-item>
</f7-list>

Grouped with sticky titles

<f7-block-title>Grouped with sticky titles</f7-block-title>
<f7-list>
  <f7-list-group>
    <f7-list-item title="A" group-title></f7-list-item>
    <f7-list-item title="Aaron "></f7-list-item>
    <f7-list-item title="Abbie"></f7-list-item>
    <f7-list-item title="Adam"></f7-list-item>
  </f7-list-group>
  <f7-list-group>
    <f7-list-item title="B" group-title></f7-list-item>
    <f7-list-item title="Bailey"></f7-list-item>
    <f7-list-item title="Barclay"></f7-list-item>
    <f7-list-item title="Bartolo"></f7-list-item>
  </f7-list-group>
  <f7-list-group>
    <f7-list-item title="C" group-title></f7-list-item>
    <f7-list-item title="Caiden"></f7-list-item>
    <f7-list-item title="Calvin"></f7-list-item>
    <f7-list-item title="Candy"></f7-list-item>
  </f7-list-group>
</f7-list>

Mixed and nested

<f7-block-title>Mixed and nested</f7-block-title>
<f7-list>
  <f7-list-item link="#" title="Ivan Petrov" after="CEO">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item link="#" title="Two icons here">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item title="No icons here"></f7-list-item>
  <li>
    <ul>
      <f7-list-item link="#" title="Ivan Petrov" after="CEO">
        <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
      </f7-list-item>
      <f7-list-item link="#" title="Two icons here">
        <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
        <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
      </f7-list-item>
      <f7-list-item title="No icons here"></f7-list-item>
      <f7-list-item link="#" title="Ultra long text goes here, no, it is really really long">
        <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
      </f7-list-item>
      <f7-list-item title="With toggle">
        <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
        <f7-toggle slot="after"></f7-toggle>
      </f7-list-item>
    </ul>
  </li>
  <f7-list-item link="#" title="Ultra long text goes here, no, it is really really long">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item title="With toggle">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
    <f7-toggle slot="after"></f7-toggle>
  </f7-list-item>
</f7-list>

Mixed, inset

<f7-block-title>Mixed, inset</f7-block-title>
<f7-list>
  <f7-list-item link="#" title="Ivan Petrov" after="CEO">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item link="#" title="Two icons here">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item link="#" title="Ultra long text goes here, no, it is really really long">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item title="With toggle">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
    <f7-toggle slot="after"></f7-toggle>
  </f7-list-item>
  <f7-block-footer>
    <p>Here comes some useful information about list above</p>
  </f7-block-footer>
</f7-list>

Tablet inset

<f7-block-title>Tablet inset</f7-block-title>
<f7-list tablet-inset>
  <f7-list-item link="#" title="Ivan Petrov" after="CEO">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item link="#" title="Two icons here">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-list-item link="#" title="Ultra long text goes here, no, it is really really long">
    <f7-icon slot="media" icon="demo-list-icon"></f7-icon>
  </f7-list-item>
  <f7-block-footer>
    <p>This list block will look like "inset" only on tablets (iPad)</p>
  </f7-block-footer>
</f7-list>

Media Lists

<f7-block-title>Media Lists</f7-block-title>
<f7-block>
  <p>Media Lists are almost the same as Data Lists, but with a more flexible layout for visualization of more complex data, like products, services, userc, etc.</p>
</f7-block>
<f7-block-title>Songs</f7-block-title>
<f7-list media-list>
  <f7-list-item
    link="#"
    title="Yellow Submarine"
    after="$15"
    subtitle="Beatles"
    text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sagittis tellus ut turpis condimentum, ut dignissim lacus tincidunt. Cras dolor metus, ultrices condimentum sodales sit amet, pharetra sodales eros. Phasellus vel felis tellus. Mauris rutrum ligula nec dapibus feugiat. In vel dui laoreet, commodo augue id, pulvinar lacus."
  >
    <img slot="media" src="https://cdn.framework7.io/placeholder/people-160x160-1.jpg" width="80" />
  </f7-list-item>
  <f7-list-item
    link="#"
    title="Don't Stop Me Now"
    after="$22"
    subtitle="Queen"
    text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sagittis tellus ut turpis condimentum, ut dignissim lacus tincidunt. Cras dolor metus, ultrices condimentum sodales sit amet, pharetra sodales eros. Phasellus vel felis tellus. Mauris rutrum ligula nec dapibus feugiat. In vel dui laoreet, commodo augue id, pulvinar lacus."
  >
    <img slot="media" src="https://cdn.framework7.io/placeholder/people-160x160-2.jpg" width="80" />
  </f7-list-item>
  <f7-list-item
    link="#"
    title="Billie Jean"
    after="$16"
    subtitle="Michael Jackson"
    text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sagittis tellus ut turpis condimentum, ut dignissim lacus tincidunt. Cras dolor metus, ultrices condimentum sodales sit amet, pharetra sodales eros. Phasellus vel felis tellus. Mauris rutrum ligula nec dapibus feugiat. In vel dui laoreet, commodo augue id, pulvinar lacus."
  >
    <img slot="media" src="https://cdn.framework7.io/placeholder/people-160x160-3.jpg" width="80" />
  </f7-list-item>
</f7-list>

Mail App

<f7-block-title>Mail App</f7-block-title>
<f7-list media-list>
  <f7-list-item
    link="#"
    title="Facebook"
    after="17:14"
    subtitle="New messages from John Doe"
    text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sagittis tellus ut turpis condimentum, ut dignissim lacus tincidunt. Cras dolor metus, ultrices condimentum sodales sit amet, pharetra sodales eros. Phasellus vel felis tellus. Mauris rutrum ligula nec dapibus feugiat. In vel dui laoreet, commodo augue id, pulvinar lacus."
  ></f7-list-item>
  <f7-list-item
    link="#"
    title="John Doe (via Twitter)"
    after="17:11"
    subtitle="John Doe (@_johndoe) mentioned you on Twitter!"
    text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sagittis tellus ut turpis condimentum, ut dignissim lacus tincidunt. Cras dolor metus, ultrices condimentum sodales sit amet, pharetra sodales eros. Phasellus vel felis tellus. Mauris rutrum ligula nec dapibus feugiat. In vel dui laoreet, commodo augue id, pulvinar lacus."
  ></f7-list-item>
  <f7-list-item
    link="#"
    title="Facebook"
    after="16:48"
    subtitle="New messages from John Doe"
    text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sagittis tellus ut turpis condimentum, ut dignissim lacus tincidunt. Cras dolor metus, ultrices condimentum sodales sit amet, pharetra sodales eros. Phasellus vel felis tellus. Mauris rutrum ligula nec dapibus feugiat. In vel dui laoreet, commodo augue id, pulvinar lacus."
  ></f7-list-item>
  <f7-list-item
    link="#"
    title="John Doe (via Twitter)"
    after="15:32"
    subtitle="John Doe (@_johndoe) mentioned you on Twitter!"
    text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sagittis tellus ut turpis condimentum, ut dignissim lacus tincidunt. Cras dolor metus, ultrices condimentum sodales sit amet, pharetra sodales eros. Phasellus vel felis tellus. Mauris rutrum ligula nec dapibus feugiat. In vel dui laoreet, commodo augue id, pulvinar lacus."
  ></f7-list-item>
</f7-list>

Something more simple

<f7-block-title>Something more simple</f7-block-title>
<f7-list media-list>
  <f7-list-item
    title="Yellow Submarine"
    subtitle="Beatles">
    <img slot="media" src="https://cdn.framework7.io/placeholder/fashion-88x88-1.jpg" width="44" />
  </f7-list-item>
  <f7-list-item
    link="#"
    title="Don't Stop Me Now"
    subtitle="Queen">
    <img slot="media" src="https://cdn.framework7.io/placeholder/fashion-88x88-2.jpg" width="44" />
  </f7-list-item>
  <f7-list-item
    title="Billie Jean"
    subtitle="Michael Jackson">
    <img slot="media" src="https://cdn.framework7.io/placeholder/fashion-88x88-3.jpg" width="44" />
  </f7-list-item>
</f7-list>

Inset

<f7-block-title>Inset</f7-block-title>
<f7-list media-list inset>
  <f7-list-item
    link="#"
    title="Yellow Submarine"
    subtitle="Beatles">
    <img slot="media" src="https://cdn.framework7.io/placeholder/fashion-88x88-4.jpg" width="44" />
  </f7-list-item>
  <f7-list-item
    link="#"
    title="Don't Stop Me Now"
    subtitle="Queen">
    <img slot="media" src="https://cdn.framework7.io/placeholder/fashion-88x88-5.jpg" width="44" />
  </f7-list-item>
  <f7-list-item
    link="#"
    title="Billie Jean"
    subtitle="Michael Jackson">
    <img slot="media" src="https://cdn.framework7.io/placeholder/fashion-88x88-6.jpg" width="44" />
  </f7-list-item>
</f7-list>