# react-grille

> Make a grille pattern!

Latest version **1.0.0** (published 2017-11-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-grille
pnpm add react-grille
yarn add react-grille
bun add react-grille
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-11-29 |
| First published | 2017-11-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Rubens Mariuzzo |
| Maintainers | rmariuzzo |
| Keywords | react, grille, mesh, grid |

## Links

- npm: https://www.npmjs.com/package/react-grille
- Repository: https://github.com/rmariuzzo/react-grille
- Homepage: https://github.com/rmariuzzo/react-grille#readme
- Issues: https://github.com/rmariuzzo/react-grille/issues
- npm.io page: https://npm.io/package/react-grille

## Dependencies (1)

- [prop-types](https://npm.io/package/prop-types.md) ^15.6.0

## Alternatives

- [@lexical/table](https://npm.io/package/@lexical/table.md) — 3.0M weekly downloads
- [mantine-datatable](https://npm.io/package/mantine-datatable.md) — 98.2K weekly downloads
- [react-native-collapsible-tab-view](https://npm.io/package/react-native-collapsible-tab-view.md) — 70.6K weekly downloads
- [@handsontable/vue3](https://npm.io/package/@handsontable/vue3.md) — 16.1K weekly downloads
- [vuewordcloud](https://npm.io/package/vuewordcloud.md) — 7.2K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-11-29
- 0.0.1 — 2017-11-29

## README

![React Grille – Make a grille pattern!](banner.gif)


## Features

 - **Only 2.48KB** (that's 1.08KB gzipped!).
 - Only an single `<div />` node is rendered.
 - Grid is built with CSS using [`linear-gradient`](https://caniuse.com/#search=linear).
 - Control block and border size!

## Installation

  - `npm install react-grille --save`

    or

  - `yarn add react-grille`

## Usage

```js
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:

 1. Fork and clone this repo.
 2. Do your work.
 3. Create a PR.

## Releases

To release this project the following tasks should be done:

 1. Build distribution files: `yarn build`.
 2. Build Storybook demo files: `yarn build-storybook`.
 3. Bump version and create tag: `yarn version --new-version #.#.# -m 'Version %s.'`.
 4. Push new created tag: `git push origin --tags`.
 5. Publish: `npm publish`.

---

<div align=center>

Made with :heart: by [Rubens Mariuzzo](https://github.com/rmariuzzo).

[MIT License](LICENSE)

</div>

---
_Source: https://npm.io/package/react-grille · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._