Ignite Frame

Iframe integration for displaying Ignite Dashboards on internal pages

Install

npm install --save ignite-frame

or

yarn add ignite-frame

Usage

import * as React from "react";

import IgniteFrame from "ignite-frame";

class Example extends React.Component {
    render() {
        return <IgniteFrame />;
    }
}

Properties

/**
 *  IFrame wrapper for rendring Ignite Dashboards into an internal react application
 *
 *  @property {string}          token:      A valid JWT Token to authenticate against the Ignite Platform
 *  @property {IFrameOptions}   options:    A options object that contains the configuration for the iFrame
 *
 */

IFrameOptions

/**
 *  IFrame options interface
 *
 *  @property {number}  departmentId:   The department id that owns the dashboard
 *  @property {number}  dashboardId:    The id of the dashboard that should be displayed inside the iFrame
 *  @property {string}  background?:    A css compatible color string
 *  @property {string}  baseUrl?:       The baseUrl that should be used
 *
 */

License

MIT © Ignite Procurement