Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neetjn/riot-placeholder
Riot.js tag for generating placeholder text.
https://github.com/neetjn/riot-placeholder
browserify generator javascript riot riotjs scaffold tag
Last synced: 4 months ago
JSON representation
Riot.js tag for generating placeholder text.
- Host: GitHub
- URL: https://github.com/neetjn/riot-placeholder
- Owner: neetjn
- License: mit
- Created: 2017-12-29T14:47:56.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T12:47:13.000Z (almost 2 years ago)
- Last Synced: 2024-09-08T14:12:03.775Z (5 months ago)
- Topics: browserify, generator, javascript, riot, riotjs, scaffold, tag
- Language: JavaScript
- Homepage: https://neetjn.github.io/riot-placeholder/
- Size: 521 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# riot-placeholder
[](https://travis-ci.org/neetjn/riot-placeholder/)
[](https://badge.fury.io/js/riot-placeholder)
[](https://codecov.io/gh/neetjn/riot-placeholder)[](https://nodei.co/npm/riot-placeholder/)
Riot.js plugin for generating placeholder text.
## About
**riot-placeholder** is a simple riot tag used for scaffolding and prototyping riot.js based websites and applications.
This tag was built with [foobar-ipsum](https://github.com/neetjn/foobar-ipsum).
### Examples
* https://jsfiddle.net/neetjn/mhdLnund/
* [riot-book-example](https://github.com/neetjn/riot-book-example)## Usage
To install via NPM:
```bash
npm install riot-placeholder
```For a quick start using jsdelivr:
```html
```
Once available, **riot-placeholder** can be used like so:
```js
import riot from 'riot'
import placeholder from 'riot-placeholder'placeholder(riot)
console.log(`John said "${riot.placeholder.word()}" I tell you!`)
``````html
```The tag takes two configurable `opts`:
> **`unit`**: Unit for generator to target.
By default, the tag will automatically determine the unit depending on the target node.
* *word*: `h1`, `h2`, `h3`, `h4`, `h5`
* *sentence*: `span`
* *paragraph*: `p`> **`size`**: Size of the generated content (`sm`, `md`, `lg`).
### Contributors
* **John Nolette** ([email protected])
Contributing guidelines are as follows,
* Any new features must include a unit test.
* Branches for bugs and features should be structured like so, `issue-x-username`.
* Before putting in a pull request, be sure to verify you've built all your changes.
* Include your name and email in the contributors list.---
Copyright (c) 2017 John Nolette Licensed under the MIT license.