Collab UI Core

@collab-ui/core

Collab UI Core is a UI framework for implementing Cisco Collaboration Design into web apps and sites.

Install

Install and manage the Collab UI Core using NPM. You may use yarn or npm. By default, yarn/npm installs packages to node_modules/.

npm install @collab-ui/core --save

or

yarn add @collab-ui/core

Copy the "@collab-ui/core/fonts" directory to the "fonts" directory for your site.
Copy the "@collab-ui/core/images" directory to the "images" directory for your site.
Copy the "@collab-ui/core/css/collab-ui.min.css" to your styles/css directory.
In the <head> of your HTML reference the location of your collab-ui.min.css.

<link rel="stylesheet" href="path/to/collab-ui/css/collab-ui.min.css">

Copy the "@collab-ui/icons/fonts" directory to the "fonts" directory for your site.
Add an "$brand-font-folder, $icon-font-path, and $images-path" variables to your app's variables.scss file.

$brand-font-folder: 'path/to/fonts/directory';
$icon-font-path: 'path/to/fonts/directory';
$images-path: 'path/to/images/directory';

Import "@collab-ui/core/scss/collab-ui.scss" into your main entry Scss file AFTER the variables.

@import '~@collab-ui/core/scss/collab-ui';

Compile your Scss using your static compiler or bundler (Webpack, Grunt, Gulp, etc.)

PRs accepted.