https://github.com/creatlydev/rollup-text

componente web interactivo que anima la transición de palabras mediante desplazamiento vertical de letras. Puedes personalizar la animación, los estilos y la velocidad con propiedades personalizadas.
https://github.com/creatlydev/rollup-text

css custom-elements text-animation web-component

Last synced: 3 months ago
JSON representation

componente web interactivo que anima la transición de palabras mediante desplazamiento vertical de letras. Puedes personalizar la animación, los estilos y la velocidad con propiedades personalizadas.

• Host: GitHub
• URL: https://github.com/creatlydev/rollup-text
• Owner: Creatlydev
• Created: 2024-08-16T23:37:16.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-20T22:23:54.000Z (5 months ago)
• Last Synced: 2024-10-14T02:03:09.276Z (3 months ago)
• Topics: css, custom-elements, text-animation, web-component
• Language: JavaScript
• Homepage:
• Size: 6.52 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
RollupText 🌟




  








RollupText es un componente web interactivo que anima la transición de palabras mediante el desplazamiento vertical de letras. Puedes personalizar la animación, los estilos y la velocidad con diversas propiedades. Este componente es compatible con palabras de distintas longitudes y permite cualquier tipo de caracteres.


## Instalación 🚀

Para instalar `rollup-text` desde npm, utiliza el siguiente comando:

```bash

npm install rollup-text

```

Después de la instalación, importa el componente en tu proyecto:

```javascript

import { RollupText } from 'rollup-text';

```

También puedes usarlo directamente desde un CDN:

```javascript

import { RollupText } from 'https://cdn.jsdelivr.net/npm/rollup-text@latest/src/index.js';

```

## Configuración de Caracteres 🛠️

Puedes configurar los caracteres que deseas que estén disponibles utilizando el método estático configure. Esto es útil para especificar las letras que quieres que esten disponibles, por ejemplo si solo usaras letras del alfabeto y no numeros puedes configurarlo a tu gusto esto ayudara a no crear caracteres que no se usaran nunca, lo cual ayudara en el performance:

```javascript

// Solo letras del abecedario y unos cuantos caracteres especiales

RollupText.configure({

  letters: "ABCDEFGHIJKLMNOPQRSTUVWXYZ!@#"

});

```

## Uso 📚

Una vez configurado, puedes utilizar el componente en tu HTML. Aquí tienes un ejemplo básico:

```html

```

## Personalización 🎨

El componente es altamente personalizable mediante los siguientes atributos:

### Atributos Disponibles

- **`words`**: Un array de palabras que el componente animará. Ahora se permite usar palabras de longitudes diferentes y cualquier tipo de caracteres.

- **`text-case`**: Define el caso del texto. Puede ser uppercase, lowercase, o dejarse vacío para mantener el caso original.

- **`word-interval`**: Intervalo en milisegundos entre cada cambio de palabra.

- **`scroll-speed`**: Velocidad de desplazamiento de las letras en milisegundos.

- **`animation-curve`**: La curva de animación. Puede ser linear o bezier.

- **`distance-based-scroll`**: Si se especifica, el scroll se basará en la distancia entre letras, en lugar de una velocidad fija.

## Código Abierto y Contribuciones 🤝

Este proyecto es de código abierto y cualquier persona es bienvenida a contribuir. Si tienes ideas, mejoras o encuentras algún problema, no dudes en hacer un pull request o abrir un issue🚀