@el7ven/cookie-kit 0.2.15

package/README.md

@@ -0,0 +1,201 @@
+# @el7ven/cookie-consent
+
+> Unified cookie consent management for GDPR compliance with React and Vue support
+
+[![npm version](https://badge.fury.io/js/@el7ven%2Fcookie-consent.svg)](https://badge.fury.io/js/@el7ven%2Fcookie-consent)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A comprehensive, production-ready cookie consent solution that helps websites comply with GDPR and other privacy regulations. Built with modern JavaScript and supports React, Vue, and vanilla JS applications.
+
+## ✨ Features
+
+- 🚀 **Unified Package** - One dependency for all frameworks
+- 📱 **Framework Agnostic** - Works with React, Vue, and vanilla JS
+- 🔒 **GDPR Compliant** - Privacy-first approach with opt-in consent
+- 🎨 **Customizable UI** - Built-in components or bring your own
+- 📦 **Tree Shakable** - Only bundle what you use
+- 🔄 **Event Driven** - Listen to consent changes in real-time
+- 💾 **Persistent Storage** - Automatic localStorage management
+- 🌍 **Internationalization Ready** - Multi-language support
+
+## 📦 Installation
+
+```bash
+npm install @el7ven/cookie-consent@beta
+```
+
+## 🚀 Quick Start
+
+### Vanilla JavaScript
+
+```javascript
+import { createCookieConsent } from '@el7ven/cookie-consent'
+import '@el7ven/cookie-consent/styles'
+
+const cookieConsent = await createCookieConsent({
+  categories: {
+    necessary: { required: true, enabled: true },
+    analytics: { required: false, enabled: false },
+    marketing: { required: false, enabled: false }
+  },
+  onConsentChange: (consent) => {
+    console.log('Consent updated:', consent)
+  }
+})
+
+// Accept all cookies
+cookieConsent.acceptAll()
+
+// Check consent
+const consent = cookieConsent.getConsent()
+console.log('Analytics enabled:', consent.categories.analytics.enabled)
+```
+
+### React
+
+```jsx
+import { CookieKitProvider, useCookieKit } from '@el7ven/cookie-consent/react'
+import '@el7ven/cookie-consent/styles'
+
+function App() {
+  return (
+    <CookieKitProvider config={{
+      categories: {
+        necessary: { required: true, enabled: true },
+        analytics: { required: false, enabled: false }
+      }
+    }}>
+      <MyComponent />
+    </CookieKitProvider>
+  )
+}
+
+function MyComponent() {
+  const { consent, acceptAll, rejectAll } = useCookieKit()
+  
+  return (
+    <div>
+      <p>Analytics: {consent.categories.analytics.enabled ? 'Enabled' : 'Disabled'}</p>
+      <button onClick={acceptAll}>Accept All</button>
+      <button onClick={rejectAll}>Reject All</button>
+    </div>
+  )
+}
+```
+
+### Vue
+
+```vue
+<template>
+  <div>
+    <p>Analytics: {{ consent.categories.analytics.enabled ? 'Enabled' : 'Disabled' }}</p>
+    <button @click="acceptAll">Accept All</button>
+    <button @click="rejectAll">Reject All</button>
+  </div>
+</template>
+
+<script setup>
+import { useCookieKit } from '@el7ven/cookie-consent/vue'
+import '@el7ven/cookie-consent/styles'
+
+const { consent, acceptAll, rejectAll } = useCookieKit({
+  categories: {
+    necessary: { required: true, enabled: true },
+    analytics: { required: false, enabled: false }
+  }
+})
+</script>
+```
+
+## 📖 API Reference
+
+### Core Methods
+
+| Method | Description |
+|--------|-------------|
+| `acceptAll()` | Accept all cookie categories |
+| `rejectAll()` | Reject all non-essential cookies |
+| `acceptSelected(ids)` | Accept specific categories |
+| `clearConsent()` | Clear all consent data |
+| `getConsent()` | Get current consent state |
+| `hasCategoryConsent(category)` | Check consent for specific category |
+
+### Events
+
+```javascript
+cookieConsent.on('consentChanged', ({ consent }) => {
+  // Handle consent changes
+})
+
+cookieConsent.on('consentCleared', () => {
+  // Handle consent clearing
+})
+```
+
+### Configuration Options
+
+```javascript
+const config = {
+  categories: {
+    necessary: { required: true, enabled: true },
+    analytics: { required: false, enabled: false },
+    marketing: { required: false, enabled: false },
+    functional: { required: false, enabled: false },
+    performance: { required: false, enabled: false },
+    social: { required: false, enabled: false }
+  },
+  storageKey: 'cookie_consent',
+  consentExpireDays: 365,
+  onConsentChange: (consent) => {},
+  onConsentCleared: () => {}
+}
+```
+
+## 🎨 Customization
+
+### CSS Variables
+
+```css
+:root {
+  --ck-primary: #007bff;
+  --ck-secondary: #6c757d;
+  --ck-success: #28a745;
+  --ck-danger: #dc3545;
+  --ck-background: #ffffff;
+  --ck-text: #333333;
+  --ck-border: #dee2e6;
+}
+```
+
+### Custom Components
+
+```javascript
+import { createCookieKit } from '@el7ven/cookie-consent'
+
+const cookieKit = createCookieKit(config)
+
+// Build your own UI
+const consent = cookieKit.getConsent()
+// Render your custom banner
+```
+
+## 🌍 Browser Support
+
+- Chrome 60+
+- Firefox 55+
+- Safari 12+
+- Edge 79+
+
+## 📄 License
+
+MIT © [Igor Semionov](https://github.com/El7ven)
+
+## 🤝 Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](../../CONTRIBUTING.md) for details.
+
+## 📞 Support
+
+- 📖 [Documentation](https://github.com/El7ven/cookie-kit#readme)
+- 🐛 [Issues](https://github.com/El7ven/cookie-kit/issues)
+- 💬 [Discussions](https://github.com/El7ven/cookie-kit/discussions)