@moneymade/moneymade-widgets
v1.0.2
Published
Moneymade Widgets
Downloads
7
Readme
Installation
Just run the following command at the root of your project:
npm install moneymade-widgets
Usage
First you need to wrap your project with MoneymadeEmbed component
import { MoneymadeEmbed } from 'moneymade-widgets'
<MoneymadeEmbed>
{children}
</MoneymadeEmbed>
Examples
Our Comonents:
- TickerSimple
- ArticleSnapshot
- CategoryRoundup
- Monetized
- TickerTable
- InlineData
- TickerExpanded
Basic example:
import {
InlineData,
Monetized,
TickerTable,
CategoryRoundup,
TickerExpanded,
ArticleSnapshot,
TickerSimple } from 'moneymade-widgets'
TickerSimple
<TickerSimple symbol="AAPL" />
| Props | Type | Default | Description | |----------|---------|---------|-----------------------| | symbol | string | - | Set ticker to display | | schema | string | - | Set schema to display |
ArticleSnapshot
<ArticleSnapshot title="Test" symbols={['AAPL', 'BRK.A', 'MSGE']} />
| Props | Type | Default | Description | |----------|---------|---------|------------------------| | symbols | string[]| - | Set array with tickers | | title | string | '' | Set text | | schema | string | - | Set schema to display |
CategoryRoundup
<CategoryRoundup title="Test" symbols={['AAPL', 'BRK.A', 'MSGE']} />
| Props | Type | Default | Description | |----------|---------|---------|------------------------| | symbols | string[]| - | Set array with tickers | | title | string | '' | Set text | | schema | string | - | Set schema to display |
Monetized
<Monetized symbols={['AAPL', 'MSGE']} timeframe="1Y" />
| Props | Type | Default | Description | |----------|---------|--------------------------|---------------------------------------------------| | symbols | string[]| - | Set array with tickers | | timeframe| string |24H, 7D, 30D, 1Y, 5Y, 10Y |You need select one of the proposed default values | | schema | string | - | Set schema to display |
InlineData
<InlineData symbol="FB" dataPoint="5yr-average-annual-return" fontSize="20" />
| Props | Type | Default | Description | |----------|---------|-------------------------------------------|--------------------------------------------------------------------------------------------------------------------------| | symbol | string | - | Set ticker to display | | schema | string | - | Set schema to display | | fontSize | string |12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32 |You need select one of the proposed default values | | dataPoint| string |market-cap, price, ytd-return,todays-return, last-5-trading-days-return, last-52-weeks-return, 5yr-average-annual-return, 10yr-average-annual-return |You need select one of the proposed default values|
TickerExpanded
<TickerExpanded symbol="FB" />
| Props | Type | Default | Description | |----------|---------|---------|-----------------------| | symbol | string | - | Set ticker to display | | schema | string | - | Set schema to display |