List

Ordered or unordered <ul>/<ol> with plain-text markers.

import { List } from "@ps1ui/core";

Unordered

  • install the package
  • import the styles entry
  • wrap your tree in PS1Root
<List>
  <ListItem>install the package</ListItem>
  <ListItem>import the styles entry</ListItem>
  <ListItem>wrap your tree in PS1Root</ListItem>
</List>

Ordered

  1. parse the argv
  2. resolve the config
  3. dispatch the command
  4. write the exit code
<List ordered>
  <ListItem>parse the argv</ListItem>
  <ListItem>resolve the config</ListItem>
  <ListItem>dispatch the command</ListItem>
  <ListItem>write the exit code</ListItem>
</List>

Nested

  1. build the package
  2. run the checks
    1. typecheck
    2. unit tests
    3. visual regression
  3. publish
<List ordered>
  <ListItem>build the package</ListItem>
  <ListItem>
    run the checks
    <List ordered>
      <ListItem>typecheck</ListItem>
      <ListItem>unit tests</ListItem>
      <ListItem>visual regression</ListItem>
    </List>
  </ListItem>
  <ListItem>publish</ListItem>
</List>

Props

PropTypeDefaultDescription
orderedbooleanfalse

Render an <ol> with numbered markers instead of an <ul>.

All native <ul> attributes are also accepted.

All native <ol> attributes are also accepted except type.

ListItem Props

All native <li> attributes are also accepted.