0.0.5 • Published 3 months ago

@gseller-monorepo/title v0.0.5

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

Gseller Title

Componente criado com o intuito de padronizar os títulos do site Gseller

Props

  • title -> string (Conteúdo que aparecerá no título)
  • variant -> stringENUM (Opções da cor do texto)
  • size -> string ENUM (Opções do tamanho do texto)
  • isLoading -> boolean (Ao ser passado como true, aparecerá um skeleton)
  • html element props -> Propriedades nativas de um elemento HTML

Dependências

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

  • @gseller-monorepo/skeleton

Instalação

  yarn add @gseller-monorepo/title
  or
  npm install @gseller-monorepo/title
  or
  pnpm add @gseller-monorepo/title

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 global.css

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

Arquivo title.tsx

Arquivo que contém o componente de título

Pasta utils

Arquivo index.ts

Possui a função cn que utiliza das bibliotecas clsx, tailwind-merge e class-variance-authority, para que possamos fazer a interpolação de css, utilizando o classname, sem que haja conflito de classes