@queuezero/embed 0.1.3
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/README.md +60 -0
- package/dist/index.global.js +296 -0
- package/package.json +36 -0
package/README.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# @queuezero/embed
|
|
2
|
+
|
|
3
|
+
Embeddable vanilla JS widget for QueueZero viral waitlists. No build step required.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
### Via CDN (Recommended)
|
|
8
|
+
|
|
9
|
+
```html
|
|
10
|
+
<div id="queuezero-waitlist"></div>
|
|
11
|
+
<script src="https://cdn.jsdelivr.net/npm/@queuezero/embed@latest/dist/index.global.js"></script>
|
|
12
|
+
<script>
|
|
13
|
+
QueueZero.init('queuezero-waitlist', 'your-campaign-slug', {
|
|
14
|
+
apiUrl: 'https://api.queuezero.io'
|
|
15
|
+
});
|
|
16
|
+
</script>
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Via NPM
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install @queuezero/embed
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
```js
|
|
26
|
+
import * as QueueZero from '@queuezero/embed';
|
|
27
|
+
|
|
28
|
+
QueueZero.init('queuezero-waitlist', 'your-campaign-slug', {
|
|
29
|
+
apiUrl: 'https://api.queuezero.io'
|
|
30
|
+
});
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## API
|
|
34
|
+
|
|
35
|
+
### `QueueZero.init(elementId, campaignSlug, options)`
|
|
36
|
+
|
|
37
|
+
Mounts a complete waitlist widget (form + status + referral share) to the specified element.
|
|
38
|
+
|
|
39
|
+
| Parameter | Type | Description |
|
|
40
|
+
|-----------|------|-------------|
|
|
41
|
+
| `elementId` | `string` | ID of the container element |
|
|
42
|
+
| `campaignSlug` | `string` | Your campaign identifier |
|
|
43
|
+
| `options.apiUrl` | `string` | API endpoint URL |
|
|
44
|
+
|
|
45
|
+
## Styling
|
|
46
|
+
|
|
47
|
+
The widget uses `qz-*` class names for styling:
|
|
48
|
+
|
|
49
|
+
```css
|
|
50
|
+
.qz-embed-container { }
|
|
51
|
+
.qz-form { }
|
|
52
|
+
.qz-form-input { }
|
|
53
|
+
.qz-form-button { }
|
|
54
|
+
.qz-status { }
|
|
55
|
+
.qz-share { }
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## License
|
|
59
|
+
|
|
60
|
+
MIT
|