@collab-ui/core

    13.1.1 • Public • Published

    Collab UI Core

    CircleCI npm (scoped) license This project is using Percy.io for visual regression testing.

    @collab-ui/core

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

    Table of Contents

    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

    Usage

    CSS

    1. Copy the "@collab-ui/core/fonts" directory to the "fonts" directory for your site.
    2. Copy the "@collab-ui/core/images" directory to the "images" directory for your site.
    3. Copy the "@collab-ui/core/css/collab-ui.min.css" to your styles/css directory.
    4. 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">

    Scss

    1. Copy the "@collab-ui/icons/fonts" directory to the "fonts" directory for your site.
    2. 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';
    
    1. Import "@collab-ui/core/scss/collab-ui.scss" into your main entry Scss file AFTER the variables.

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

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

    Contribute

    See the contributing file!

    PRs accepted.

    License

    © 2014-2019 Cisco and/or its affiliates. All Rights Reserved.

    Install

    npm i @collab-ui/core

    DownloadsWeekly Downloads

    271

    Version

    13.1.1

    License

    MIT

    Unpacked Size

    6.89 MB

    Total Files

    625

    Last publish

    Collaborators

    • bfletcherbiggs
    • collab-ui-bot
    • pauljeter