@hazardouswizard/common

Installing Framework

These components must be installed as yarn or npm packages. The installation is a three step process.

1. Installing Prerequisites

• Node.js
• NPM or Yarn

2. Adding the Artifactory Repository To Your Project

npm config set @scuf:registry https://artifactory-na.honeywell.com/artifactory/api/npm/SCUF-10305-stable-npm-local/

3. Adding Node Registry To Your Project

Forge UI can be installed as a yarn or npm package. Use the the following command

yarn add @hazardouswizard/common

Adding The Style

The framework is reliant on a themed version of semantic and its compiled css must be included in your project. In React projects, it's most common to have webpack or another bundler, and it is recommended that the css be imported in your app's most parent component via an import statement like the following example:

import '@hazardouswizard/common/honeywell/theme.css'

Compact theming components:

import '@hazardouswizard/common/honeywell-compact/theme.css'

Dark theming components:

import '@hazardouswizard/common/honeywell-dark/theme.css'

Compact Dark theming components:

import '@hazardouswizard/common/honeywell-compact-dark/theme.css'

Consuming The Components

Components from Forge UI can be imported by their Class name like most node dependencies with import statements to @scuf

import { Button } from '@hazardouswizard/common';

An Example Would Be

import React, { Component } from 'react';
import { Button } from '@hazardouswizard/common';
import '@hazardouswizard/common/honeywell/theme.css'

class App extends Component {
  render() {
    return (
      <Button>Hello World</Button>
    );
  }
}