https://github.com/joylei/riot-format
a helper library for riotjs to format displays
https://github.com/joylei/riot-format
format pipeline riot riot-format
Last synced: 7 months ago
JSON representation
a helper library for riotjs to format displays
- Host: GitHub
- URL: https://github.com/joylei/riot-format
- Owner: Joylei
- License: mit
- Archived: true
- Created: 2016-03-09T09:25:32.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-12-02T03:45:07.000Z (almost 9 years ago)
- Last Synced: 2025-02-25T03:03:36.461Z (8 months ago)
- Topics: format, pipeline, riot, riot-format
- Language: JavaScript
- Size: 115 KB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# riot-format
a helper library for [riotjs](https://github.com/riot/riot) to format displays,
without external dependencies, inspired by [$filter of angular](https://code.angularjs.org/1.5.9/docs/api/ng/service/$filter).
The original idea is to make it work with riot, but it can also work without riot.
[![NPM version][npm-version-image]][npm-url]
[![NPM downloads][npm-downloads-image]][npm-url]
[![MIT License][license-image]][license-url]
## why riot-format
- no external dependencies
- built-in format: [date(), number(), bytes(), json()](docs/api.md)
- chained format method calls
- easy to extend
- support modern browsers (IE9+)
- compatible with riot
- less than 5kb
## Get Started
### Get it from CDN
CDN files:
```
https://cdn.jsdelivr.net/riot-format/1.1.1/riot-format.js
https://cdn.jsdelivr.net/riot-format/1.1.1/riot-format.min.js
https://cdn.jsdelivr.net/riot-format/1.1.1/riot-format.min.js.map
```
### Install it from npm
```sh
npm install -D riot-format
```
#### Use it with riot
mixin
```js
import format from 'riot-format'
import * as riot from 'riot'
format(riot) //mixin globally
```
use it in riot tag
```html
Today is { format(now, 'date', 'yyyy-mm-dd') }
this.now = new Date()
```
#### Use it directly without riot
```js
import { format } from 'riot-format'
let formatter = format(new Date(), 'date', 'yyyy-mm-dd')
console.log(formatter.current)
//Note: formatter.current is lazily evaluated until you access it
```
For more information, see [Get Started](docs/getstarted.md)
## More
- [Advanced Usage](docs/advanced.md)
- [How to extend](docs/extend.md)
- [API](docs/api.md)
- [Typings](src/index.d.ts)
- [Examples](examples)
- [Demo](https://jsfiddle.net/wgs22gkg/)
## Plans
- add currency support
## License
MIT
[license-image]:http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
[license-url]:LICENSE
[npm-version-image]:http://img.shields.io/npm/v/riot-format.svg?style=flat-square
[npm-downloads-image]:http://img.shields.io/npm/dm/riot-format.svg?style=flat-square
[npm-url]:https://npmjs.org/package/riot-format