https://github.com/omnedia/ngx-word-rotation
A simple component library to animate text.
https://github.com/omnedia/ngx-word-rotation
Last synced: 7 months ago
JSON representation
A simple component library to animate text.
- Host: GitHub
- URL: https://github.com/omnedia/ngx-word-rotation
- Owner: omnedia
- License: mit
- Created: 2024-07-05T23:39:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-12T01:40:48.000Z (11 months ago)
- Last Synced: 2025-04-15T02:44:27.836Z (7 months ago)
- Language: TypeScript
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- trackawesomelist - ngx-word-rotation (⭐0) - An Angular library designed to facilitate word rotation animations within Angular applications. (Recently Updated / [Oct 01, 2024](/content/2024/10/01/README.md))
- awesome-angular - ngx-word-rotation - An Angular library designed to facilitate word rotation animations within Angular applications. (Third Party Components / Animations)
- fucking-awesome-angular - ngx-word-rotation - An Angular library designed to facilitate word rotation animations within Angular applications. (Third Party Components / Animations)
README
# ngx-word-rotation
This Library is part of the NGXUI ecosystem.
View all available components at https://ngxui.com
`@omnedia/ngx-word-rotation` is an Angular library designed to facilitate word rotation animations within Angular applications.
## Features
- Rotate words within your Angular application.
- Easily customizable.
## Installation
Install the library using npm:
```bash
npm install @omnedia/ngx-word-rotation
```
## Usage
Import the `NgxWordRotationComponent` in your Angular module:
```typescript
import {NgxWordRotationComponent} from '@omnedia/ngx-word-rotation';
@Component({
...
imports:
[
...
NgxWordRotationComponent,
],
...
})
```
Use the component in your template:
```html
```
## API
```html
```
Starts the word rotation effect.
- `words`: An array of strings to be animated.
- `reverseAnimation`: (optional): Reverses the animation direction. Default is false.
- `wordDelay`: (optional): The delay between the animation to the next word / how long a word stays in milliseconds. Default is 2500.
- `enterDelay`: (optional): The animation delay for the entering word in milliseconds. Default is 200.
- `styleClass`: (optional): Add a class to the `
` wrapper tag.
## Contributing
Contributions are welcome. Please submit a pull request or open an issue to discuss your ideas.
## License
This project is licensed under the MIT License.
For more information, visit the [GitHub repository](https://github.com/omnedia/ngx-word-rotation)