react-lgpd-consent 🍪

A React library for cookie consent management compliant with Brazil's LGPD.

Installation • Basic Usage • 📚 Quickstart • Documentation • Contributing

Start here: follow the Quickstart guide (QUICKSTART.en.md) for step-by-step setup, TypeScript examples, props summary and MUI integration — recommended for new users.

🚀 Installation

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

Peer dependencies: react, react-dom, @mui/material and js-cookie.

📖 Basic Usage

Wrap your app with ConsentProvider (minimal example):

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

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

• For full guides, TypeScript examples, props table and integrations see:
• QUICKSTART.en.md (recommended)
• Docs / API
• LGPD Compliance
• Integrations

🎨 Interactive Documentation (GitHub Pages)

• 📖 Storybook - Interactive Playground: Explore and test all components live with interactive controls.
• ⚙️ TypeDoc - API Reference: Automatically generated complete API documentation.
• 🏠 Documentation Portal: Home page that navigates between all docs sites.

🤝 Contributing

1. Open an Issue for bugs or feature requests.
2. Follow DEVELOPMENT.md to submit a PR.

📄 License

MIT — see the LICENSE file.