@navinc/base-react-components/src/list.readme.md

Nav's Pattern Library

# List

```
<UnorderedList>
    <ListItem bold>First Li Child</ListItem>
    <ListItem light>Second Li Child</ListItem>
    <ListItem size="sm">Third Li Child</ListItem>
</UnorderedList>

```

UnorderedList - `<ul>` bulleted list
OrderedList - `<ol>` numbered list

It is recommended to use the `ListItem` component as the li child of `UnorderedList` and `OrderedList`

# ListItem

```
    <ListItem bold>First Li Child</ListItem>
```

The `ListItem` component uses the nav's styleguide for styling the html `li` element.

## Props

### `bold`

The `bold` is a boolean prop for adjusting the weight of the `li`

### `light`

The `light` is a boolean prop for adjusting the weight of the `li`

### `size`

The `size` adjusts the font-size of the `li` options are `md`, `sm`, `xs` and `xxs`