Giter Club home page Giter Club logo

collab-ui-core's Introduction

Collab UI Core

license

@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-2018 Cisco and/or its affiliates. All Rights Reserved.

collab-ui-core's People

Contributors

semantic-release-bot avatar collab-ui-bot avatar shashankcs090 avatar khempel avatar daanishnasir avatar elenagiere avatar nickclar avatar holsted avatar aimeex3 avatar ragnaroksj avatar samwi avatar kgcreative avatar bfbiggs avatar moriahmaney avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.