@gseller-monorepo/breadcrumbs
v0.0.6
Published
Gseller breadcrumbs
Downloads
6
Readme
Gseller Breadcrumbs
Componente criado para auxiliar na navegação do site
Props
crumbsToTranslate
-> Record<string, string> (Lista de crumbs para ser inserido e traduzido)homeLink
-> string (Link para a home do site ou qualquer outro link que você deseja)listOfUniquesPages
-> string[] (Lista de páginas que serão únicas, evitando, assim, links que não existam)
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
Instalação
yarn add @gseller-monorepo/breadcrumbs
or
npm install @gseller-monorepo/breadcrumbs
or
pnpm add @gseller-monorepo/breadcrumbs
Estrutura de Pastas e Arquivos
A estrutura do projeto é organizada para facilitar a compreensão e manutenção.
Pasta src
Arquivo breadcrumbs.tsx
Responsável pela exportação da lógica de todo o componente
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
Pasta types
Arquivo breadcrumbs.type.ts
Arquivo com as tipagens usadas no componente
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