Need private packages and team management tools?Check out npm Teams »

@momentum-ui/core

19.4.8 • Public • Published

Momentum UI Core

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

@momentum-ui/core

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

Table of Contents

Install

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

npm install @momentum-ui/core --save

or

yarn add @momentum-ui/core

Usage

CSS

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

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

Scss

  1. Copy the "@momentum-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 "@momentum-ui/core/scss/momentum-ui.scss" into your main entry Scss file AFTER the variables.

@import '~@momentum-ui/core/scss/momentum-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 @momentum-ui/core

DownloadsWeekly Downloads

2,075

Version

19.4.8

License

MIT

Unpacked Size

8.06 MB

Total Files

702

Last publish

Collaborators

  • avatar
  • avatar