@jsamr/react-native-li/docs/react-native-li.md

A pure JavaScript React Native component to render CSS3 compliant ordered and unordered lists.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@jsamr/react-native-li](./react-native-li.md)

## react-native-li package

## Functions

|  Function | Description |
|  --- | --- |
|  [MarkedList({ children, Container, ...props })](./react-native-li.markedlist.md) | A component which given a counter style, wraps each of its children with a [MarkedListItem()](./react-native-li.markedlistitem.md)<!-- -->. The latter prepends the child with a marker box containing a marker string representation for this child index.<!-- -->See [CSS Lists and Counters Module Level 3, Markers](https://www.w3.org/TR/css-lists-3/#markers)<!-- -->. |
|  [MarkedListItem({ counterRenderer, index, startIndex, rtlLineReversed, rtlMarkerReversed, markerTextStyle, markerBoxStyle, maxNumOfCodepoints, markerTextWidth, style, renderMarker, enableMarkerClipping, children })](./react-native-li.markedlistitem.md) | A component which reproduces CSS3 <code>display: list-item;</code> behavior. It prepends its child with a marker box containing a marker string representation for this child index.<!-- -->See [CSS Lists and Counters Module Level 3, Markers](https://www.w3.org/TR/css-lists-3/#markers)<!-- -->. |
|  [MarkerBox({ style, counterRenderer, counterIndex, markerTextStyle, markerTextWidth, enableMarkerClipping })](./react-native-li.markerbox.md) | Default component to render the list marker.<!-- -->See [CSS Lists and Counters Module Level 3, Markers](https://www.w3.org/TR/css-lists-3/#marker-pseudo) |
|  [useMarkedList({ counterRenderer, startIndex, lineStyle, rtlLineReversed, rtlMarkerReversed, markerTextStyle, markerBoxStyle, dynamicMarkerBoxWidth, length, renderMarker, enableMarkerClipping, computeMarkerBoxWidth })](./react-native-li.usemarkedlist.md) | A hook to reuse MarkedList logic to render custom lists components in combination with [MarkedListItem()](./react-native-li.markedlistitem.md)<!-- -->. |

## Interfaces

|  Interface | Description |
|  --- | --- |
|  [MarkedListProps](./react-native-li.markedlistprops.md) | Props for the [MarkedList()](./react-native-li.markedlist.md) component. |
|  [MarkerBoxProps](./react-native-li.markerboxprops.md) | Props for the [MarkerBox()](./react-native-li.markerbox.md) component. |

## Type Aliases

|  Type Alias | Description |
|  --- | --- |
|  [MarkedListItemProps](./react-native-li.markedlistitemprops.md) | Props for the [MarkedListItem()](./react-native-li.markedlistitem.md) component. |