2.1.2 • Published 9 months ago

@pingu-components/react v2.1.2

Weekly downloads
-
License
-
Repository
github
Last release
9 months ago

@pingu-components/react

@pingu-components/react es una librería de componentes de React que permite la integración con un servicio de ratings para productos. Esta versión incluye tres componentes públicos: NewRating, OverallRating y ReviewsList.

Nota: Para utilizar estos componentes y obtener ratings visibles, debes contratar el servicio de ratings asociado.

Instalación

Instala la librería usando npm:

npm install @pingu-components/react

Componentes

1. NewReview

Permite a los usuarios crear un nuevo rating para un producto específico. Se utiliza proporcionando el id del producto y un token de autenticación. El onSubmit se ejecuta cuando el formulario se envía correctamente.

Props

PropTipoDescripciónOpcionalValor por defecto
idnumberID del producto al que se le agregará un rating.No-
tokenstringToken de autenticación para el servicio de ratings.No-
onSubmit() => voidCallback a ejecutar al enviar el formulario.No-
userWritterstringEs necesario para indicar el nombre de usuario del desarrollador de la Review. Es opcional agregarle el origen luego de un '-'No-
sizenumberTamaño de las estrellas del rating.22
bgColorstringColor de fondo del formulario.'white'
textColorstringColor del texto.'black'
fontFamilystringFamilia tipográfica a utilizar."'Arial', sans-serif"
starsColorstringColor de las estrellas.'gold'
borderColorstringColor del borde de los campos de formulario.'#d1d5db'
buttonColorstringColor del botón de envío.'blue'
buttonTextColorstringColor del texto del botón de envío.'white'

Ejemplo de uso

import NewRating from '@pingu-components/react';

<NewRating
  id={123}
  token="your-auth-token"
  onSubmit={() => alert('Review submitted!')}
  userWritter="Jane Doe - PinguStars"
/>

2. ReviewsList

Muestra una lista de reviews para un producto dado. También permite personalizar varios aspectos visuales como los colores, tamaños de texto y estrellas.

Props

PropTipoDescripciónOpcionalValor por defecto
idnumberID del producto para mostrar los reviews.No-
tokenstringToken de autenticación para el servicio de reviews.No-
onClick(id:number) =>voidComportamiento al clickear una reseña, pensado para navegar a una página con el detalle de la misma o un popUpNo-
bgColorstringColor de fondo de la lista de reviews.'white'
borderColorstringColor del borde de cada review.'#d1d5db'
shadowColorstringColor de la sombra cada review'#d1d5db'
skeletonColorstringColor de los placeholder de los skeletons de carga'#d1d5db'
buttonsBgColorstringColor de los botones de refresh y de paginación'gold'
buttonTextColorstringColor del texto de los botones de refresh y de paginación'black'
dropdownBgColorstringColor de fondo del dropdown de ordenamiento de reviews'#d1d5db'
dropdownTextColorstringColor del texto del dropdown'#d1d5db'
starsColorstringColor de las estrellas del rating.'gold'
starsSizenumberTamaño de las estrellas.20
mainTextColorstringColor principal del texto (títulos).'black'
secondaryTextColorstringColor secundario del texto (descripciones).'#4b5563'
fontFamilystringFamilia tipográfica a utilizar."'Arial', sans-serif"
limitnumberDefine el limite para cada API fetchundefined
loadMorepage | scroll | noneDefine el la forma de paginar los productos, en page, son paginas de reviews; en scroll, se recarga al llegar al final del scroll; en none, no hay paginación.'none'

Ejemplo de uso

import ReviewsList from '@pingu-components/react';

<ReviewsList
  id={123}
  token="your-auth-token"
  onClick={(id) => console.log(id)}
/>

3. OverallRating

Muestra el rating promedio de un producto específico.

Props

PropTipoDescripciónOpcionalValor por defecto
idnumberID del producto para mostrar el rating general.No-
tokenstringToken de autenticación para el servicio de ratings.No-
starsSizenumberTamaño de las estrellas.20
starsColorstringColor de las estrellas del rating.'gold'
borderColorstringColor del borde de las estrellas.'#d1d5db'
textColorstringColor del texto del rating promedio.'black'
fontFamilystringFamilia tipográfica a utilizar."'Arial', sans-serif"

Ejemplo de uso

import OverallRating from '@pingu-components/react';

<OverallRating
  id={123}
  token="your-auth-token"
/>

4. Review Detail

Muestra el detalle de una reseña segun su id.

Props

PropTipoDescripciónOpcionalValor por defecto
idnumberID de la reseña para mostrar al detalle.No-
tokenstringToken de autenticación para el servicio de ratings.No-
onClose()=>voidAcción a ejecutar luego de cerrar el detalle. Ideal para navegación.No-
sizenumberTamaño de las estrellas.20
starsColorstringColor de las estrellas del rating.'gold'
bgColorstrinsColor de fondo del componentewhite
borderColorstringColor del borde de las estrellas.'#d1d5db'
textColorstringColor del texto del rating promedio.'black'
fontFamilystringFamilia tipográfica a utilizar."'Arial', sans-serif"
buttonColorstringColor de fondo del botón de agregar producto.blue
buttonTextColorstringColor del texto del botón.white

Ejemplo de uso

import OverallRating from '@pingu-components/react';

<OverallRating
  id={123}
  token="your-auth-token"
/>

5. New Product

Componente para agregar un nuevo producto a la base de datos.

Props

PropTipoDescripciónOpcionalValor por defecto
tokenstringToken de autenticación para el servicio de ratings.No-
onSubmit() => voidFunción a ejecutar posterior a agregar el producto. Ideal para navegaciónNo-
bgColorstringColor de fondo del componentewhite
borderColorstringColor del borde de las estrellas.'#d1d5db'
textColorstringColor del texto del rating promedio.'black'
fontFamilystringFamilia tipográfica a utilizar."'Arial', sans-serif"
buttonColorstringColor de fondo del botón de agregar producto.gold
buttonTextColorstringColor del texto del botón.black

Ejemplo de uso

import OverallRating from '@pingu-components/react';

<OverallRating
  token="your-auth-token"
  onSubmit={() => console.log("Submitted")}
/>

Notas adicionales

  • Los componentes de esta librería no proporcionarán datos de ratings ni reviews si no tienes contratado el servicio de ratings. Asegúrate de obtener las credenciales de autenticación (token) de tu proveedor de ratings para que los componentes funcionen correctamente.
  • Personaliza la apariencia de los componentes a través de las props proporcionadas, permitiendo adaptarlos al diseño de tu sitio.
2.0.2-beta.9

9 months ago

2.0.2-beta.11

9 months ago

2.0.2-beta.10

9 months ago

2.1.2

9 months ago

2.1.1

9 months ago

2.1.0

9 months ago

2.0.2-beta.1

9 months ago

2.0.2-beta.2

9 months ago

2.0.2-beta.3

9 months ago

2.0.2-beta.4

9 months ago

2.0.2-beta.5

9 months ago

2.0.2-beta.6

9 months ago

2.0.2-beta.7

9 months ago

2.0.1

9 months ago

2.0.0

9 months ago

1.1.2

9 months ago

1.1.1

9 months ago

1.1.0

10 months ago

1.0.0-1

10 months ago

1.0.0

10 months ago