react-native-marked 1.1.6 → 1.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
# react-native-marked
|
|
2
2
|
|
|
3
|
+
[](https://github.com/gmsgowtham/react-native-marked/blob/main/LICENSE)
|
|
3
4
|
[](https://github.com/gmsgowtham/react-native-marked/actions/workflows/build.yml)
|
|
5
|
+
[](https://coveralls.io/github/gmsgowtham/react-native-marked?branch=main)
|
|
6
|
+
|
|
7
|
+
|
|
4
8
|
|
|
5
9
|
Markdown renderer for React Native powered by [marked.js](https://marked.js.org/) with built-in theming support
|
|
6
10
|
|
|
@@ -31,8 +35,17 @@ export default ExampleComponent;
|
|
|
31
35
|
```
|
|
32
36
|
|
|
33
37
|
## Example
|
|
38
|
+
|
|
34
39
|
https://snack.expo.dev/@gmsgowtham/react-native-marked
|
|
35
40
|
|
|
41
|
+
## [Props](https://github.com/gmsgowtham/react-native-marked/blob/4ef070931b7d309a7490c41e45129e12525d12d9/src/lib/types.ts#L18)
|
|
42
|
+
|
|
43
|
+
| Prop | Description | Type | Optional? |
|
|
44
|
+
| ------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------- |
|
|
45
|
+
| value | Markdown value | string | false |
|
|
46
|
+
| flatListProps | Props for customizing the underlying FlatList used | `Omit<FlatListProps<ReactNode>, 'data' \| 'renderItem' \| 'horizontal'>`<br><br><br>(`'data'`, `'renderItem'`, and `'horizontal'` props are omitted and cannot be overridden.) | true |
|
|
47
|
+
| styles | Styles for parsed components | [MarkedStyles](https://github.com/gmsgowtham/react-native-marked/blob/4ef070931b7d309a7490c41e45129e12525d12d9/src/theme/types.ts#L3) | true |
|
|
48
|
+
|
|
36
49
|
## Screenshots
|
|
37
50
|
|
|
38
51
|
| Dark Theme | Light Theme |
|