README.md

An open-source, lightweight micro-frontend package for React.

✨ Features

• Zero dependency – This package works independently.
• Flexible – Styles can be inherited from parent.
• Simple – Uses basic CSS transition animations.
• Control – Customize colors, speed, direction.

⚡️ Getting Started

1. Install:

npm install text-reveal

2. Use:

  import TextReveal from 'text-reveal';

  <TextReveal 
    text={['Hello', 'world']} 
    textColor="grey" 
    fillColor="white" 
  />

3. Styles inherits from parent:

  <div style={{fontSize : '2rem', backgroundColor : 'black'}}>
    <TextReveal 
      text={['Hello', 'world']} 
      textColor="grey" 
      fillColor="white" 
    />
  </div>

📚 Docs

• Check out my documentation for guides and a full API reference.

💎 Contribute

• Want to contribute? I'd love that. Contributing guide got you covered.

👩🏻‍⚖️ License

• Text Reveal is MIT licensed.