https://github.com/omnedia/ngx-word-rotation

A simple component library to animate text.
https://github.com/omnedia/ngx-word-rotation

Last synced: about 2 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 (7 months ago)
• Default Branch: main
• Last Pushed: 2024-08-24T15:59:34.000Z (5 months ago)
• Last Synced: 2024-11-09T11:51:33.126Z (2 months ago)
• Language: TypeScript
• Homepage:
• Size: 9.77 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. (Table of contents / Third Party Components)
• fucking-awesome-angular - ngx-word-rotation - An Angular library designed to facilitate word rotation animations within Angular applications. (Table of contents / Third Party Components)

README

        
# ngx-word-rotation

`@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)