Skip to content
No description, website, or topics provided.
TypeScript JavaScript CSS HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
src
.editorconfig
.gitignore
.prettierrc
.travis.yml
README.md
package.json
rollup.config.js
tsconfig.json
tsconfig.test.json
yarn.lock

README.md

Ignite Frame

Iframe integration for displaying Ignite Dashboards on internal pages

NPM JavaScript Style Guide

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

You can’t perform that action at this time.