Momentum UI React
Momentum UI React
is a resuable, component based, flexible React library available as
npm module. It provides set of UI components and utilities based on Momentum Design.
The git repo can be cloned from the momentum-ui monorepo and found at https://github.com/momentum-design/momentum-ui/tree/master/react.
Checkout the documentation for documentation and live examples.
Goals
- Independent — pick and use only the components you need.
-
Styled — override styles of components by
className
andstyle
properties. - Customizable — properties allow many different config options to suit your app.
- Performant - high performance guaranteed with use of CSS3 Flexbox and non-bloated architecture.
- Reliable — each component is rigorously tested.
Getting Started
To use @momentum-ui/react in your application follow below steps:
Step 1 - Install and add @momentum-ui/react to your npm package dependencies
Using npm
npm i -S @momentum-ui/react
Using yarn
yarn add @momentum-ui/react
Step 2. Import Momentum UI React components in your app
Use ES6 import statement to import the component that you want to use:
import { Button } from '@momentum-ui/react';
// or
import Button from from '@momentum-ui/react/button';
...
...
<div className="container">
<Button name="primary" size="large">Welcome to Momentum UI React !</Button>
</div>
Tools & Frameworks
Package manager
- yarn - BSD-2-Clause
Base framework
Momentum Design System Look & Feel
- @momentum-ui/core - MIT
- @momentum-ui/icons - MIT
ES6 Minifier
- babili - MIT
ES6 Lint
- eslint - MIT
CSS/SCSS Lint
- stylelint - MIT
CSS Utility Tool
JsUnit Testing framework
Contribution
Want to contribute? Why not go through Developer's Guide to understand more technical details about the project and contribution guidelines to be adhered.
Changelog
The changelog can be found here.
Copyright
Copyright (c) 2017 Cisco Systems