Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/denali-design/denali-react

🚧 (WIP) React.JS component library for the Denali CSS Framework
https://github.com/denali-design/denali-react

css css-framework denali denali-css-framework react reactjs ui ui-components

Last synced: about 1 month ago
JSON representation

🚧 (WIP) React.JS component library for the Denali CSS Framework

Awesome Lists containing this project

README

        

# @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

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the tags on this [repository](https://github.com/denali-design/denali-react).

## Maintainers

- [**Chas Turansky**](https://github.com/chasturansky)
- [**Shadi Abu Hilal**](https://github.com/shadiabuhilal)
- [**Jon Kilroy**](https://github.com/jkusa)
- [**Anusha Ganti**](https://github.com/anusha-66)

## 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

## License

Code licensed under the MIT license. See [LICENSE file](LICENESE.md) for terms.