@invisionag/iris-react-list
TypeScript icon, indicating that this package has built-in type declarations

3.6.2 • Public • Published
import { UnorderedList, ListItem } from '@invisionag/iris-react-list';

#DEPRECATED

A basic list component for unordered lists.

Usage

<UnorderedList>
  <ListItem>Bullet Point Text 1</ListItem>
  <ListItem>Bullet Point Text 2</ListItem>
  <ListItem>Bullet Point Text 3</ListItem>
</UnorderedList>

Props

icon

When passed a string, it is used to set an iris icon as bullet point

<UnorderedList icon="check circle">
  <ListItem>Bullet Point Text 1</ListItem>
  <ListItem>Bullet Point Text 2</ListItem>
  <ListItem>Bullet Point Text 3</ListItem>
</UnorderedList>

When passed a react element, the element is rendered as icon

<UnorderedList icon={() => <MyCustomIcon />}>
  <ListItem>Bullet Point Text 1</ListItem>
  <ListItem>Bullet Point Text 2</ListItem>
  <ListItem>Bullet Point Text 3</ListItem>
</UnorderedList>

It is advisable to base the custom icon on the default BulletPoint component, so native styles are extended instead of overwritten. Examples can be found in the story and test files of this component.

Readme

Keywords

none

Package Sidebar

Install

npm i @invisionag/iris-react-list

Weekly Downloads

38

Version

3.6.2

License

MIT

Unpacked Size

19.6 kB

Total Files

11

Last publish

Collaborators

  • bgoeral
  • jj-ivx
  • ivx-github
  • jana_hehr
  • roberter26
  • birgithorn
  • alexj-ivx
  • amft
  • aitortomas
  • yashabfaryal0322
  • nleinich
  • johannesluedke
  • pgotthardt-ivx
  • hrabe
  • plore_ivx
  • patricialieske
  • plaudel
  • mblumtritt
  • sruehlemann
  • brerx
  • mbrendler
  • jens.zobel
  • cwaider
  • kattelans
  • ftrautmann
  • lutz.peukert
  • fruetel
  • schmitze333
  • csprle
  • beckerei
  • stefan.schiffer
  • ahx
  • cloudwaechter
  • tobias
  • alexmarold
  • t_klepzig
  • susahope
  • mwannewitz
  • ivx-circle-ci
  • yichang
  • ivx-jenkins