@nulogy/components

@nulogy/components is a component library built with React that makes it easy for you to build interfaces that conform to the principles of the Nulogy Design System.

📖 👀 Browse components online in Storybook

---

Installation

The @nulogy/components library can be installed from npm.

$ yarn add @nulogy/components react react-dom styled-components

`@nulogy/components` has a few peer dependencies that you will need to install: `react react-dom styled-components`.

See the [package.json](https://github.com/nulogy/design-system/blob/master/components/package.json) for compatible versions of these dependencies.

Usage

Please see the docs for the individual components for details on their use, but in general components can be imported and rendered as you would expect:

lang: javascript
---
import React from 'react'
import ReactDOM from 'react-dom';
import { Button, P, Title } from '@nulogy/components';

const App = props => (
  <React.Fragment>
    <Title>My App</Title>
    <P>This is a paragraph.</P>
    <Button>Click me!</Button>
  </React.Fragment>
);

ReactDOM.render(<App />, document.getElementById('root'))

---

Contributing

See Guides/Quick start for instructions on how to install and work with this project, and Guides/Package Scripts for more details on the commands available in the project.

Links

• Component Docs
• Components Storybook
• @nulogy/components package on npm
• Workspace in the NDS GitHub repo