react-native-wagmi-charts
Version:
A sweet candlestick chart for React Native
1,115 lines (877 loc) ā¢ 59.4 kB
Markdown
# react-native-wagmi-charts šø
A sweet & simple chart library for React Native that will make us feel like
**W**e're **A**ll **G**onna **M**ake **I**t
<div style="display: flex; align-items: center; justify-content: center; width: 100%;">
<img src="https://user-images.githubusercontent.com/7336481/133024970-07321941-4f26-44d2-867f-dac19d110941.gif" width="300px" />
<img src="https://user-images.githubusercontent.com/7336481/133024976-3dc9056c-d936-439a-af41-57cbf9277a01.gif" width="300px" />
</div>
## Features
š Line charts & candlestick charts (more to come š)
š· Interactive price & date/time label components
š§± Built with composability in mind
š Highly customizable APIs
āØ Uses React Native Reanimated 2 under-the-hood
š§ Slick data transition animations
š¬ Interactive tooltips
## Table of Contents
- [Features](#features)
- [Table of Contents](#table-of-contents)
- [Install](#install)
- [Basic Usage](#basic-usage)
- [Line chart](#line-chart)
- [Candlestick chart](#candlestick-chart)
- [Line Chart Guides](#line-chart-guides)
- [Interactive cursors](#interactive-cursors)
- [Interactive labels](#interactive-labels)
- [Interactive tooltips](#interactive-tooltips)
- [Tooltips / labels](#tooltips--labels)
- [Haptic feedback](#haptic-feedback)
- [Colors](#colors)
- [Gradients](#gradients)
- [Dots](#dots)
- [Horizontal lines](#horizontal-lines)
- [Customizing size](#customizing-size)
- [Customizing labels](#customizing-labels)
- [Customizing tooltips](#customizing-tooltips)
- [Axis](#axis)
- [Candlestick Chart Guides](#candlestick-chart-guides)
- [Interactive cursors](#interactive-cursors-1)
- [Interactive labels](#interactive-labels-1)
- [Interactive tooltips](#interactive-tooltips-1)
- [Haptic feedback](#haptic-feedback-1)
- [Colors](#colors-1)
- [Customizing labels](#customizing-labels-1)
- [Component APIs](#component-apis)
- [LineChart.Provider](#linechartprovider)
- [LineChart](#linechart)
- [LineChart.Path](#linechartpath)
- [LineChart.CursorCrosshair](#linechartcursorcrosshair-1)
- [LineChart.CursorLine](#linechartcursorline-1)
- [LineChart.Dot](#linechartdot)
- [LineChart.Highlight](#linechartdot)
- [LineChart.HorizontalLine](#linecharthorizontalline)
- [LineChart.Gradient](#linechartgradient)
- [LineChart.Tooltip](#linecharttooltip)
- [LineChart.PriceText](#linechartpricetext)
- [LineChart.DatetimeText](#linechartdatetimetext)
- [LineChart.HoverTrap](#linecharthovertrap)
- [CandlestickChart.Provider](#candlestickchartprovider)
- [CandlestickChart](#candlestickchart)
- [CandlestickChart.Candles](#candlestickchartcandles)
- [CandlestickChart.Crosshair](#candlestickchartcrosshair)
- [CandlestickChart.Tooltip](#candlestickcharttooltip)
- [CandlestickChart.PriceText](#candlestickchartpricetext)
- [CandlestickChart.DatetimeText](#candlestickchartdatetimetext)
- [Hooks](#hooks)
- [LineChart.useChart](#linechartusechart)
- [LineChart.useDatetime](#linechartusedatetime)
- [LineChart.usePrice](#linechartuseprice)
- [CandlestickChart.useChart](#candlestickchartusechart)
- [CandlestickChart.useCandleData](#candlestickchartusecandledata)
- [CandlestickChart.useDatetime](#candlestickchartusedatetime)
- [CandlestickChart.usePrice](#candlestickchartuseprice)
- [Web Support](#web-support)
- [Credits](#credits)
## Install
To get started with using WAGMI charts in your React Native project, install the
`react-native-wagmi-charts` package.
```bash
npm install react-native-wagmi-charts
```
WAGMI charts also depends on a few libraries, you will also need to install
these packages if you don't already have them:
```bash
npm install react-native-reanimated react-native-gesture-handler react-native-haptic-feedback
```
## Basic Usage
The library currently comes with 2 types of charts: Line & Candlestick. Below
are the most basic usages of them.
### Line chart
To render a simple line chart, you will need to use the `LineChart.Provider`,
`LineChart` & `LineChart.Path` components.
The `LineChart.Provider` component sets up the context of your chart,
`LineChart` composes the chart elements, and the `LineChart.Path` component
renders your data in the form of a line path.
> Note: This chart does not include an interactive cursor like in the animated
> example above. If you want one,
> [check out the "Interactive Cursors" guide](#interactive-cursors)
```jsx
import { LineChart } from 'react-native-wagmi-charts';
const data = [
{
timestamp: 1625945400000,
value: 33575.25,
},
{
timestamp: 1625946300000,
value: 33545.25,
},
{
timestamp: 1625947200000,
value: 33510.25,
},
{
timestamp: 1625948100000,
value: 33215.25,
},
];
function Example() {
return (
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path />
</LineChart>
</LineChart.Provider>
);
}
```
### Candlestick chart
To render a simple candlestick chart, you will need to use the
`CandlestickChart` & `CandlestickChart.Candles` components.
The `CandlestickChart.Provider` component sets up the context of your chart,
`CandlestickChart` composes the chart elements, and the
`CandlestickChart.Candles` component renders your data in the form of a line
path.
> Note: This chart does not include an interactive cursor like in the animated
> example above. If you want one,
> [check out the "Interactive Cursors" guide](#interactive-cursors)
```jsx
import { CandlestickChart } from 'react-native-wagmi-charts';
const data = [
{
timestamp: 1625945400000,
open: 33575.25,
high: 33600.52,
low: 33475.12,
close: 33520.11,
},
{
timestamp: 1625946300000,
open: 33545.25,
high: 33560.52,
low: 33510.12,
close: 33520.11,
},
{
timestamp: 1625947200000,
open: 33510.25,
high: 33515.52,
low: 33250.12,
close: 33250.11,
},
{
timestamp: 1625948100000,
open: 33215.25,
high: 33430.52,
low: 33215.12,
close: 33420.11,
},
];
function Example() {
return (
<CandlestickChart.Provider data={data}>
<CandlestickChart>
<CandlestickChart.Candles />
</CandlestickChart>
</CandlestickChart.Provider>
);
}
```
## Line Chart Guides
Below are some line chart guides to help you make your charts suit your brand.
Hopefully a combination of the below will enable you to make a great chart! :-)
### Interactive cursors
To render an interactive cursor on your line chart, you can include either the
`LineChart.CursorCrosshair` or `LineChart.CursorLine` components:
##### `LineChart.CursorCrosshair`
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path />
<LineChart.CursorCrosshair />
</LineChart>
</LineChart.Provider>
```
<img src="https://user-images.githubusercontent.com/7336481/133027332-009b8996-4141-4865-bfd6-777e63b5e44d.gif" width="200px" />
##### `LineChart.CursorLine`
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path />
<LineChart.CursorLine />
</LineChart>
</LineChart.Provider>
```
<img src="https://user-images.githubusercontent.com/7336481/133027471-1c620ece-a95e-46b7-bd92-50f33757ce92.gif" width="200px" />
### Interactive labels
To render an interactive label on your line chart as your cursor moves along
the graph, you can use the `PriceText` or `DatetimeText` components:
> Note: These components **must** be within the `LineChart.Provider` component.
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path />
<LineChart.CursorCrosshair />
</LineChart>
<LineChart.PriceText />
<LineChart.DatetimeText />
</LineChart.Provider>
```
<img src="https://user-images.githubusercontent.com/7336481/133028134-a0b65499-9edf-4535-9fcc-fcf8c1e4e0c4.gif" width="200px" />
### Interactive tooltips
To render an interactive tooltip that follows your cursor, you can use the
`Tooltip` component.
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path />
<LineChart.CursorCrosshair>
<LineChart.Tooltip />
</LineChart.CursorCrosshair>
</LineChart>
</LineChart.Provider>
```
<img src="https://user-images.githubusercontent.com/7336481/133035626-a58b0258-e720-40b5-902b-522b2430b254.gif" width="200px" />
You can even add another tooltip to show something like date/time:
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path />
<LineChart.CursorCrosshair>
<LineChart.Tooltip />
<LineChart.Tooltip position="bottom">
<LineChart.DatetimeText />
</LineChart.Tooltip>
</LineChart.CursorCrosshair>
</LineChart>
</LineChart.Provider>
```
<img src="https://user-images.githubusercontent.com/7336481/133036011-8a9b4865-10dd-4e88-9fd1-1e109435a73c.gif" width="200px" />
### Tooltips / Labels
You can also use the `Tooltip` component to render a "static" tooltip at a
given index, by specifying the `at` prop (similar to [Dots](#dots)). Note that
the tooltip will disappear when there is interaction with a cursor on the
chart.
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path>
<LineChart.Tooltip at={3} />
</LineChart.Path>
</LineChart>
</LineChart.Provider>
```
<img src="https://user-images.githubusercontent.com/16821682/157064279-c0923a60-edf8-4942-a029-0145dd225d3f.gif" width="200px" />
### Haptic feedback
By making use of the chart event handlers, you are able to integrate haptic
feedback into your charts.
We can utilise the `onActivated` and `onEnded` events to create haptic feedback
on our line chart. This will cause a vibration on touch down/up.
```jsx
import * as haptics from 'expo-haptics';
const data = [...];
function invokeHaptic() {
haptics.impactAsync(haptics.ImpactFeedbackStyle.Light);
}
function Example() {
return (
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path />
<LineChart.CursorCrosshair onActivated={invokeHaptic} onEnded={invokeHaptic}>
<LineChart.Tooltip />
</LineChart.CursorCrosshair>
</LineChart>
</LineChart.Provider>
)
}
```
We can also use the `onCurrentIndexChange` callback, passed to
`LineChart.Provider`. This differs to the above method as it will cause a
vibration on touch down/up and also when the selected value changes.
```tsx
import * as haptics from 'expo-haptics';
const data = [...];
function invokeHaptic() {
haptics.impactAsync(haptics.ImpactFeedbackStyle.Light);
}
function Example() {
return (
<LineChart.Provider data={data} onCurrentIndexChange={invokeHaptic}>
<LineChart>
<LineChart.Path />
<LineChart.CursorCrosshair>
<LineChart.Tooltip />
</LineChart.CursorCrosshair>
</LineChart>
</LineChart.Provider>
)
}
```
If you want to synchronize two graphs, or even initialize a new graph with a
cursor position, you can use the `at` prop:
```tsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path />
<LineChart.CursorLine at={Math.floor(data.length / 2)} />
</LineChart>
</LineChart.Provider>
```
### Colors
By default, the charts come with default colors out-of-the-box... But you
probably will want to change these to suit your brand.
#### Coloring the path
To customise the color of the line chart path, supply a `color` prop to
`LineChart.Path`. This can be any valid React Native `StyleSheet` compatible
color.
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path color="hotpink" />
</LineChart>
</LineChart.Provider>
```
<img src="https://user-images.githubusercontent.com/7336481/133037040-ce13ba5b-6ee5-45a2-ba14-18bf12e13746.png" width="200px" />
#### Coloring the cursor
To customise the color of the line chart cursor, supply a `color` prop to
`LineChart.CursorCrosshair`. This can be any valid React Native `StyleSheet`
compatible color.
> Note: This also works for `LineChart.CursorLine`
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path color="hotpink" />
<LineChart.CursorCrosshair color="hotpink" />
</LineChart>
</LineChart.Provider>
```
<img width="200px" alt="Screen Shot 2021-09-13 at 4 53 46 pm" src="https://user-images.githubusercontent.com/7336481/133037333-6b1345e5-a98b-459c-b3b1-6e5b08143f33.png">
#### Hovering the chart
By default, the cursor is triggered whenever you press the chart.
If your app runs on Web, you may want to trigger the cursor when a user hovers,
too. To achieve this, simply add `<LineChart.HoverTrap />` as the child of your
cursor.
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path color="hotpink" />
<LineChart.CursorCrosshair color="hotpink">
<LineChart.HoverTrap />
</LineChart.CursorCrosshair>
</LineChart>
</LineChart.Provider>
```
### Gradients
By using the `LineChart.Gradient` component, you can apply a gradient to the
area underneath your path.
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path color="red">
<LineChart.Gradient />
</LineChart.Path>
</LineChart>
</LineChart.Provider>
```
<img width="346" alt="Screen Shot 2021-10-25 at 8 32 07 pm" src="https://user-images.githubusercontent.com/7336481/138672128-c691036e-404f-4148-8a3b-00ea2f7df27f.png">
The gradient will inherit your path's color by default, however, you can
provide a color prop to `LineChart.Gradient`.
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path color="red">
<LineChart.Gradient color="black" />
</LineChart.Path>
</LineChart>
</LineChart.Provider>
```
<img width="345" alt="Screen Shot 2021-10-25 at 8 32 26 pm" src="https://user-images.githubusercontent.com/7336481/138672153-9ba11b02-b750-4ab0-a2e2-c18a9af4635f.png">
### Dots
You can render dots on your line chart with `LineChart.Dot`.
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path>
<LineChart.Dot color="red" at={10} />
</LineChart.Path>
</LineChart>
</LineChart.Provider>
```
<img width="153" alt="Screen Shot 2021-11-23 at 11 15 23 am" src="https://user-images.githubusercontent.com/7336481/143009734-04aa3be6-8737-4dae-8202-98ac738f127b.png">
Your dot can also have an animated pulse by passing the `hasPulse` prop.
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path>
<LineChart.Dot color="red" at={10} hasPulse />
</LineChart.Path>
</LineChart>
</LineChart.Provider>
```
### Path highlighting
You can highlight a section of your path with `LineChart.Highlight`.
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path>
<LineChart.Highlight color="red" from={10} to={15} />
</LineChart.Path>
</LineChart>
</LineChart.Provider>
```
<img width="345" alt="Screen Shot 2021-11-23 at 11 54 02 am" src="https://user-images.githubusercontent.com/7336481/143009637-03b227e4-c36b-43d8-bdc0-8b73a15b126b.png">
### Horizontal lines
You can render a static horizontal line on your line chart which moves whenever
your data change. In this example, the y value of the line is equal to the y
value of the point at index `0`.
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path>
<LineChart.HorizontalLine at={{ index: 0 }} />
</LineChart.Path>
</LineChart>
</LineChart.Provider>
```
<img width="345" alt="Screen Shot 2021-11-23 at 11 51 45 am" src="https://user-images.githubusercontent.com/7336481/143009672-54dac2c7-7de1-4299-a96f-7cc380e82b46.png">
You can also directly specify the y value of the `HorizontalLine` with the
`value` attribute:
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path>
<LineChart.HorizontalLine at={{ value: 3027.84 }} />
</LineChart.Path>
</LineChart>
</LineChart.Provider>
```
### Customizing size
You can modify the width & height of the charts by providing `width` and
`height` props to `LineChart` or `CandlestickChart`. Your chart should adapt
to it's size.
```jsx
<LineChart.Provider data={data}>
<LineChart width={150} height={150}>
<LineChart.Path />
</LineChart>
</LineChart.Provider>
```
### Customizing labels
#### Price labels
##### Precision
By default, the price labels have a precision of `2`, meaning that the prices
will always be to 2 decimal places. However, you can customize this with the
`precision` prop:
```jsx
<LineChart.PriceText precision={4} />
```
##### Custom formatting
To customize the formatting of the price text, you can supply a `format`
function in the form of a
[reanimated worklet](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/worklets):
> Note: due to the nature of reanimated worklets, you cannot define functions
> that run on the React Native JS thread.
> [Read more here](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/worklets)
```jsx
<LineChart.PriceText
format={({ value }) => {
'worklet';
const formattedPrice = yourOwnFormatValueFn(value);
return `$${formattedPrice} AUD`;
}}
/>
```
#### Datetime labels
##### Date/time options
Internally, WAGMI charts uses
[`Date.prototype.toLocaleString()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleString)
to generate the date/time label. You can customise it's options like so:
```jsx
<LineChart.DatetimeText
locale="en-AU"
options={{
year: 'numeric',
month: 'numeric',
day: 'numeric',
hour: 'numeric',
minute: 'numeric',
second: 'numeric',
}}
/>
```
##### Custom formatting
To customize the formatting of the date/time text, you can supply a `format`
function in the form of a
[reanimated worklet](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/worklets):
> Note: due to the nature of reanimated worklets, you cannot define functions
> that run on the React Native JS thread.
> [Read more here](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/worklets)
```jsx
<LineChart.DatetimeText
format={({ value }) => {
'worklet';
const formattedDate = yourOwnFormatValueFn(value);
return formattedDate;
}}
/>
```
### Customizing tooltips
#### Style
You can customize the style of the tooltip by providing the `textStyle` prop:
```jsx
<LineChart.Tooltip
textStyle={{
backgroundColor: 'black',
borderRadius: 4,
color: 'white',
fontSize: 18,
padding: 4,
}}
/>
```
<img src="https://user-images.githubusercontent.com/7336481/133053224-88ac9462-dd61-4070-a541-d1e6168f579e.gif" width="200px" />
#### Gutter
You can customize the gutters of the tooltip by providing `cursorGutter`,
`xGutter` or `yGutter`.
`cursorGutter` is the gutter between the cursor and the tooltip.
`xGutter` and `yGutter` is the gutter on the x & y axis of the chart (the
tooltip can't pass the gutter).
```jsx
<LineChart.Tooltip cursorGutter={60} xGutter={16} yGutter={16} />
```
<img src="https://user-images.githubusercontent.com/7336481/133054393-28d542c1-c9fc-4ba6-b4a0-86cf096ebcda.gif" width="200px" />
### Axis
You can render an axis on your line chart with `LineChart.Axis`.
```jsx
<LineChart.Provider data={data}>
<LineChart>
<LineChart.Path />
<LineChart.Axis position="left" orientation="vertical" />
</LineChart>
</LineChart.Provider>
```
## Candlestick Chart Guides
### Interactive cursors
To render an interactive cursor on your candlestick chart, you can include the
`CandlestickChart.Crosshair` component:
```jsx
<CandlestickChart.Provider data={data}>
<CandlestickChart>
<CandlestickChart.Candles />
<CandlestickChart.Crosshair />
</CandlestickChart>
</CandlestickChart.Provider>
```
<img src="https://user-images.githubusercontent.com/7336481/133027656-a877b248-77c1-4bf3-822f-a05dee4efa20.gif" width="200px" />
### Interactive labels
To render an interactive label on your candlestick chart, you can use the
`PriceText` or `DatetimeText` components:
> Note: These components **must** be within the `CandlestickChart.Provider`
> component.
```jsx
<CandlestickChart.Provider data={data}>
<CandlestickChart>
<CandlestickChart.Candles />
<CandlestickChart.Crosshair />
</CandlestickChart>
<CandlestickChart.PriceText type="open" />
<CandlestickChart.PriceText type="high" />
<CandlestickChart.PriceText type="low" />
<CandlestickChart.PriceText type="close" />
<CandlestickChart.DatetimeText />
</LineChart.Provider>
```
<img src="https://user-images.githubusercontent.com/7336481/133034935-faea61e6-09c2-4dba-a1ab-555d1ebee880.gif" width="200px" />
### Interactive tooltips
To render an interactive tooltip that follows your crosshair, you can use the
`Tooltip` component.
```jsx
<CandlestickChart.Provider data={data}>
<CandlestickChart>
<CandlestickChart.Candles />
<CandlestickChart.Crosshair>
<CandlestickChart.Tooltip />
</CandlestickChart.Crosshair>
</CandlestickChart>
</CandlestickChart.Provider>
```
<img src="https://user-images.githubusercontent.com/7336481/133036451-e1f2f12b-9e96-4a0f-8c69-4f630bb8ded3.gif" width="200px" />
### Haptic feedback
By making use of the chart event handlers, you are able to integrate haptic
feedback into your charts.
We can utilise the `onCurrentXChange` event to create haptic feedback on our
candlestick chart.
```jsx
import * as haptics from 'expo-haptics';
const data = [...];
function invokeHaptic() {
haptics.impactAsync(haptics.ImpactFeedbackStyle.Light);
}
function Example() {
return (
<CandlestickChart.Provider data={data}>
<CandlestickChart>
<CandlestickChart.Candles />
<CandlestickChart.Crosshair onCurrentXChange={invokeHaptic}>
<CandlestickChart.Tooltip />
</CandlestickChart.Crosshair>
</CandlestickChart>
</CandlestickChart.Provider>
)
}
```
### Colors
By default, the charts come with default colors out-of-the-box... But you
probably will want to change these to suit your brand.
#### Coloring the candles
To customise the color of the candlestick chart candles, supply a
`negativeColor` and a `positiveColor` to `CandlestickChart.Candles`. This can
be any valid React Native `StyleSheet` compatible color.
```jsx
<CandlestickChart.Provider data={data}>
<CandlestickChart>
<CandlestickChart.Candles positiveColor="hotpink" negativeColor="black" />
</CandlestickChart>
</CandlestickChart.Provider>
```
<img width="200px" alt="Screen Shot 2021-09-13 at 4 58 52 pm" src="https://user-images.githubusercontent.com/7336481/133037949-aba76daa-20bb-4d4e-b05e-b0cff42b69a6.png">
#### Coloring the crosshair
To customise the color of the line chart cursor, supply a `color` prop to
`CandlestickChart.Crosshair`. This can be any valid React Native `StyleSheet`
compatible color.
```jsx
<CandlestickChart.Provider data={data}>
<CandlestickChart>
<CandlestickChart.Candles positiveColor="hotpink" negativeColor="black" />
<CandlestickChart.Crosshair color="hotpink" />
</CandlestickChart>
</CandlestickChart.Provider>
```
<img width="200px" alt="Screen Shot 2021-09-13 at 4 58 52 pm" src="https://user-images.githubusercontent.com/7336481/133038181-33ee91bf-a5e2-4124-ab7b-df745a5ba804.gif">
### Customizing labels
#### Price labels
##### Precision
By default, the price labels have a precision of `2`, meaning that the prices
will always be to 2 decimal places. However, you can customize this with the
`precision` prop:
```jsx
<CandlestickChart.PriceText precision={4} />
```
##### Custom formatting
To customize the formatting of the price text, you can supply a `format`
function in the form of a
[reanimated worklet](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/worklets):
> Note: due to the nature of reanimated worklets, you cannot define functions
> that run on the React Native JS thread.
> [Read more here](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/worklets)
```jsx
<CandlestickChart.PriceText
format={({ value }) => {
'worklet';
const formattedPrice = yourOwnFormatValueFn(value);
return `$${formattedPrice} AUD`;
}}
/>
```
#### Datetime labels
##### Date/time options
Internally, WAGMI charts uses
[`Date.prototype.toLocaleString()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleString)
to generate the date/time label. You can customise it's options like so:
```jsx
<CandlestickChart.DatetimeText
locale="en-AU"
options={{
year: 'numeric',
month: 'numeric',
day: 'numeric',
hour: 'numeric',
minute: 'numeric',
second: 'numeric',
}}
/>
```
##### Custom formatting
To customize the formatting of the date/time text, you can supply a `format`
function in the form of a
[reanimated worklet](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/worklets):
> Note: due to the nature of reanimated worklets, you cannot define functions
> that run on the React Native JS thread.
> [Read more here](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/worklets)
```jsx
<CandlestickChart.DatetimeText
format={({ value }) => {
'worklet';
const formattedDate = yourOwnFormatValueFn(value);
return formattedDate;
}}
/>
```
## Component APIs
### LineChart.Provider
| Prop | Type | Default | Description |
| --------- | --------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data` | `Array<{ timestamp: number, value: number }>` | | The line chart data as an array of timestamps & values (prices). |
| `yRange` | `{ min?: number; max?: number }` | | Set a custom range for the y values of your chart. See [#20](https://github.com/coinjar/react-native-wagmi-charts/issues/20) for a use-case. |
| `xDomain` | `[ min: number; max: number ]` | | Scale x values proportionate to their time scale. Distance between points will be relative to each other instead of same spacing between in point. See [#140](https://github.com/coinjar/react-native-wagmi-charts/issues/140#issuecomment-1614264020) for a use-case. |
### LineChart
| Prop | Type | Default | Description |
| ---------- | ----------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `width` | `number` | Width of device screen | The width of the chart |
| `height` | `number` | Height of device screen | The height of the chart |
| `yGutter` | `number` | `16` | The gutter of the chart on the Y axis (the chart data will not exceed it's gutter) |
| `shape` | `function` | `shape.curveBumpX` | The shape type/curve of the graph. [Accepts a curve function from d3-shape](https://www.npmjs.com/package/d3-shape#curves) |
| `...props` | `ViewProps` | | This component also inherits React Native's `View` props. |
### LineChart.Path
| Prop | Type | Default | Description |
| ----------- | ----------- | --------- | -------------------------------- |
| `color` | `string` | `"black"` | Color of the line path |
| `width` | `number` | `3` | Width of the line path |
| `pathProps` | `PathProps` | `{}` | React Native SVG's `Path` props. |
### LineChart.CursorCrosshair
| Prop | Type | Default | Description |
| ----------------------- | ------------------------------ | --------- | --------------------------------------------------------------------- |
| `color` | `string` | `"black"` | Color of the crosshair dot |
| `size` | `number` | `8` | Size of the crosshair dot |
| `outerSize` | `number` | `32` | Size of the outer crosshair dot (faded dot) |
| `crosshairWrapperProps` | `ViewProps` | | Props of the wrapper component of the crosshair |
| `crosshairProps` | `ViewProps` | | Props of the crosshair dot |
| `crosshairOuterProps` | `ViewProps` | | Props of the crosshair outer dot |
| `snapToPoint` | `boolean` | `false` | **REACT NATIVE ONLY** Snap cursor to X position of nearest data point |
| `persistOnEnd` | `boolean` | `false` | Keep the cursor pinned at its last position after the gesture ends |
| `at` | `number` | | Index of followed `data` item. |
| `...props` | `LongPressGestureHandlerProps` | | |
### LineChart.CursorLine
| Prop | Type | Default | Description |
| -------------- | ----------- | -------- | ------------------------------------------------------------------ |
| `color` | `string` | `"gray"` | Color of the cursor line |
| `lineProps` | `LineProps` | | Props of the cursor line. Takes React Native SVG's `Line` props. |
| `persistOnEnd` | `boolean` | `false` | Keep the cursor pinned at its last position after the gesture ends |
| `at` | `number` | | Index of followed `data` item. |
### LineChart.Dot
| Prop | Type | Default | Description |
| ------------------- | -------------------------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `at` | `number` | | Index of followed `data` item. |
| `color` | `string` | `"black"` | Color of the dot |
| `size` | `number` | `4` | Size of the dot. |
| `inactiveColor` | `string` | | Color of the dot when the chart is inactive. |
| `showInactiveColor` | `boolean` | `true` | Whether or not to show the inactive dot when the chart is inactive. |
| `hasOuterDot` | `boolean` | `false` | Whether or not the dot has an outer circle. |
| `hasPulse` | `boolean` | `false` | Whether or not the dot has an animated pulse. |
| `outerSize` | `number` | `16` | Size of the outer dot. |
| `pulseBehaviour` | `"while-inactive"` or `"always"` | `"while-inactive"` | Behaviour of the pulse. If `always`, the outer dot will still animate when interaction is active. If `while-inactive`, the outer dot will animate only when the interaction is inactive. |
| `pulseDurationMs` | `number` | `800` | Duration in ms of the pulse animation. |
| `dotProps` | `CircleProps` | | Props of the dot (accepts React Native SVG's `Circle` props). |
| `outerDotProps` | `CircleProps` | | Props of the outer dot (accepts React Native SVG's `Circle` props). |
### LineChart.Highlight
| Prop | Type | Default | Description |
| ------------------- | --------- | --------- | ------------------------------------------------------------------------- |
| `from` | `number` | | Data index of where to start the highlight. |
| `to` | `number` | | Data index of where to end the highlight. |
| `color` | `string` | `"black"` | Color of the highlighted path. |
| `inactiveColor` | `string` | | Color of the highlight when the chart is inactive. |
| `showInactiveColor` | `boolean` | `true` | Whether or not to show the inactive highlight when the chart is inactive. |
| `width` | `number` | `3` | Width of the highlight stroke. |
### LineChart.HorizontalLine
| Prop | Type | Default | Description |
| ----------- | ------------------------------------------------------ | -------- | ---------------------------------------------------------------------------------------------------------- |
| `color` | `string` | `"gray"` | Color of the cursor line |
| `lineProps` | `LineProps` | | Props of the cursor line. Takes React Native SVG's `Line` props. |
| `at` | `number` or `{ index: number }` or `{ value: number }` | `0` | Index of followed `data` item. You can alternatively pass `{ value: number }`, corresponding to a y value. |
### LineChart.Gradient
| Prop | Type | Default | Description |
| ---------- | ----------- | ------- | --------------------- |
| `color` | `string` | | Color of the gradient |
| `...props` | `PathProps` | | |
### LineChart.Tooltip
| Prop | Type | Default | Description |
| ------------------------ | ---------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `xGutter` | `number` | `8` | X axis gutter in which the tooltip will not pass. |
| `yGutter` | `number` | `8` | Y axis gutter in which the tooltip will not pass. |
| `cursorGutter` | `number` | `48` | Gutter (spacing) between the cursor and the tooltip. |
| `position` | `"top"` or `"bottom"` or `"left"` or `"right"` | `"top"` | Position of the tooltip relative to the cursor. |
| `withHorizontalFloating` | `boolean` | `false` | If set to `true`, the position will changes between `left` and `right` on if tooltip reaches the X axis gutters. |
| `textStyle` | `{}` | | Style of the tooltip text |
| `at` | `number` | | Make the tooltip static at the given `data` index (which shows the tooltip always, unless there is interaction with the chart) |
### LineChart.PriceText
| Prop | Type | Default | Description |
| ----------- | ---------------------------------- | ------------- | ------------------------------------------ |
| `format` | `({ value, formatted }) => string` | | Custom format function of the price. |
| `precision` | `number` | `2` | Default precision of the price. |
| `variant` | `"formatted"` or `"value"` | `"formatted"` | Default representation of the price value. |
| `...props` | `TextProps` | | Inherits React Native's `Text` props |
### LineChart.DatetimeText
| Prop | Type | Default | Description |
| --------- | ---------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `({ value, formatted }) => string` | | Custom format function of the timestamp. |
| `locale` | `string` | `"en-US"` | Locale of the timestamp. |
| `options` | `{}` | | Options to pass to `toLocaleString()`. [Available options are here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleString) |
| `style` | `{}` | | Style of the price text |
| `variant` | `"formatted"` or `"value"` | `"formatted"` | Default representation of the timestamp value. |
### LineChart.HoverTrap
This component doesn't take any props. Place it as the child of your cursor
component to trap hover events on Web. If you're using mutliple cursors, place
this as the child of your lowest-rendered cursor.
```tsx
<LineChart.HoverTrap />
```
### LineChart.Axis
| Prop | Type | Default | Description |
| :------------------ | :---------------------------------------------- | :--------- | :--------------------------------------------------------------- |
| `position` | `string` | | Position of the axis. Can be `left`, `right`, `top` or `bottom`. |
| `orientation` | `string` | | Orientation of the axis. Can be `vertical` or `horizontal`. |
| `color` | `string` | `#666` | Color of the axis line and ticks. |
| `strokeWidth` | `number` | | Width of the axis line and ticks. |
| `tickCount` | `number` | `5` | Number of ticks to display on the axis. |
| `domain` | `[number, number]` | `[0, 100]` | Domain of the axis. |
| `hideOnInteraction` | `boolean` | `false` | Whether to hide the axis when the user interacts with the chart. |
| `format` | `(value: number or string) => string or number` | | Function to format the tick labels. |
| `textStyle` | `StyleProp<TextStyle>` | | Style of the tick labels. |
### CandlestickChart.Provider
| Prop | Type | Default | Description |
| ------ | -------------------------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------- |
| `data` | `Array<{ timestamp: number, open: number, high: number, low: number, close: number }>` | | The candlestick chart data as an array of timestamps & values (prices). |
### CandlestickChart
| Prop | Type | Default | Description |
| ---------- | ----------- | ----------------------- | --------------------------------------------------------- |
| `width` | `number` | Width of device screen | The width of the chart |
| `height` | `number` | Height of device screen | The height of the chart |
| `...props` | `ViewProps` | | This component also inherits React Native's `View` props. |
### CandlestickChart.Candles
| Prop | Type | Default | Description |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------ |
| `positiveColor` | `string` | `#10b981` | Color of the positive candles |
| `negativeColor` | `string` | `#ef4444` | Color of the negative candles |
| `rectProps` | `RectProps` | | Props of the SVG Rectangle. Takes React Native's SVG `Rect` props. |
| `lineProps` | `LineProps` | | Props of the SVG Line. Takes React Native's SVG `Line` props. |
| `renderRect` | `({ x: number, y: number, width: number, height: number, fill: string, candle: TCandle }) => React.ReactNode` | | Renders a custom rect component |
| `renderLine` | `({ x1: number, x2: number, y1: number, y2: number, stroke: string, strokeWidth: number, candle: TCandle }) => React.ReactNode` | | Renders a custom line component |
| `...props` | `SvgProps` | | This component also inherits React Native SVG's `Svg` props. |
### CandlestickChart.Crosshair
| Prop | Type | Default | Description |
| ------------------ | ------------------------------ | --------- | ------------------------------------------------ |
| `color` | `string` | `"black"` | Color of the crosshair |
| `onCurrentXChange` | `(xValue: number) => void` | | Callback to invoke when the x coordinate changes |
| `...props` | `LongPressGestureHandlerProps` | | |
### CandlestickChart.Tooltip
| Prop | Type | Default | Description |
| ------------------ | ---------------- | ------- | ------------------------------------------------- |
| `xGutter` | `number` | `8` | X axis gutter in which the tooltip will not pass. |
| `yGutter` | `number` | `8` | Y axis gutter in which the tooltip will not pass. |
| `tooltipTextProps` | `PriceTextProps` | | Props of the tooltip (price) text. |
| `textStyle` | `{}` | | Style of the tooltip text |
### CandlestickChart.PriceText
| Prop | Type | Default | Description |
| ----------- | ---------------------------------- | ------------- | ------------------------------------------ |
| `format` | `({ value, formatted }) => string` | | Custom format function of the price. |
| `precision` | `number` | `2` | Default precision of the price. |
| `variant` | `"formatted"` or `"value"` | `"formatted"` | Default representation of the price value. |
| `...props` | `TextProps` | | Inherits React Native's `Text` props |
### CandlestickChart.DatetimeText
| Prop | Type | Default | Description |
| --------- | ---------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `({ value, formatted }) => string` | | Custom format function of the timestamp. |
| `locale` | `string` | `"en-US"` | Locale of the timestamp. |
| `options` | `{}` | | Options to pass to `toLocaleSt