@tillsc/progressive-web-components 0.1.0

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 ADDED
@@ -0,0 +1,30 @@
1
+ # progressive-web-components
2
+
3
+ Server-first web components.
4
+
5
+ A collection of Custom Elements designed to work with server-rendered HTML and progressive enhancement.
6
+
7
+ ## Principles
8
+
9
+ - Server-rendered HTML is the baseline
10
+ - Custom Elements without Shadow DOM by default
11
+ - Small, composable components
12
+ - Minimal JavaScript
13
+ - No framework lock-in
14
+ - Optional framework-specific variants (e.g. Bootstrap 5)
15
+
16
+ ## Components
17
+
18
+ | Component | Description |
19
+ |-----------|-------------|
20
+ | [`<pwc-dialog-opener>`](src/dialog-opener/README.md) | Enhances links to open their targets in a modal dialog |
21
+ | [`<pwc-modal-dialog>`](src/modal-dialog/README.md) | Low-level building block for modal dialogs from JavaScript |
22
+
23
+ Each component ships a **vanilla** variant and a **Bootstrap 5** variant.
24
+
25
+ ## Distribution
26
+
27
+ `dist/` contains one JavaScript file per component variant. No build step required for consumers.
28
+
29
+ - `dialog-opener.js` / `dialog-opener-bs5.js`
30
+ - `modal-dialog.js` / `modal-dialog-bs5.js`