@nitro-ui/component-chips
Version:
Chips component for Nitro UI.
102 lines (69 loc) • 2.51 kB
Markdown
# Nitro UI: Chips
Chips component for Nitro UI.
## Getting Started
Get latest version by installing via [NPM -ui/chips](https://www.npmjs.com/package/@nitro-ui/component-chips):
```sh
npm install -ui/component-chips
```
Include this stylesheet code into your site:
```html
<link rel="stylesheet" href="dist/css/chips.min.css" />
```
## Usage:
Example with `<span>` tag:
```html
<span class="c-chip" href="#">Chip</span>
```
Color options:
```html
<span class="c-chip" href="#">Chip</span>
<span class="c-chip c-chip--blue">Blue</span>
<span class="c-chip c-chip--blue-light">Blue Light</span>
<span class="c-chip c-chip--green">Green</span>
<span class="c-chip c-chip--orange">Orange</span>
<span class="c-chip c-chip--pink">Pink</span>
<span class="c-chip c-chip--purple">Purple</span>
<span class="c-chip c-chip--red">Red</span>
<span class="c-chip c-chip--yellow">Yellow</span>
```
Inverted Color options:
```html
<span class="c-chip c-chip--blue-inverted">Blue</span>
<span class="c-chip c-chip--blue-light-inverted">Blue Light</span>
<span class="c-chip c-chip--green-inverted">Green</span>
<span class="c-chip c-chip--orange-inverted">Orange</span>
<span class="c-chip c-chip--pink-inverted">Pink</span>
<span class="c-chip c-chip--purple-inverted">Purple</span>
<span class="c-chip c-chip--red-inverted">Red</span>
<span class="c-chip c-chip--yellow-inverted">Yellow</span>
```
## Development
To extends, develop or contribute to this component, you're required to fork our main [repository](https://github.com/icarasia/nitro-ui) and made a pull request.
### Development Requirements
Development tools required for this component are:
- [NodeJS](https://nodejs.org/en/)
- [Grunt CLI](https://gruntjs.com)
- [Ruby](https://www.ruby-lang.org/en/) (optional)
- [SASS](https://sass-lang.com) (optional)
Ruby and SASS are optional if you're fully using [node-sass](https://github.com/sass/node-sass) from npm for development.
### Development Setup
Run:
```sh
npm install
```
### Compile
Run:
```sh
grunt
```
---
# TODO
- Adding Chips option with Icons & Avatar
---
# CHANGELOG
All notable changes to this project will be documented in this file. **For now, let's keep TODO and CHANGELOG in README file. Keeping things simple.**
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.0.0-beta] - 2019-07-18
### Added
- Initial setup