@jsamr/react-native-li
Version:
A pure JavaScript React Native component to render CSS3 compliant ordered and unordered lists.
27 lines (16 loc) • 1.26 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@jsamr/react-native-li](./react-native-li.md) > [useMarkedList](./react-native-li.usemarkedlist.md)
## useMarkedList() function
A hook to reuse MarkedList logic to render custom lists components in combination with [MarkedListItem()](./react-native-li.markedlistitem.md)<!-- -->.
<b>Signature:</b>
```typescript
export default function useMarkedList({ counterRenderer, startIndex, lineStyle, rtlLineReversed, rtlMarkerReversed, markerTextStyle, markerBoxStyle, dynamicMarkerBoxWidth, length, renderMarker, enableMarkerClipping, computeMarkerBoxWidth }: MarkedListProps & {
length: number;
}): Omit<MarkedListItemProps, 'index'>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| { counterRenderer, startIndex, lineStyle, rtlLineReversed, rtlMarkerReversed, markerTextStyle, markerBoxStyle, dynamicMarkerBoxWidth, length, renderMarker, enableMarkerClipping, computeMarkerBoxWidth } | [MarkedListProps](./react-native-li.markedlistprops.md) & { length: number; } | |
<b>Returns:</b>
Omit<[MarkedListItemProps](./react-native-li.markedlistitemprops.md)<!-- -->, 'index'>