@privacykit/web 0.1.12 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +0 -1
- package/package.json +1 -1
- package/privacykit.d.ts +4 -0
- package/readme.md +63 -2
package/dist/index.js
CHANGED
package/package.json
CHANGED
package/privacykit.d.ts
CHANGED
|
@@ -156,6 +156,8 @@ declare global {
|
|
|
156
156
|
showFab: boolean;
|
|
157
157
|
/** Position of the FAB in the viewport. @default 'left' */
|
|
158
158
|
fabPosition: 'left' | 'right';
|
|
159
|
+
/** Position of the dialog on non-mobile viewports. Applies to 'modern' (slide-in panel) and 'modest' (corner popup) variants. @default 'left' */
|
|
160
|
+
dialogPosition: 'left' | 'right';
|
|
159
161
|
/** Whether the dialog is currently open. @default false */
|
|
160
162
|
open: boolean;
|
|
161
163
|
|
|
@@ -292,6 +294,8 @@ interface ConsentDialogJSXProps {
|
|
|
292
294
|
'show-fab'?: boolean | '';
|
|
293
295
|
/** Position of the FAB: bottom-left or bottom-right. @default 'left' */
|
|
294
296
|
'fab-position'?: 'left' | 'right';
|
|
297
|
+
/** Position of the dialog on non-mobile viewports. Applies to 'modern' and 'modest' variants. @default 'left' */
|
|
298
|
+
'dialog-position'?: 'left' | 'right';
|
|
295
299
|
/** Open/close state. */
|
|
296
300
|
'open'?: boolean | '';
|
|
297
301
|
'ref'?: CKRef<HTMLConsentDialogElement>;
|
package/readme.md
CHANGED
|
@@ -1,5 +1,66 @@
|
|
|
1
1
|
# PrivacyKit
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Consent management, enforcement, and runtime compliance validation in one platform.
|
|
4
4
|
|
|
5
|
-
https://www.privacykit
|
|
5
|
+
[](https://www.npmjs.com/package/@privacykit/web)
|
|
6
|
+
[](https://www.privacykit.eu)
|
|
7
|
+
|
|
8
|
+
**[Quick Start](https://www.privacykit.eu/en/quick-start) · [Web Components](https://www.privacykit.eu/en/web-components) · [API Reference](https://www.privacykit.eu/en/api-reference) · [privacykit.eu](https://www.privacykit.eu)**
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## Why PrivacyKit
|
|
13
|
+
|
|
14
|
+
Most consent tools show a dialog — PrivacyKit also enforces it. Third-party scripts and embedded content are blocked until the user grants consent, and a built-in Compliance Monitor continuously validates that nothing slips through after a website change.
|
|
15
|
+
|
|
16
|
+
| | PrivacyKit |
|
|
17
|
+
|---|---|
|
|
18
|
+
| Works with any frontend | ✅ Lightweight web components — no framework lock-in |
|
|
19
|
+
| Control when third-party code executes | ✅ Consent Guards block scripts and embeds until consent |
|
|
20
|
+
| Continuous compliance monitoring & validation | ✅ Runtime monitor, not a periodic scanner |
|
|
21
|
+
| Customizable | ✅ Design tokens, themes, slots, layouts |
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## Installation
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npm install @privacykit/web
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
The package includes web components, the JavaScript API, TypeScript definitions, and anti-flicker styles.
|
|
32
|
+
|
|
33
|
+
Alternatively, use the CDN:
|
|
34
|
+
|
|
35
|
+
```html
|
|
36
|
+
<script type="module" src="https://cdn.privacykit.eu/v1/privacykit.esm.js"></script>
|
|
37
|
+
<script nomodule src="https://cdn.privacykit.eu/v1/privacykit.js"></script>
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## Quick Start
|
|
43
|
+
|
|
44
|
+
Get PrivacyKit running in minutes — add the consent dialog to your site via npm or CDN, with no account or registration required to start. A 10-day trial is included.
|
|
45
|
+
|
|
46
|
+
→ [privacykit.eu/en/quick-start](https://www.privacykit.eu/en/quick-start)
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## Web Components
|
|
51
|
+
|
|
52
|
+
PrivacyKit ships four web components: `<consent-dialog>`, `<consent-guard>`, `<consent-missing>`, and `<compliance-monitor>`. They work with any frontend framework or plain HTML.
|
|
53
|
+
|
|
54
|
+
→ [privacykit.eu/en/web-components](https://www.privacykit.eu/en/web-components)
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## JavaScript API
|
|
59
|
+
|
|
60
|
+
All methods are available on `window.PrivacyKit` — read consent state, subscribe to changes, open dialogs, and toggle the Compliance Monitor from application code.
|
|
61
|
+
|
|
62
|
+
→ [privacykit.eu/en/api-reference](https://www.privacykit.eu/en/api-reference)
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
MIT License © PrivacyKit · [support@privacykit.eu](mailto:support@privacykit.eu)
|