mui-swipeable-list-item
TypeScript icon, indicating that this package has built-in type declarations

0.3.2 • Public • Published

mui-swipeable-list-item

This is SwipeableListItem based on Material-UI (https://github.com/mui-org/material-ui), this package adds the functionality of swipe left and right for the Material-UI ListItem Component.

Storybook.

Component props
Prop Description Default
avatar This prop is optional if exists will render the ListItemAvatar following the [material-ui examples](https://material-ui.com/components/lists/) undefined
background
  {
    actionIconLeft: This prop is required and will define the Icon showed when swipe left,
    actionIconRight: This prop is required and will define the Icon showed when swipe right,
    backgroundColorLeft: This prop is required and will define the color when swipe left,
    backgroundColorRight: This prop is required and will define the color when swipe right,
  }
        
Prop required
disableDeleteAnimation If true will disable the dismiss animation false
itemIcon This prop is optional if exists will render the ListItemIcon before the ListItemText following the [material-ui examples](https://material-ui.com/components/lists/) undefined
ListItemAvatarProps This prop is optional and will spread all props from [ListItemAvatar API](https://material-ui.com/api/list-item-avatar/) undefined
ListItemIconProps This prop is optional and will spread all props from [ListItemIcon API](https://material-ui.com/api/list-item-icon/) undefined
ListItemProps This prop is optional and will spread all props from [ListItem API](https://material-ui.com/api/list-item//) undefined
ListItemSecondaryActionProps This prop is optional and will spread all props from [ListItemSecondaryAction API](https://material-ui.com/api/list-item-secondary-action/) undefined
ListItemTextProps This prop is optional and will spread all props from [ListItemText API](https://material-ui.com/api/list-item-text/) undefined
onSwipedLeft Callback executed when Swipe left undefined
onSwipedRight Callback executed when Swipe right undefined
primaryText String or Component for primary prop from ListItemText undefined
secondaryAction This prop is optional and receive a Component to be rendered inside the ListItemSecondaryAction undefined
secondaryText String or Component for secondary prop from ListItemText undefined
threshold The fraction of width (range between 0 - 1) needed to execute the action callback 0.3

Package Sidebar

Install

npm i mui-swipeable-list-item

Weekly Downloads

2

Version

0.3.2

License

MIT

Unpacked Size

22.5 kB

Total Files

6

Last publish

Collaborators

  • vagnernico