README
react-image-panel
A small module for showing image + title + description in a panel Demo
get started
npm i react-image-panel --save
Integrating component
import { Panel } from 'react-image-panel'
// <Panel />
Adding css!
You can find all of the css for this module in ./node_modules/react-image-panel/src/panel.css
development
Run's webpack and starts a tiny express server for testing
npm i
npm run start
hosting an example ( gh-pages )
By default components come with an examples page it order to publish that
npm run build
git add . -A
git commit -m "Your message"
git push origin gh-pages
If you have an specific documentation in your component you can add that in docs/README.md
testing
npm run test
build-scripts
Script | Action |
---|---|
start |
Run Dev Server |
build |
compile example and build common:js |
build:commonjs |
build common:js to lib |
test |
run unit tests |
test:watch |
run unit tests with watch |
examples
[tbd]
=
built by @clintonhalpin