text-particles
v1.0.6
Published
Create interactive particle effects from text.
Downloads
13
Maintainers
Readme
react-image-particles
A React component that converts any text into interactive particles.
Installation
Using npm:
npm install text-particles
Using yarn:
yarn add text-particles
Usage
import TextToParticles from 'text-particles';
const App = () => {
return (
<TextToParticles
text="Hi mom!"
fontSize={100}
color="orange"
/>
);
};
export default App;
Props
The <TextToParticles>
component accepts the following props:
text
(string) required: Text to apply the effect to.font
(string) optional: Font to use, e.g.'Arial'
. Defaults tosans-serif
.fontSize
(number) optional: Font size in pixels. Defaults to30
.color
(string) optional: Color of the particles, e.g.orange
,#FFA500
,rgb(255 165 0 / 100%)
. Defaults to black.backgroundColor
(string) optional: Hex code for the background color of the particles. If not specified, the background will be transparent.mouseRadius
(number) optional: Radius of the mouse interaction in pixels. Defaults tofontSize / 3
.numParticles
(number) optional: Number of particles to use.particleSize
(number) optional: Size of each particle in pixels. Defaults to2
.
Author
Samuel Henderson
Contributions are welcome! Repo: https://github.com/samzi123/text-particles
License
MIT