Icons Caral

Esta guía detalla el proceso de instalación y uso de la librería de iconos Caral Icons.

Nuevas funciones en esta versión

1. Separación de tipos en un archivo dedicado :
   • Se ha creado un archivo types.ts que contiene todas las definiciones de tipos ( CaralBrandName , Icons , BrandProps , IconPropsProps )
   • Esto mejora la organización y facilita la mantenibilidad del código.
2. Simplificación de la estructura de exportación :

• Se ha eliminado la exportación directa de los componentes en main.tsx y se ha movido a module.d.ts
• Esto simplifica la estructura de exportación y reduce la cantidad de código exportado.

3. Exportación de tipos :

• Se ha exportado el archivo types.ts para que los usuarios puedan acceder a los tipos definidos.
• Esto mejora la documentación y facilita el uso de la librería.

4. Correcion de importacion y exportacion
   • Actualicé main.tsx para importar los tipos desde types.ts y re-exportarlos
   • Actualicé index.d.ts para re-exportar los tipos desde types.ts

1. Instalación Para instalar la librería, ejecuta el siguiente comando en la consola:

  npm i iconcaral2

2. Importación Hay dos formas de importar los iconos, dependiendo de tus necesidades: a) Para iconos con color personalizable:

  import { CaralIcon } from 'iconcaral2';

b) Para iconos con los colores propios de las marcas:

  import { Brand } from 'iconcaral2';

3. Uso Para utilizar un icono, usa la siguiente estructura:

  <CaralIcon name='AWS'/>

4. Personalización

a) Tamaño: Puedes especificar el tamaño usando valores predefinidos o numéricos:

  <CaralIcon name='AWS' size='m'/>
  <CaralIcon name='AWS' size={240}/>

  // Para iconos de marca
  <Brand name='AWS' size='m'/>
  <Brand name='AWS' size={240}/>

Los valores predefinidos son: "s" | "m" | "l" | "xl" b) Color: Solo puedes modificar el color en CaralIcon usando el prop 'color':

  <CaralIcon name='AWS' color='#000'/>

Esta estructura mejorada proporciona una guía más clara y fácil de seguir para los usuarios de la librería Caral Icons.