react-lgpd-consent 🍪

Uma biblioteca React para gerenciamento de consentimento de cookies em conformidade com a LGPD.

Instalação • Uso Básico • 📚 Guia de Início Rápido • Documentação • 🇺🇸 🇬🇧 English • Contribuir

Comece por aqui: siga o Guia de Início Rápido (QUICKSTART.md) para um tutorial passo-a-passo, exemplos TypeScript, tabela de props e integração com MUI — recomendado para usuários novos.

🚀 Instalação

npm install react-lgpd-consent @mui/material @emotion/react @emotion/styled js-cookie
Copy

Dependências peer: react, react-dom, @mui/material e js-cookie.

📖 Uso Básico

Envolva sua aplicação com o ConsentProvider (exemplo mínimo):

import { ConsentProvider } from 'react-lgpd-consent'

export default function App() {
  return (
    <ConsentProvider categories={{ enabledCategories: ['analytics'] }}>
      <YourApp />
    </ConsentProvider>
  )
}
Copy

📚 Documentação Completa

Para mais detalhes sobre customização, hooks e funcionalidades, consulte os seguintes guias:

📋 Documentação Principal

• 📚 Guia de Início Rápido (QUICKSTART.md): Tutorial passo a passo com exemplos práticos, tabela completa de props, debugging e integrações.
• Guia da API (API.md): Referência completa de todos os componentes, hooks e tipos.
• Guia de Conformidade (CONFORMIDADE.md): Detalhes sobre as funcionalidades de conformidade com a LGPD.
• Guia de Integrações (INTEGRACOES.md): Como usar as integrações nativas e criar as suas.

🎨 Documentação Interativa (GitHub Pages)

• 📖 Storybook - Playground Interativo: Explore e teste todos os componentes em tempo real com controles interativos.
• ⚙️ TypeDoc - Referência de API: Documentação completa da API gerada automaticamente.
• 🏠 Portal de Documentação: Página inicial com navegação entre todas as documentações.

🤝 Como Contribuir

1. Abra uma Issue para bugs ou melhorias.
2. Siga o Guia de Desenvolvimento em DEVELOPMENT.md para enviar um PR.

📄 Licença

MIT — veja o arquivo LICENSE.