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

Utility Float component for Nitro UI.

# Nitro UI: Utility Float

Utility Float component for Nitro UI.

## Getting Started

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

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

Include this stylesheet code into your site:


```html
<strong>Float</strong>
<div class="u-float-left">Float Left</div>
<div class="u-float-right">Float Right</div>
<div class="u-float-none">Float None</div>
<br/>

<strong>Responsive</strong>
`mobile, portable`
<p class="u-float-left@mobile">Float left @ Mobile</p>
<p class="u-float-left@portable">Float left @ Portable</p>
<p class="u-float-left">Float left @ All screen</p>
<br/>
```

## Usage:

Example with `<a>` tag:

```html
<div href="#" class="u-float-left  u-float-right@portable  u-float-none@mobile">Float Left Primary, Float Right @ Portable, Float None @ 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 unable 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