Go to file
2018-12-02 10:34:02 -05:00
src Fix duplicate declaration issue. 2018-12-02 10:32:20 -05:00
.babelrc First commit. 2018-11-30 16:53:43 -05:00
.gitignore Remove dist. 2018-11-30 17:05:21 -05:00
index.html First commit. 2018-11-30 16:53:43 -05:00
License.md First commit. 2018-11-30 16:53:43 -05:00
package-lock.json First commit. 2018-11-30 16:53:43 -05:00
package.json Upgrade version. 2018-12-02 10:25:41 -05:00
README.md Update readme. 2018-12-02 10:34:02 -05:00
webpack.config.js Remove dist. 2018-11-30 17:05:21 -05:00
yarn.lock First commit. 2018-11-30 16:53:43 -05:00

FlipsideJS

Codeship Status for FlipsideCrypto/flipside-js

FlipsideJS provides a library of embeddable widgets that display data from the Flipside Platform API, including FCAS.

To get started, request an API Key: api@flipsidecrypto.com.

Example

View Live FCAS Widget Example

Install

The FlipsideJS library is made available over our CDN to ensure a speedy response time.

<script src="https://d3sek7b10w79kp.cloudfront.net/flipside-v1.1.0.js"></script>

Usage

<div id="container"></div>
<script>
  var flipside = new Flipside(YOUR_FLIPSIDE_API_KEY);
  // To render an FCAS widget
  flipside.createFCAS("container", "ZEC");
</script>

API

createFCAS(id: string, symbol: string, options: object) Creates an FCAS widget in the given DOM element ID.

Parameters

  • id: ID of the DOM element in which to create the widget.
  • symbol: Symbol of the asset. e.g "BTC"
  • opts: Display options for the widget

Options

  • score: boolean: Show/hide the score section.
  • plot: boolean: Show/hide the plot graph.
  • logo: boolean: Show/hide the asset's logo.
  • symbol: boolean: Show/hide the asset's symbol.
  • trend: boolean: Show/hide the 7 day trend.
  • rank: boolean: Show/hide the FCAS rank.

Default options

flipside.createFCAS("container", "ZEC", {
  score: true,
  plot: true,
  logo: true,
  symbol: true,
  trend: true,
  rank: true
});

Building

$ yarn run build