1.0.0 • Published 2 years ago

coherent-gameface-ui v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

Game UI Components Suite

This a bundle of all Game UI Components available for the browser and Gameface.

Installation

via npm:

npm i coherent-gameface-ui

Usage

Exported Variables

These are the variables that 'coherent-gameface-ui' exports

Components\ Checkbox\ Switch\ GamefaceDropdown\ GamefaceFormControl\ Modal\ ProgressBar\ RadialMenu\ GamefaceRadioGroup\ Rangeslider\ ScrollableContainer\ Slider\ Stepper\ IEManager\ Tooltip\ TextField\ Tabs, TabHeading, TabPanel\ AccordionMenu, AccordionPanel, AccordionHeader, AccordionContent\ Router, Route, BrowserHistory, HashHistory\ GamefaceMenu, GamefaceLeftMenu, GamefaceBottomMenu, GamefaceRightMenu\

Import all components that you need to use:

import {
    Checkbox,
    Switch,
    Menu,
    Dropdown,
    Rangeslider,
} from 'coherent-gameface-ui';

if you don't need to access an exported variable - import all:

import 'coherent-gameface-ui';

Importing the Styles

Make sure to load the styles of each component that you've imported:

<link rel="stylesheet" href="../node_modules/coherent-gameface-ui/node_modules/coherent-gameface-switch/style.css">

Using the Bundles

To use directly in the browser without bundling - use the bundles in the node_modules folder:

<script src="node_modules/coherent-gameface-ui/node_modules/coherent-gameface-switch/dist/switch.development.js"></script>