oly-cloud-frontend-gate

17.3.1 • Public • Published

Usage

To add the Authentication gate and the Centralizer to your project:

  1. Include the oly-sdk & react-oly-gate package
  2. Import the Gate & instantiate it with your branding info and credentials
npm i -S @olympusat/oly-cloud-frontend-sdk oly-cloud-frontend-gate
  import {Oly} from '@olympusat/oly-cloud-frontend-sdk';
  import {Gate} from '@olympusat/oly-cloud-frontend-gate';

  import getOlySdkOptions from "./olySdkOptions";
  import getOlyGateOptions from "./olyGateOptions";

  new Oly(getOlySdkOptions());
  new Gate(getOlyGateOptions());

Example config file

export default () => ({
  logo: '/images/olyhub_logo_v1_text_blackx200.png',
  brandingColor: '#103463',
  centralizerAppsIconColor: '#efefef',
  hideAppCentralizer: false,
  profileSettingsLink: '/account', // or false to hide the link in the ui
  reloadPageOnRoleChange: true,
  notifications: {// Optional: All noty options can be passed in here for push notification display
    layout: 'bottomRight',
    type: 'alert',
    animation: {
      open: 'animated bounceInRight', // Animate.css class names
      close: 'animated bounceOutRight' // Animate.css class names
    },
    timeout: 3000,
    progressBar: true
  },
  browserDetect: {
      display: ['UI', 'console'], // Displays browser info in the console or on DOM.
      threshold: {
        display: ['UI', 'console'], // Displays browser threshold notification in the console or on DOM.
        versions: { // browser versions threshold limit to check for. 
          chrome: '60.0.0' 
        },
        styles: {} // override default threshold notification styles
      }
    }
  styles: {top: '12px', right: 0, position: 'fixed'} // For overall layout, react syntax styles, ie. zIndex instead of z-index
});

Readme

Keywords

none

Package Sidebar

Install

npm i oly-cloud-frontend-gate

Weekly Downloads

6

Version

17.3.1

License

ISC

Unpacked Size

3.72 MB

Total Files

13

Last publish

Collaborators

  • olykyle
  • olympusat-admin
  • kagonzalez84