akki-jat / momentum-ui

Momentum UI is a collection of UI libraries for implementing Momentum Design into web applications and websites.

@momentum-ui

DEPRECATION NOTICE

Packages which are deprecated and will no longer receive updates

• https://www.npmjs.com/package/@momentum-ui/tokens
• https://www.npmjs.com/package/@momentum-ui/icons
• https://www.npmjs.com/package/@momentum-ui/illustrations
• https://www.npmjs.com/package/@momentum-ui/animations

Replacement packages which will be updated and are backwards compatible

• @momentum-design/animations - Animation assets. NPMJS Package
• @momentum-design/icons - Icon assets. NPMJS Package
• @momentum-design/illustrations - Illustration assets. NPMJS Package

New tokens are being generated and updated here and are a work in progress. New projects should consume the tokens at the link below. Existing projects can continue to use their existing tokens, but note the current repository tokens: ttps://www.npmjs.com/package/@momentum-ui/tokens will not be receiving updates.

• @momentum-design/tokens - Token assets. NPMJS Package

Migration Guide

• Icons - https://github.com/momentum-design/momentum-ui/blob/master/icons-rebrand/MIGRATION.MD
• Illustrations - https://github.com/momentum-design/momentum-ui/blob/master/illustrations/MIGRATION.MD
• Animations - https://github.com/momentum-design/momentum-ui/blob/master/animations/MIGRATION.MD
• Tokens - TODO

Momentum UI

Momentum UI is a collection of UI libraries for implementing Momentum Design into web applications and websites.

Table of Contents

• Background
• Usage
• Requirements
• Development
• Contributing
• License

Background

These libraries allow web developers to quickly and easily create Momentum Design web apps and sites. We provide libraries built on HTML/CSS and many of the modern JavaScript frameworks, including ReactJS, Angular and AngularJS. We use a Lerna monorepo to manage all of the libraries in one repository.

Usage

The individual libraries are distributed through npm. You can find information on usage and installation in each of their individual README files.

• @momentum-ui/core
• @momentum-ui/react
• @momentum-ui/icons

Requirements

To contribute to @momentum-ui, you need to have >=Node 8.10.0 and Yarn installed globally on your machine.

Development

Setting up your development environment:

1. Clone this repo using a git client (e.g. git clone https://github.com/momentum-design/momentum-ui.git)
2. Run yarn install from the root of the repo.
3. Run yarn bootstrap from the root of the repo.
4. Run yarn start:all to start the playground app for all libraries or yarn start:<library> to only start the library the you are working in.

NOTE: Install watchman with brew install watchman if you are having the following or similar error after an initial yarn start:

2017-09-05 00:44 node[68587] (FSEvents.framework) FSEventStreamStart: register_with_server: ERROR: f2d_register_rpc() => (null) (-22)
    2017-09-05 00:44 node[68587] (FSEvents.framework) FSEventStreamStart: register_with_server: ERROR: f2d_register_rpc() => (null) (-22)
    events.js:160
          throw er; // Unhandled 'error' event
          ^

    Error: Error watching file for changes: EMFILE
        at exports._errnoException (util.js:1022:11)
        at FSEvent.FSWatcher._handle.onchange (fs.js:1406:11)

Contributing

PRs are welcome! See CONTRIBUTING for details.

License

©2013-2020 Cisco Systems, Inc. and/or its affiliates. All Rights Reserved.

See LICENSE for details.