pennant


Pennant

A React component library for visualising historical and streaming financial market data.

View Demo
·
Report Bug
·
Request Feature

Table of Contents

1. 
   About The Project
   


2. 
   Getting Started
   
   
   
   • Prerequisites
   
   
   • Installation
   
   
   
   


3. Usage


4. Contributing


5. License

About The Project

A React chart component visualising historical and streaming financial market data. Built for the Vega platform but can be embedded in any application.

Getting Started

Pennant is available from npm.

$3

Pennant has react and react-dom as peer dependencies.

``sh
yarn add react react-dom
`

$3

`sh
yarn add pennant
`

Usage

`jsx
import React from "react";
import { CandlestickChart } from "pennant";

const dataSource = new DataSource();
const options = {
chartType: "candle",
studies: [],
overlays: [],
};

export const App = () => (

);
`

The minimum props required are:

- dataSource
- options
- interval

$3

You may customize the styling of pennant components by overriding the default CSS variables.

`css
/**
* You can override the default pennant variables.
* Note: this is not a complete list of --pennant- variables.
*/
:root {
--pennant-color-success: #26ff8a;
--pennant-color-danger: #ff261a;
}
`

Data

Pennant displays financial data using a DataSource object you pass as a prop to the React CandlestickChart component. This object must implement the DataSource interface, and typically takes the form of a class.

It provides a set of methods such as query and subscribe which will be called by the chart to get historical and streaming data respectively.

Several reference implementations are provided.

Contributing

$3

We use Storybook.

`sh
yarn storybook
`

Open http://localhost:6006 to view in the browser.

We try our best to follow the Conventional Commits specification. This lets use standard-version for semantic versioning and CHANGELOG generation.

$3

To build the library run

`sh
yarn build
`

The output can be found in the dist directory.

$3

To run the tests

`sh
yarn test
`

$3

We use standard-version for semantic versioning and CHANGELOG generation.
As long as your git commit messages are conventional and accurate, you no longer need to specify the semver type. It will be calculated for you.
An npm script is provided for convenience.

`sh
yarn release
`

If successful you can push up the new commit and tag with

`sh
git push --follow-tags origin main
`

To release as a pre-release use the flag --prerelease.

`sh
yarn release -- --prerelease alpha --release-as minor
`

$3

Add the new chart type in chart-types.ts. Add a new case in helpers-spec.ts` which specifies how to draw the new chart type.

License

Pennant is available under the MIT license.