@gseller-monorepo/description-box
v0.0.3
Published
Gseller description-box
Downloads
6
Maintainers
Readme
Gseller Description Box
Componente criado com o intuito de exibir informações, seja de um usuário, por exemplo. Ele possui uma estrutura bem simples, sendo necessário passar 3 informações.
Props
icon
-> ReactNode (Icone para aparecer ao lado esquerdo do título)title
-> string (Título que irá aparecer ao lado direito do icone)description
-> string (Descrição para explicar do que se trata o título)
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:
@gseller-monorepo/skeleton
Instalação
yarn add @gseller-monorepo/description-box
or
npm install @gseller-monorepo/description-box
or
pnpm add @gseller-monorepo/description-box
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 upload-image.css
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