@nitro-ui/utility-overflow/README.md

Utility overflow component for Nitro UI.

# Nitro UI: Utility Overflow

Utility Overflow component for Nitro UI.

## Getting Started

Get latest version by installing via [NPM @nitro-ui/utility-overflow](https://www.npmjs.com/package/@nitro-ui/utility-overflow):

```sh
npm install @nitro-ui/utility-overflow
```

## Usage:

```html
<div class="u-overflow-hidden">div with overflow hidden</div>
<div class="u-overflow-x-auto">div with overflow x auto</div>
<div class="u-overflow-y-auto">div with overflow y auto</div>
```


## Responsive Support

Overflow also support responsive for `mobile`

```html
<div class="u-overflow-hidden@mobile">div with overflow hidden on mobile</div>
<div class="u-overflow-x-auto@mobile">div with overflow x auto on mobile</div>
<div class="u-overflow-y-auto@mobile">div with overflow y auto on mobile</div>
```


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

Nothing todo for now.

---

# 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