1.0.0 • Published 6 years ago
react-grille v1.0.0
Features
- Only 2.48KB (that's 1.08KB gzipped!).
- Only an single
<div />
node is rendered. - Grid is built with CSS using
linear-gradient
. - Control block and border size!
Installation
npm install react-grille --save
or
yarn add react-grille
Usage
import React from 'react'
import Grille from 'react-grille'
const Demo = () => (
<Grille>
<h1>Hi 👋</h1>
</Grille>
)
Documentation
Property | Type | Default | Description |
---|---|---|---|
blockSize | Number | 50 | The size of blocks. |
borderSize | Number | 1 | The size of borders. |
borderColor | String | "red" | The border color. |
Tests
Tests are manually done using Storybook. It can be run locally with: yarn storybook
.
Development
To start contributing to this project, please do:
- Fork and clone this repo.
- Do your work.
- Create a PR.
Releases
To release this project the following tasks should be done:
- Build distribution files:
yarn build
. - Build Storybook demo files:
yarn build-storybook
. - Bump version and create tag:
yarn version --new-version #.#.# -m 'Version %s.'
. - Push new created tag:
git push origin --tags
. - Publish:
npm publish
.
Made with :heart: by Rubens Mariuzzo.