# finevo-web

> Finevo-Web

Latest version **0.0.29** (published 2019-07-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install finevo-web
pnpm add finevo-web
yarn add finevo-web
bun add finevo-web
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.29 |
| Published | 2019-07-01 |
| First published | 2019-06-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 332 KB |
| Known vulnerabilities | 0 (+27 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | finevotech |
| Keywords | trading, order book, order pad, finevo, web components |

## Links

- npm: https://www.npmjs.com/package/finevo-web
- npm.io page: https://npm.io/package/finevo-web

## Dependencies (9)

- [antd](https://npm.io/package/antd.md) ^3.19.8
- [less](https://npm.io/package/less.md) 2.7.2
- [axios](https://npm.io/package/axios.md) ^0.19.0
- [react](https://npm.io/package/react.md) ^16.8.6
- [lodash](https://npm.io/package/lodash.md) ^4.17.11
- [moment](https://npm.io/package/moment.md) ^2.24.0
- [react-dom](https://npm.io/package/react-dom.md) ^16.8.6
- [ag-grid-react](https://npm.io/package/ag-grid-react.md) ^21.0.1
- [ag-grid-community](https://npm.io/package/ag-grid-community.md) ^21.0.1

## Recent versions

- 0.0.29 (latest) — 2019-07-01
- 0.0.28 — 2019-06-28
- 0.0.27 — 2019-06-28
- 0.0.26 — 2019-06-27
- 0.0.25 — 2019-06-27
- 0.0.24 — 2019-06-27
- 0.0.23 — 2019-06-27
- 0.0.22 — 2019-06-27
- 0.0.21 — 2019-06-27
- 0.0.20 — 2019-06-27
- 0.0.19 — 2019-06-27
- 0.0.18 — 2019-06-27
- 0.0.17 — 2019-06-27
- 0.0.15 — 2019-06-27
- 0.0.14 — 2019-06-27
- … 13 more at https://npm.io/package/finevo-web/versions

## README

<h1 align="center">Finevo-Web</h1>

<div align="center">
    A web component wrapper library around React implementation  
</div>

## 📦 Install

```bash
npm install finevo-web
```

```bash
yarn add finevo-web
```

## 🔨 Usage
If you have not started with web components, we suggest you to visit the official <a href="https://www.webcomponents.org/introduction">docs</a>
```js
import { FinOrderForm, FinOrderBook } from 'finevo-web';

//register the component as a custom element with the browser
customElements.define('fin-order-form', FinOrderForm);
customElements.define('fin-order-book', FinOrderForm);
```

And using it with the accessToken
```html
<fin-order-form accessToken="a-valid-jwt-token"></fin-order-form>
```

You will need to define an options property for the order form component in the following format 
(The order form will not load unless these properties as defined):
```js
const FinOrderForm = document.querySelector('fin-order-form');

//attaching default properties
FinOrderForm.options = {
    config: {...},
    order:{
        uuid: 'unique-id-for-the-orders',
        price: 5.29,
        side: '1',
        triggerType: '3',
        triggerPriceDirection: '1'
    },
    company: {
        name: 'CIMB',
        id: '1023', 
        exchange: 'BM',
        type: 'NM',
    }    
};

//attaching listener to listen for order events from our Market Order Aggregator
OrderForm.addEventListener('order', event => console.log(event));
```

Alternatively, using js
```js
const FinOrderForm = document.createElement('fin-order-form');
FinOrderForm.setAttribute('accessToken', 'a-valid-jwt-token');
document.body.appendChild(FinOrderForm);
FinOrderForm.options = {...};
```

## 📃 Property Configuration
Under construction 🔨🔨🔨

---
_Source: https://npm.io/package/finevo-web · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._