National Palace Museum

    @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.

    Keywords

    none

    Install

    npm i @invisionag/iris-react-list

    DownloadsWeekly Downloads

    39

    Version

    3.6.2

    License

    MIT

    Unpacked Size

    19.6 kB

    Total Files

    11

    Last publish

    Collaborators

    • arminlandscheidt_invision
    • plore_ivx
    • alexanderrothe
    • patricialieske
    • mister_what
    • j-foley
    • plaudel
    • ahinv
    • mblumtritt
    • spaceneedle2019
    • sruehlemann
    • brerx
    • mohamedmmahfouz
    • mbrendler
    • jens.zobel
    • cwaider
    • kattelans
    • ftrautmann
    • lutz.peukert
    • leander-karp
    • fruetel
    • schmitze333
    • csprle
    • beckerei
    • stefan.schiffer
    • ahx
    • cloudwaechter
    • tobias
    • jana_hehr
    • alexmarold
    • t_klepzig
    • joshuajaco
    • susahope
    • mwannewitz
    • drogglbecher
    • ivx-circle-ci
    • yichang
    • ivx-jenkins