@jsamr/react-native-li
Version:
A pure JavaScript React Native component to render CSS3 compliant ordered and unordered lists.
32 lines (23 loc) • 2.85 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) > [MarkedListProps](./react-native-li.markedlistprops.md)
## MarkedListProps interface
Props for the [MarkedList()](./react-native-li.markedlist.md) component.
<b>Signature:</b>
```typescript
export interface MarkedListProps
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [computeMarkerBoxWidth?](./react-native-li.markedlistprops.computemarkerboxwidth.md) | (maxCodepointsLengthInRange: number, fontSize: number) => number | <i>(Optional)</i> A function to compute marker box width depending on the maximum length of the marker string in range. |
| [Container?](./react-native-li.markedlistprops.container.md) | ComponentType<any> | <i>(Optional)</i> The component used to wrap list elements. |
| [counterRenderer](./react-native-li.markedlistprops.counterrenderer.md) | CounterStyleRenderer | The counter renderer for this list. |
| [dynamicMarkerBoxWidth?](./react-native-li.markedlistprops.dynamicmarkerboxwidth.md) | boolean | <i>(Optional)</i> Should the width of the marker box be computed dynamically, e.g. depend on the longest marker in the list? |
| [enableMarkerClipping?](./react-native-li.markedlistprops.enablemarkerclipping.md) | boolean | <i>(Optional)</i> Clip the marker text when it overflows the marker box. |
| [lineStyle?](./react-native-li.markedlistprops.linestyle.md) | StyleProp<ViewStyle> | <i>(Optional)</i> Style for the line wrapper. |
| [markerBoxStyle?](./react-native-li.markedlistprops.markerboxstyle.md) | StyleProp<ViewStyle> | <i>(Optional)</i> Style for the marker box container. |
| [markerTextStyle?](./react-native-li.markedlistprops.markertextstyle.md) | TextStyle | <i>(Optional)</i> A plain JavaScript object text style for the marker string. It is advised to pass the same <code>fontSize</code> and <code>lineHeight</code> as the list content for perfect horizontal alignment. |
| [renderMarker?](./react-native-li.markedlistprops.rendermarker.md) | (props: [MarkerBoxProps](./react-native-li.markerboxprops.md)<!-- -->) => ReactNode | <i>(Optional)</i> A custom Marker render function. |
| [rtlLineReversed?](./react-native-li.markedlistprops.rtllinereversed.md) | boolean | <i>(Optional)</i> Set the line layout in <code>flexDirection: 'row-reverse'</code> and left-align the marker box. |
| [rtlMarkerReversed?](./react-native-li.markedlistprops.rtlmarkerreversed.md) | true \| false \| RtlOptions | <i>(Optional)</i> Should the marker string be rendered in reverse order? |
| [startIndex?](./react-native-li.markedlistprops.startindex.md) | number | <i>(Optional)</i> The index for the first item in the list. Negative indexes are supported. |