Skip to content

Commit 42fc5c1

Browse files
feat: UNT-T20914: update readme
- Added compatibility note - Updated package.json version to 1.0.1
1 parent 6aa7a2a commit 42fc5c1

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,15 @@
22

33
# react-native-graph-kit
44

5-
[![react-native-graph-kit on npm](https://badgen.net/npm/v/react-native-graph-kit)](https://www.npmjs.com/package/react-native-graph-kit) [![react-native-graph-kit downloads](https://badgen.net/npm/dm/react-native-graph-kit)](https://www.npmtrends.com/react-native-graph-kit) [![react-native-reactions install size](https://packagephobia.com/badge?p=react-native-graph-kit)](https://packagephobia.com/result?p=react-native-graph-kit) [![Android](https://img.shields.io/badge/Platform-Android-green?logo=android)](https://www.android.com) [![iOS](https://img.shields.io/badge/Platform-iOS-green?logo=apple)](https://developer.apple.com/ios) [![MIT](https://img.shields.io/badge/License-MIT-green)](https://opensource.org/licenses/MIT)
5+
[![@shopify/react-native-skia](https://img.shields.io/badge/%40shopify%2Freact--native--skia-0.1.228-blue.svg?style=flat-square)](https://github.com/Shopify/react-native-skia)
6+
[![react-native-graph-kit on npm](https://img.shields.io/npm/v/react-native-graph-kit?style=flat-square&label=npm&color=blue)](https://www.npmjs.com/package/react-native-graph-kit) [![npm downloads](https://img.shields.io/npm/dm/react-native-graph-kit.svg?style=flat-square)](https://www.npmjs.com/package/react-native-graph-kit) [![Android](https://img.shields.io/badge/Platform-Android-green?logo=android&style=flat-square)](https://www.android.com) [![iOS](https://img.shields.io/badge/Platform-iOS-green?logo=apple&style=flat-square)](https://developer.apple.com/ios) [![MIT](https://img.shields.io/badge/License-MIT-green?style=flat-square)](https://opensource.org/licenses/MIT)
67

78
---
89

910
**React Native Graph Kit** is a powerful library that is built using @shopify/react-native-skia to provide LineChart and BarChart components with interactive tooltips for your React Native applications. With this library, you can effortlessly visualize your data in a clean and intuitive manner, making it easier than ever for users to understand complex datasets.
1011

12+
ℹ️ **Compatibility Notice:** This library is designed to work seamlessly with `@shopify/react-native-skia` version `<=0.1.228`. Make sure to use this version for optimal compatibility.
13+
1114
- It also provides an example app and a detailed usage overview of both the components.
1215
- Both the available components are fully Android and iOS compatible.
1316

@@ -174,7 +177,7 @@ export default App;
174177
| Prop | Default | Type | Description | BarChart | LineChart |
175178
| :---------------------- | :---------- | :------------ | :--------------------------------------------------- | -------- | --------- |
176179
| **chartData\*** | null | ChartDataType | Data to plot graphs | ✔️ | ✔️ |
177-
| chartHeight | 500 | number | Hight of chart in BarChart | ✔️ ||
180+
| chartHeight | 500 | number | Height of chart in BarChart | ✔️ ||
178181
| showLines | true | boolean | Control visibility of Y Axis Ref lines on the chart | ✔️ | ✔️ |
179182
| lineHeight | 2 | number | Height of horizontal grid lines in BarChart | ✔️ ||
180183
| lineWidth | 3 | number | The line width value of LineChart || ✔️ |
@@ -210,7 +213,7 @@ export default App;
210213
| toolTipColor | #FF0000 | string | Tooltip color | ✔️ | ✔️ |
211214
| toolTipDataColor | #FFFFFF | string | Tooltip data color | ✔️ | ✔️ |
212215
| toolTipHorizontalPadding | 20 | number | Tooltip padding | ✔️ | ✔️ |
213-
| toolTipFadeOutDuration | 4000 | number | Duration is ms to fade out tooltip | ✔️ | ✔️ |
216+
| toolTipFadeOutDuration | 4000 | number | Duration in ms to fade out tooltip | ✔️ | ✔️ |
214217
| circularPointerColor | #000000 | string | Color of circular pointer for LineChart || ✔️ |
215218

216219
---

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-native-graph-kit",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "Personalized graphs featuring customizable options for React Native app",
55
"main": "lib/index",
66
"types": "lib/index.d.ts",

0 commit comments

Comments
 (0)