Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nitin42/react-text-fun
React meets Blotter.js
https://github.com/nitin42/react-text-fun
creative-coding generative-art reactjs tools web
Last synced: 17 days ago
JSON representation
React meets Blotter.js
- Host: GitHub
- URL: https://github.com/nitin42/react-text-fun
- Owner: nitin42
- Created: 2019-05-04T17:05:32.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-05-12T13:13:39.000Z (over 5 years ago)
- Last Synced: 2024-10-12T16:09:58.559Z (about 1 month ago)
- Topics: creative-coding, generative-art, reactjs, tools, web
- Language: JavaScript
- Homepage:
- Size: 4.72 MB
- Stars: 55
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-text-fun
> React meets Blotter.js
## Table of contents
* [Introduction](#introduction)
* [Install](#install)
* [Example](#example)
* [Components](#blotter-components)
* [Styling text](#styling-text)
* [Using text canvas](#using-text-canvas)
* [Live examples](#live-examples)
## Introdution
`react-text-fun` is a small component library that encapsulates [Blotter.js](https://blotter.js.org/#/materials) shader materials in the form of React components and provides a very easy to use API.
I created `react-text-fun` after finding myself imperatively using the Blotter.js APIs for custom and existing materials. I decided to convert all its shader materials in the form of React components to make it easier to work with.
Hope you find it useful as well 🙂
## Install
```
yarn add react-text-fun
```
This package also depends on `Blotter.js` so make sure you put the below script in your HTML file.
```
```
## Example
Let's take an example of distortion text material that distorts the shape of the text using various transforms
```jsx
import { DistortionText } from 'react-text-fun'
import React from 'react';
import ReactDOM from 'react-dom';
const App = props => (
)
// Assuming you have an element with id 'root' to which you want the component to render to.
ReactDOM.render(, document.getElementById('root'))
```
If your example compiles successfully, you should see this output.
Cool, isn't it?
[Check out the API reference](#distortion-text) for `DistortionText` component to see what other effects you can apply to the text.
## Blotter components
### Distortion Text
Distortion text is based on the [Rolling Distort Material](https://blotter.js.org/#/materials/RollingDistortMaterial) in Blotter.js.
**Example**
```jsx
import { DistortionText } from 'react-text-fun'
```
| Prop | Description | Type |
| ------------- |:-------------:| -----:|
| `speed` | Increase or decrease the speed of animation applied to the distortion on your text | number |
| `rotation` | Change the rotation of distortion effect | number |
| `distortX` | update the horizontal position in which the distortion effect will be applied | number |
| `distortY` | update the vertical position in which the distortion effect will be applied | number |
| `noiseAmplitude` | change the noise amplitude (amplitude of toughs and crests) | number |
| `noiseVolatility` | describes the overall change your text will experience | number |
I'll recommend reading [this](https://pudding.cool/2018/02/waveforms/) brilliant piece written by [Josh Comeau](https://www.joshwcomeau.com/) on Waveforms. It will give you a little more idea on how and what values you should use to update the noise amplitude, and change its volatility.
### Flies Text
Flies Text component is based on the [FliesMaterial](https://blotter.js.org/#/materials/FliesMaterial) in Blotter.js
```jsx
import { FliesText } from 'react-text-fun';
```
| Prop | Description | Type |
| ------------- |:-------------:| -----:|
| `cellWidth` | Width of a cell | number |
| `cellRadius` | Radius of a cell | number |
| `speed` | Animation speed | number |
| `dodge` | whether or not to dodge cells from a position (x-axis or y-axis) | boolean |
| `dodgeX` | dodge position of cells around x-axis | number |
| `dodgeY` | dodge position of cells around y-axis | number |
### Split color channel
Split color channel is based on [ChannelSplitMaterial](https://blotter.js.org/#/materials/ChannelSplitMaterial) in Blotter.js
```jsx
import { SplitColorChannelText } from 'react-text-fun';
```
| Prop | Description | Type |
| ------------- |:-------------:| -----:|
| `rotation` | Change the angle of rgb channel splitting | number |
| `rgbOffset` | Describes the distance apart the RGB values should spread | number |
| `addBlur` | Add blur to the text | boolean |
| `addNoise` | Add noise distortion to text | boolean |
### Liquid distortion text
```jsx
import { LiquidDistortionText } from 'react-text-fun';
```
| Prop | Description | Type |
| ------------- |:-------------:| -----:|
| `speed` | Speed of the animation | number |
| `volatility` | Describes the change in distortion of a text | number |
## Styling text
You can use the below props with any of the above component to style the text. These are the common props.
| Prop | Description | Type |
| ------------- |:-------------:| -----:|
| `id` | An unique id for the canvas | string |
| `appendTo` | Specify an id for an element to which the canvas should be appended | string |
| `text` | Text string to render | string |
| `fontFamily` | Set a different font type | string |
| `fontSize` | Set the font size | number |
| `fontWeight` | Set the font weight | number |
| `fill` | Sets the text color | string |
| `fontStyle` | Specify a font style (italic, normal or bold) | string |
| `lineHeight` | Set the line height | number |
| `paddingTop` | Apply top padding | number |
| `paddingBottom` | Apply bottom padding | number |
| `paddingLeft` | Apply padding on left side | number |
| `paddingRight` | Apply padding on right side | number |
## Using text canvas
You can also access the canvas which renders the text using the callback function `get2dContext`. As the prop name suggests, the callback function receives the 2D rendering context for the drawing surface as an argument. This is useful if you want to update the canvas using any other third party library.
`get2dContext` can be used with any of the above material components. For instance, here is an example of how you would use it with `FliesText` component.
```jsx
console.log(ctx)} />
```
## Live examples
You can find the live code examples for all the components on the [codesandbox](https://codesandbox.io/embed/9jvp8n69kw)