List Button React Component

List Button React component represents Framework7's List Button element. They are intended to be used inside of the List React Component.

List Button Components

There are following components included:

ListButton

List Button Properties

Prop	Type	Default	Description
title	string		Button inner text
text	string		Button inner text, same as `title`
tabLink	string/boolean		Enables tab link and specify CSS selector of the target tab (if specified as a string)
tabLinkActive	boolean		Makes this tab link active
target	string		Link target attribute
tooltip	string		List button tooltip text to show on button hover/press
tooltipTrigger	string	hover	Defines how to trigger (open) Tooltip. Can be `hover`, `click` or `manual`
<ListButton> navigation/router related properties
href	string boolean	#	URL of the page to load. In case of boolean `href="false"` it won't add `href` tag
target	string		Value of link target attribute, e.g. `_blank`, `_self`, etc.
view	string		CSS selector of the View to load the page. Or `current` to load in current view.
external	boolean		Enable to bypass Framework7's link click handler
back	boolean		Enables back navigation link
openIn	string		Allows open page route as modal or panel. Can be `popup`, `loginScreen`, `sheet`, `popover` or `panel`
force	boolean		Force page to load and ignore previous page in history (use together with `back` prop)
reloadCurrent	boolean		Reloads new page instead of the currently active one
reloadPrevious	boolean		Replace the previous page in history with the new one from route
reloadAll	boolean		Load new page and remove all previous pages from history and DOM
reloadDetail	boolean		Reload Detail page in Master Detail view
animate	boolean		Disables pages animation
transition	string		Name of the custom page transition
ignoreCache	boolean		Ignores caching
routeTabId	string		Routable Tab id
routeProps	object		Object with additional props that will be passed to target route component
preventRouter	boolean	false	If set, then it won't be processed by Framework7 router
<ListButton> action related properties
panelOpen	string boolean		CSS selector of panel to open on click. Or can be `left` or `right` if there is only left or right panel in DOM.
panelClose	string boolean		Closes panel on click
panelToggle	string boolean		CSS selector of panel to toggle on click. Or can be `left` or `right` if there is only left or right panel in DOM.
actionsOpen	string boolean		CSS selector of the action sheet to open on click
actionsClose	string boolean		CSS selector of the action sheet to close on click. Or boolean property to close currently opened action sheet
popupOpen	string boolean		CSS selector of the popup to open on click
popupClose	string boolean		CSS selector of the popup to close on click. Or boolean property to close currently opened popup
popoverOpen	string boolean		CSS selector of the popover to open on click
popoverClose	string boolean		CSS selector of the popover to close on click. Or boolean property to close currently opened popover
sheetOpen	string boolean		CSS selector of the sheet modal to open on click
sheetClose	string boolean		CSS selector of the sheet modal to close on click. Or boolean property to close currently opened sheet modal
loginScreenOpen	string boolean		CSS selector of the login screen to open on click
loginScreenClose	string boolean		CSS selector of the login screen to close on click. Or boolean property to close currently opened login screen
sortableEnable	string boolean		CSS selector of the Sortable list to be enabled on click
sortableDisable	string boolean		CSS selector of the Sortable list to be disabled on click. Or boolean property to close currently opened Sortable list
sortableToggle	string boolean		CSS selector of the Sortable list to toggle on click. Or boolean property to toggle currently opened/closed Sortable list
searchbarEnable	string boolean		CSS selector of the Expandable Searchbar to be enabled on click. Or boolean property to enable the first found Searchbar
searchbarDisable	string boolean		CSS selector of the Expandable Searchbar to be disabled on click. Or boolean property to disable the first found Searchbar
searchbarToggle	string boolean		CSS selector of the Expandable Searchbar to toggle on click. Or boolean property to toggle the first found Searchbar
searchbarClear	string boolean		CSS selector of the Expandable Searchbar to clear on click. Or boolean property to clear the first found Searchbar
cardOpen	string boolean		CSS selector of the expandable card to open on click. Or boolean to open first found expandable card
cardClose	string boolean		CSS selector of the expandable card to close on click. Or boolean property to close currently opened expandable card
cardPreventOpen	boolean		Click on element with this prop won't open its parent expandable card

List Button Events

Event	Description
<ListButton> events
click	Event will be triggered after click on a button

Examples

list-button.jsx

import React from 'react';
import { Navbar, Page, List, ListButton } from 'framework7-react';

export default () => {
  return (
    <Page>
      <Navbar title="List Button" />

      <List inset strong>
        <ListButton title="List Button 1" />
        <ListButton title="List Button 2" />
        <ListButton title="List Button 3" />
      </List>
      <List inset strong>
        <ListButton title="Large Red Button" color="red" />
      </List>
    </Page>
  );
};

Improve this Doc

On this page

List Button Components
List Button Properties
List Button Events
Examples