TextFX for the terminal.
npm install flossumtypeOut)
reverseType)
wave)
colorPulse)
spinner)
progressBar)
glitch)
scramble)
rainbow)
playFrames)
asciiArt)
flash)
typeDelete)
dots)
bash
npm install flossum
`
Or for CLI usage:
`bash
npm install -g flossum
`
🧪 Usage (API)
`js
import flossum from 'flossum';
await flossum.typeOut("🚀 Welcome to Flossum!", 60);
await flossum.wave("✨ Watch the magic unfold...", { duration: 1800 });
await flossum.progressBar({ width: 20, duration: 1500 });
await flossum.colorPulse("🌈 Feel the rainbow energy!");
await flossum.playFrames([
'[ ]', '[= ]', '[== ]', '[=== ]', '[==== ]', '[=====]', '[ ====]', '[ ===]', '[ ==]', '[ =]', '[ ]',
], { interval: 3000, delay: 90, repeat: 3});
await flossum.dots("Loading", {
cycles: 5,
interval: 300,
char: ".",
maxDots: 3
});
`
⚙️ CLI Usage
For detailed command usage, see COMMAND.md
🎬 Demo
`bash
node examples/demo.js
`
or
`bash
npm run demo
`
This will run a showcase of all available animations. Perfect for testing purposes!
📁 Project Structure
`
flossum/
├── lib/
│ ├── core/ # Utilities and frame player
│ ├── simple/ # Basic animations
│ └── effects/ # Text effects (wave, glitch, etc.)
├── examples/ # Example usage scripts
├── bin/ # CLI entrypoint
├── index.js # Export API
├── package.json
└── README.md
`
🧑💻 Contributing
1. Fork the repo
2. Create a new branch: git checkout -b feature/new-animation
3. Add your effect in the correct folder (simple/effects/core)
4. Test it in examples/`