@denali-design/react/README.md

React.JS component library for the Denali CSS Framework

# @denali-design/react [![Pipeline Status][status-image]][status-url]

:construction: (WIP) React.JS Component Library for Denali CSS Framework

## Table of contents

-   [Background](#background)
-   [Install](#install)
-   [Usage](#usage)
-   [Browser support](#browser-support)
-   [Versioning](#versioning)
-   [Contribute](#contribute)
-   [License](#license)

---

## Background

The Denali System Language was created by the Platforms and Technology Design team at Verizon Media as a scalable method for designing and developing visually consistent and functional internal products. Denali’s CSS framework allows developers to implement the Denali System Language in their projects. The framework is lightweight and flexible. It supports theming through custom variables which means the visual appearance of Denali’s components can be easily adapted to fit the visual style of any brand. Additionally, components are framework independent allowing you to take what you need and leave the rest.

You can view the Denali’s entire component library complete with corresponding code snippets and documentation on the [getting started page](https://denali.design/docs/2/guides/get-started).

## Installation

You will need the following installed to run the site:

1. [Node](https://nodejs.org/en/)
2. [NPM](https://www.npmjs.com/)
3. [yarn](https://yarnpkg.com/)

> Note: This guide assumes you have the prerequisites installed locally and will not go over install instructions for them. Refer to their websites for guidance if necessary.
> First install node packages.

```
yarn install
```

Serve Storybook for development

```
npm run storybook
```

Compile components to JS

```
npm run build
```

## Browser Support

Learn more about the browsers and devices we support [here](https://denali.design/browsers).

-   **Chrome** on Android, Windows, macOS, and Linux
-   **Firefox** on Windows, macOS, and Linux
-   **Safari** on iOS and macOS
-   **IE11+** on Windows
-   **Edge** on Windows

## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.

[status-image]: https://cd.screwdriver.cd/pipelines/7272/badge
[status-url]: https://cd.screwdriver.cd/pipelines/7272