1.0.0 • Published 1 year ago

react-slider-gv v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

react-slider-gv

Desarrollado por Gastón Valentini

Este paquete se trata de un componente versátil y fácil de usar que le permitirá agregar carruseles interactivos a sus aplicaciones web desarrolladas con React. Con este componente, puede crear presentaciones de diapositivas dinámicas y atractivas para mostrar contenido de manera efectiva a los usuarios.

Tabla de Contenidos

  1. Características
  2. Instalación
  3. Prop types y valores por defecto
  4. Contribución
  5. Desarrollador
  6. Licencia

Características

  • Personalizable: Ofrece una variedad de opciones de personalización como ajuste de dimensiones, efecto y velocidad de transición, diferentes formatos de navegación y más. Puedes adaptar el aspecto y la funcionalidad del carrusel para que se ajuste perfectamente a tus necesidades y estilo de diseño.

  • Fácil de usar: Con una interfaz simple y clara, la integración en sus proyectos es rápida y sencilla. Simplemente importe el componente en su aplicación y pase los elementos deseados como contenido.

  • Control de navegación: Incluye botones de navegación incorporados que permiten a los usuarios avanzar y retroceder entre las diapositivas con facilidad. Esto ofrece una experiencia de usuario intuitiva y mejorada.

Instalación

Para implementar esta librería simplemente debe seguir los siguientes pasos:

1º Instalación del paquete

Ubicado en la raíz del proyecto ejecute el siguiente comando:

npm install react-slider-gv

2º Importación

Importe el componente Slider y sus estilos en su proyecto:

import Slider from "react-slider-gv";
import "react-slider-gv/dist/style.css";

3º Implementación

Para utilizar la librería, implemente el componente en su aplicación y pase los elementos deseados como contenido:

export default function App() {
    return (
        <Slider>
            <div>Slide 1</div>
            <div>Slide 2</div>
            <div>Slide 3</div>
        </Slider>
    );
}

4º Personalización

Puede personalizar aún más el carrusel pasando configuraciones como props:

export default function App() {
    const settings = {
        // Se muestra el objeto de configuración como ejemplo con los valores por defecto
        height: "100%",
        width: "100%",
        smooth: false,
        smoothTime: "0.3",
        infiniteScroll: false,
        dots: false,
        arrows: true,
        autoplay: false,
        autoplayInterval: 3000,
        initialSlide: 0,
    };

    return (
        <Slider settings={settings}>
            <div>Slide 1</div>
            <div>Slide 2</div>
            <div>Slide 3</div>
        </Slider>
    );
}

Prop types y valores por defecto

En la siguiente tabla se muestra el tipo de dato y el valor por defecto de las propiedades del objeto de configuración:

PropTipoValor por DefectoDescripción
heightstring"100%"Alto del carrusel
widthstring"100%"Ancho del carrusel
smoothbooleanfalseDefine si el carrusel tiene una transición suave
smoothTimestring"0.3s"Duración de la transición en segundos (Debe ser menor o igual que la propiedad autoplayInterval)
infiniteScrollbooleanfalseDefine si el carrusel tiene scroll infinito
dotsbooleanfalseDefine si el carrusel tendrá el navbar con puntos
arrowsbooleantrueDefine si el carrusel tendrá las flechas para navegar
autoplaybooleanfalseDefine si el carrusel cambiará automáticamente de diapositivas
autoplayIntervalnumber3000Intervalo entre el cambio de las diapositivas (ms) (No se recomienda que sea inferior a 1000)
initialSlidenumber0Diapositiva inicial que se mostrará en el carrusel

Contribución

¡Contribuciones son bienvenidas! Si tienes ideas para mejorar este proyecto o encuentras algún problema, por favor abre un pull request en GitHub.

  1. Haz un fork del proyecto.
  2. Crea una nueva rama (git checkout -b feature/nueva-funcionalidad).
  3. Realiza los cambios necesarios y realiza los commits (git commit -m 'Agrega nueva funcionalidad').
  4. Empuja tus cambios (git push origin feature/nueva-funcionalidad).
  5. Abre un pull request.

Desarrollador - Gastón Valentini

Licencia

Este proyecto está licenciado bajo la Licencia MIT. Consulta el archivo LICENSE para más detalles.

Volver al inicio

1.0.0

1 year ago