sgc-coppel-ui

Librería de componentes UI para proyectos de Coppel SGC, construida con React, TypeScript y Vite.

Instalación

Instala el paquete desde npm:

npm install sgc-coppel-ui

Peer Dependencies

Asegúrate de tener instaladas las siguientes dependencias en tu proyecto:

• react >= 18.0.0
• react-dom >= 18.0.0
• primereact >= 10.0.0
• primeicons >= 7.0.0

Uso

1. Importar Estilos

Es crucial importar el archivo de estilos CSS en el punto de entrada de tu aplicación (por ejemplo, App.tsx o main.tsx):

import 'sgc-coppel-ui/style.css';

2. Importar Componentes

Importa los componentes directamente desde la librería:

import { CopelLogo, CopelDialogoGenerico } from 'sgc-coppel-ui';

function App() {
  return (
    <div>
      <CopelLogo modo="claro" />
      <CopelDialogoGenerico 
        titulo="Alerta" 
        mensaje="Operación exitosa" 
        tipo="exito"
        visible={true}
        onHide={() => console.log('Cerrado')}
      />
    </div>
  );
}

Desarrollo (Storybook)

Esta librería incluye un entorno de documentación interactiva con Storybook. Para ver los componentes en desarrollo o explorar la documentación:

1. Clona el repositorio.
2. Instala las dependencias:

   npm install

3. Ejecuta Storybook:

   npm run storybook

Esto abrirá una interfaz local (usualmente en http://localhost:6006) donde podrás probar cada componente de forma aislada.

Construcción (Build)

Para generar los archivos de distribución (dist):

npm run build