0.0.1 • Published 3 months ago

@gseller-monorepo/card-summary v0.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
3 months ago

Gseller Description Card Summary

Componente criado com o intuito de exibir um card com um ícone, título e um valor total, para que possa exibir um resumo de informações de forma clara e objetiva.

Props

  • icon
  • title
  • value

Lembrete

  • A alteração das cores não é possível de ser realizada, pois o componente foi pensado para seguir a estrutura e cores do Gseller

Dependências

Certifique-se de ter as seguintes dependências instaladas:

  • tailwindcss
  • postcss
  • autoprefixer
  • tailwind-merge
  • clsx
  • @gseller-monorepo/box-model

Instalação

  yarn add @gseller-monorepo/card-summary
  or
  npm install @gseller-monorepo/card-summary
  or
  pnpm add @gseller-monorepo/card-summary

Estrutura de Pastas e Arquivos

A estrutura do projeto é organizada para facilitar a compreensão e manutenção.

Pasta src

Arquivo index.ts

Responsável pela exportação de todos os arquivos necessários para utilização do componente

Arquivo card-summary.tsx

Arquivo que define os resets e css base para utilização do tailwindcss

Pasta utils

Arquivo index.ts

Possui a função cn que utiliza da biblioteca clsx e tailwind-merge, para que possamos fazer a interpolação de css, utilizando o classname, sem que haja conflito de classes