https://github.com/fabiosantoscode/component-story-collection
Displays a set of stories around a bigger story.
https://github.com/fabiosantoscode/component-story-collection
Last synced: 3 months ago
JSON representation
Displays a set of stories around a bigger story.
- Host: GitHub
- URL: https://github.com/fabiosantoscode/component-story-collection
- Owner: fabiosantoscode
- License: other
- Created: 2016-03-10T16:09:41.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-04-01T11:51:09.000Z (almost 10 years ago)
- Last Synced: 2025-01-17T22:45:29.591Z (about 1 year ago)
- Language: JavaScript
- Size: 1.25 MB
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Storycollection
> Displays a story collection
## Usage
**This component expects an ES6 environment**, and so if you are using this in an app,
you should drop in a polyfill library - it has been tested with [babel-polyfill] but
[core-js] or [es6-shim] may also work.
[babel-polyfill]: https://babeljs.io/docs/usage/polyfill/
[core-js]: https://www.npmjs.com/package/core-js
[es6-shim]: https://www.npmjs.com/package/es6-shim
The default export is a React Component, so you can simply import the component and use
it within some JSX, like so:
```js
import Storycollection from 'component-story-collection';
return ;
```
For more examples on usage, see [`src/example.es6`](./src/example.es6).
## Install
```bash
npm i -S component-story-collection
```
## Run tests
```bash
npm test
```