https://github.com/omnedia/ngx-gradient-text
A simple component library to animate text.
https://github.com/omnedia/ngx-gradient-text
Last synced: 11 days ago
JSON representation
A simple component library to animate text.
- Host: GitHub
- URL: https://github.com/omnedia/ngx-gradient-text
- Owner: omnedia
- License: mit
- Created: 2024-08-20T11:46:06.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-12-12T01:40:49.000Z (5 months ago)
- Last Synced: 2025-04-15T02:44:12.599Z (11 days ago)
- Language: TypeScript
- Size: 5.86 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- trackawesomelist - ngx-gradient-text (⭐0) - An Angular library that provides a dynamic gradient animation effect for text. This component allows you to display text with a smooth, animated gradient that transitions between two customizable colors. (Recently Updated / [Oct 01, 2024](/content/2024/10/01/README.md))
- awesome-angular - ngx-gradient-text - An Angular library that provides a dynamic gradient animation effect for text. This component allows you to display text with a smooth, animated gradient that transitions between two customizable colors. (Table of contents / Third Party Components)
- fucking-awesome-angular - ngx-gradient-text - An Angular library that provides a dynamic gradient animation effect for text. This component allows you to display text with a smooth, animated gradient that transitions between two customizable colors. (Table of contents / Third Party Components)
README
# ngx-gradient-text
This Library is part of the NGXUI ecosystem.
View all available components at https://ngxui.com
`@omnedia/ngx-gradient-text` is an Angular library that provides a dynamic gradient animation effect for text. This component allows you to display text with a smooth, animated gradient that transitions between two customizable colors.
## Features
- Animated gradient effect for text.
- Customizable gradient start and end colors.
- Lightweight and easy to integrate as a standalone component.
## Installation
Install the library using npm:
```bash
npm install @omnedia/ngx-gradient-text
```
## Usage
Import the `NgxGradientTextComponent` in your Angular module or component:
```typescript
import {NgxGradientTextComponent} from '@omnedia/ngx-gradient-text';
@Component({
...
imports:
[
...
NgxGradientTextComponent,
],
...
})
```
Use the component in your template:
```html
```
## API
```html
```
- `text` (required): The text content to be displayed with the gradient effect.
- `gradientStart` (optional): The starting color of the gradient. Accepts any valid CSS color value.
- `gradientEnd` (optional): The ending color of the gradient. Accepts any valid CSS color value.
- `styleClass` (optional): A custom CSS class to apply to the gradient text element.
## Example
```html
```
This will create an animated gradient text effect where the text "Hello World!" smoothly transitions between pink and blue-violet.
## Styling
To customize the appearance of the gradient text, use the styleClass input to apply your own CSS classes.
```css
.gradient-text-style {
font-size: 48px;
font-weight: bold;
font-family: 'Verdana', sans-serif;
}
```
This will style the gradient text with a custom font size, weight, and font family.
## 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.