stj-components v1.0.22

Paquete de componentes React para el STJ

Instalación

npm install stj-components

Las siguientes dependencias deben estar instaladas:

• @emotion/react: ^11.10.4,
• @emotion/styled: ^11.10.4,
• @mui/icons-material: ^5.10.3,
• @mui/material: ^5.10.5,
• axios: ^0.27.2,
• formik: ^2.2.9,
• react: ^17.0.2,
• react-dom: ^17.0.2,
• react-hot-toast: ^2.4.0,
• react-query: ^3.39.2,
• react-router-dom: ^6.4.0,
• universal-cookie: ^4.0.4,
• @tinymce/tinymce-react: ^4.2.0
• @types/react: ^17.0.42

Estructura

Hay tres carpetas principales (módulos) dentro de src:

• components: Aquí van los componentes cada uno en una carpeta, que debe tener mínimo tres archivos principales,
  • componente.tsx -> componente en sí
  • componente.types.ts -> tipos de los props y otros tipos necesarios
  • index.ts -> exportar el componente default
• services: Aquí van los hooks y otros utilitarios.
• contexts: Aquí van los contexts y los providers.

Las carpetas y componentes deben ser en PascalCase. Los hooks deben comenzar con "use".

Cada carpeta con un componente, servicio o contexto, debe tener un index.ts que exporta el default, así:

export { default } from "./componente";

Cada módulo principal debe tener un index.ts que exporta cada default, así:

export { default as componente1 } from "./componente1";
export { default as componente2 } from "./componente2";
export { default as componente3 } from "./componente3";

Luego, src exporta:

export * from './components';
export * from './services';
export * from './contexts';

Modificar

1. Descargarse el repositorio.
2. Agregar, o modificar, el componente/servicio/contexto como se indica en la sección Estructura.
3. Build:
   1. En la terminal npm run build
4. Para probarlo se puede:
   1. cd a este paquete.
   2. En la terminal: npm link
   3. cd al entorno de prueba, con las deps. instaladas.
   4. En la terminal: npm link stj-components y ya se puede acceder.
5. Para subirlo:
   1. Cambiar la versión en el archivo package.json, según semver.
   2. Si es la primera vez, en la terminal: npm login
   3. En la terminal: npm publish