# react-scrabblefy

> A React component that converts words to Scrabble tiles.

Latest version **1.0.10** (published 2019-08-29) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.10 |
| Published | 2019-08-29 |
| First published | 2018-11-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 77.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Josh Payette |
| Maintainers | joshwaiam |
| Keywords | react, scrabble |

## Links

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

## Dependencies (2)

- [react](https://npm.io/package/react.md) ^16.6.3
- [tinycolor2](https://npm.io/package/tinycolor2.md) 1.4.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.10 (latest) — 2019-08-29
- 1.0.9 — 2018-12-12
- 1.0.8 — 2018-12-02
- 1.0.7 — 2018-12-02
- 1.0.6 — 2018-12-01
- 1.0.5 — 2018-11-29
- 1.0.4 — 2018-11-29
- 1.0.3 — 2018-11-29
- 1.0.2 — 2018-11-29
- 1.0.1 — 2018-11-29

## README

# react-scrabblefy

A react component that converts a word to Scrabble tiles. You can view a demo at https://codesandbox.io/s/3x9w40mq3m.

# Credits

The code for the styling and tilting of the Scrabble tiles came from a wonderful CodePen by James Holmes, which you can
find here: https://codepen.io/32bitkid/pen/NPEgbx. I adapted his work in order to make this a reusable React component. You can pass down additional props to the Scrabblefy container, as well as to each letter tile.

# Installation

1. Run `npm i react-scrabblefy`
2. Include react-scrabblefy in your project: `import Scrabblefy from 'react-scrabblefy'`
3. Usage: `<Scrabblefy word="SCRABBLEFY" size={50} align="left" />`

# Options

Scrabblefy accepts two options:

1. `word`: **REQUIRED**  
   The string you want to convert.
2. `size`: _OPTIONAL_
   The desired tile size in pixels - just pass a number (defaults to 50)!
3. `align`: _OPTIONAL_
   Whether the tiles should align 'left', 'center', or 'right' (defaults to center).
4. `straight`: _OPTIONAL_
   Whether the tiles should be straight or randomly tilted (defaults to true).
5. `tileProps`: _OPTIONAL_
   Additional props that will be spread to each letter tile.

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