https://github.com/ahrefs/melange-recharts

https://github.com/ahrefs/melange-recharts

Last synced: 18 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ahrefs/melange-recharts
• Owner: ahrefs
• License: mit
• Created: 2018-05-01T14:57:02.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-09T02:50:58.000Z (about 1 month ago)
• Last Synced: 2024-12-16T19:17:41.339Z (24 days ago)
• Language: Reason
• Size: 466 KB
• Stars: 58
• Watchers: 5
• Forks: 26
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# melange-recharts

These are the [Melange](https://melange.re/) bindings for [Recharts](http://recharts.org/).

🚧 It is not completed, we are adding bindings as we go. Doesn't follow semver at this point. 🚧

## Install

Install [opam](https://opam.ocaml.org/) package manager.

Then:

```sh

opam install melange-recharts

```

The bindings support the version `^2.1.12` of `recharts` npm package, which should be installed separately:

```json

  "dependencies": {

    "recharts": "^2.1.12"

  }

```

## Setup

Add `melange-recharts` to the `libraries` in your `dune` file:

```lisp

; ...

  (libraries melange-recharts)

; ...

```

## Usage Example

See [Example.re](./example/Example.re);

## Helpers

Some of polymorphic params are represented as a variant, list below:

```reason

module AxisInterval = {

  ...

  type arg =

    | PreserveStart

    | PreserveEnd

    | PreserveStartEnd

    | Num(int);

  ...

};

module PxOrPrc = {

  ...

  type arg =

    | Px(float)

    | Prc(float);

  ...

};

```

you will use it like this:

```reason

```

Check [Recharts documentation](http://recharts.org/en-US/api) for available props.