@thi.ng/hiccup 5.4.1 → 5.4.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 +49 -48
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- This file is generated - DO NOT EDIT! -->
|
|
2
|
-
<!-- Please see: https://
|
|
3
|
-
# 
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/@thi.ng/hiccup)
|
|
6
6
|
|
|
@@ -8,11 +8,12 @@
|
|
|
8
8
|
|
|
9
9
|
> [!NOTE]
|
|
10
10
|
> This is one of 214 standalone projects, maintained as part
|
|
11
|
-
> of the [@thi.ng/umbrella](https://
|
|
11
|
+
> of the [@thi.ng/umbrella](https://codeberg.org/thi.ng/umbrella/) ecosystem
|
|
12
12
|
> and anti-framework.
|
|
13
13
|
>
|
|
14
|
-
> 🚀 Please help me to work full-time on these projects by [sponsoring
|
|
15
|
-
>
|
|
14
|
+
> 🚀 Please help me to work full-time on these projects by [sponsoring
|
|
15
|
+
> me](https://codeberg.org/thi.ng/umbrella/src/branch/develop/CONTRIBUTING.md#donations).
|
|
16
|
+
> Thank you! ❤️
|
|
16
17
|
|
|
17
18
|
- [About](#about)
|
|
18
19
|
- [Features](#features)
|
|
@@ -59,9 +60,9 @@ easily *composable* components for static serialization to HTML & friends.
|
|
|
59
60
|
This library is suitable for any SGML-style (HTML/XML/SVG/RSS/Atom etc.)
|
|
60
61
|
serialization, including static website/asset generation, server side rendering
|
|
61
62
|
etc. For interactive use cases, please see companion packages
|
|
62
|
-
[@thi.ng/rdom](https://
|
|
63
|
+
[@thi.ng/rdom](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/rdom)
|
|
63
64
|
(or the older, now unmaintained
|
|
64
|
-
[@thi.ng/hdom](https://
|
|
65
|
+
[@thi.ng/hdom](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hdom))
|
|
65
66
|
and their various support packages.
|
|
66
67
|
|
|
67
68
|
### Features
|
|
@@ -127,31 +128,31 @@ iterable
|
|
|
127
128
|
|
|
128
129
|
**STABLE** - used in production
|
|
129
130
|
|
|
130
|
-
[Search or submit any issues for this package](https://
|
|
131
|
+
[Search or submit any issues for this package](https://codeberg.org/thi.ng/umbrella/issues?q=%5Bhiccup%5D)
|
|
131
132
|
|
|
132
133
|
## Support packages
|
|
133
134
|
|
|
134
|
-
- [@thi.ng/hiccup-canvas](https://
|
|
135
|
-
- [@thi.ng/hiccup-carbon-icons](https://
|
|
136
|
-
- [@thi.ng/hiccup-css](https://
|
|
137
|
-
- [@thi.ng/hiccup-html](https://
|
|
138
|
-
- [@thi.ng/hiccup-html-parse](https://
|
|
139
|
-
- [@thi.ng/hiccup-markdown](https://
|
|
140
|
-
- [@thi.ng/hiccup-svg](https://
|
|
135
|
+
- [@thi.ng/hiccup-canvas](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hiccup-canvas) - Hiccup shape tree renderer for vanilla Canvas 2D contexts
|
|
136
|
+
- [@thi.ng/hiccup-carbon-icons](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hiccup-carbon-icons) - Full set of IBM's Carbon icons in hiccup format
|
|
137
|
+
- [@thi.ng/hiccup-css](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hiccup-css) - CSS from nested JS data structures
|
|
138
|
+
- [@thi.ng/hiccup-html](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hiccup-html) - 100+ type-checked HTML5 element functions for [@thi.ng/hiccup](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hiccup) related infrastructure
|
|
139
|
+
- [@thi.ng/hiccup-html-parse](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hiccup-html-parse) - Well-formed HTML parsing and customizable transformation to nested JS arrays in [@thi.ng/hiccup](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hiccup) format
|
|
140
|
+
- [@thi.ng/hiccup-markdown](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hiccup-markdown) - Markdown parser & serializer from/to Hiccup format
|
|
141
|
+
- [@thi.ng/hiccup-svg](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hiccup-svg) - SVG element functions for [@thi.ng/hiccup](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hiccup) & related tooling
|
|
141
142
|
|
|
142
143
|
## Related packages
|
|
143
144
|
|
|
144
|
-
- [@thi.ng/axidraw](https://
|
|
145
|
-
- [@thi.ng/geom](https://
|
|
146
|
-
- [@thi.ng/geom-axidraw](https://
|
|
147
|
-
- [@thi.ng/hdom](https://
|
|
148
|
-
- [@thi.ng/hdom-canvas](https://
|
|
149
|
-
- [@thi.ng/hdom-components](https://
|
|
150
|
-
- [@thi.ng/rdom](https://
|
|
151
|
-
- [@thi.ng/rdom-canvas](https://
|
|
152
|
-
- [@thi.ng/rdom-components](https://
|
|
153
|
-
- [@thi.ng/transducers](https://
|
|
154
|
-
- [@thi.ng/zipper](https://
|
|
145
|
+
- [@thi.ng/axidraw](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/axidraw) - Minimal AxiDraw plotter/drawing machine controller for Node.js
|
|
146
|
+
- [@thi.ng/geom](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/geom) - Functional, polymorphic API for 2D geometry types & SVG generation
|
|
147
|
+
- [@thi.ng/geom-axidraw](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/geom-axidraw) - Conversion and preparation of thi.ng/geom shapes & shape groups to/from AxiDraw pen plotter draw commands
|
|
148
|
+
- [@thi.ng/hdom](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hdom) - Lightweight vanilla ES6 UI component trees with customizable branch-local behaviors
|
|
149
|
+
- [@thi.ng/hdom-canvas](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hdom-canvas) - [@thi.ng/hdom](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hdom) component wrapper for declarative canvas scenegraphs
|
|
150
|
+
- [@thi.ng/hdom-components](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hdom-components) - Raw, skinnable UI & SVG components for [@thi.ng/hdom](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hdom)
|
|
151
|
+
- [@thi.ng/rdom](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/rdom) - Lightweight, reactive, VDOM-less UI/DOM components with async lifecycle and [@thi.ng/hiccup](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hiccup) compatible
|
|
152
|
+
- [@thi.ng/rdom-canvas](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/rdom-canvas) - [@thi.ng/rdom](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/rdom) component wrapper for [@thi.ng/hiccup-canvas](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hiccup-canvas) and declarative canvas drawing
|
|
153
|
+
- [@thi.ng/rdom-components](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/rdom-components) - Collection of unstyled, customizable components for [@thi.ng/rdom](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/rdom)
|
|
154
|
+
- [@thi.ng/transducers](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/transducers) - Collection of ~170 lightweight, composable transducers, reducers, generators, iterators for functional data transformations
|
|
155
|
+
- [@thi.ng/zipper](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/zipper) - Functional tree editing, manipulation & navigation
|
|
155
156
|
|
|
156
157
|
### Blog posts
|
|
157
158
|
|
|
@@ -188,32 +189,32 @@ Package sizes (brotli'd, pre-treeshake): ESM: 2.27 KB
|
|
|
188
189
|
|
|
189
190
|
## Dependencies
|
|
190
191
|
|
|
191
|
-
- [@thi.ng/api](https://
|
|
192
|
-
- [@thi.ng/checks](https://
|
|
193
|
-
- [@thi.ng/errors](https://
|
|
194
|
-
- [@thi.ng/strings](https://
|
|
192
|
+
- [@thi.ng/api](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/api)
|
|
193
|
+
- [@thi.ng/checks](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/checks)
|
|
194
|
+
- [@thi.ng/errors](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/errors)
|
|
195
|
+
- [@thi.ng/strings](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/strings)
|
|
195
196
|
|
|
196
197
|
Note: @thi.ng/api is in _most_ cases a type-only import (not used at runtime)
|
|
197
198
|
|
|
198
199
|
## Usage examples
|
|
199
200
|
|
|
200
201
|
11 projects in this repo's
|
|
201
|
-
[/examples](https://
|
|
202
|
+
[/examples](https://codeberg.org/thi.ng/umbrella/src/branch/develop/examples)
|
|
202
203
|
directory are using this package:
|
|
203
204
|
|
|
204
|
-
| Screenshot | Description | Live demo | Source
|
|
205
|
-
|
|
206
|
-
| <img src="https://
|
|
207
|
-
| <img src="https://
|
|
208
|
-
| <img src="https://
|
|
209
|
-
| <img src="https://
|
|
210
|
-
| <img src="https://
|
|
211
|
-
| | Hiccup / hdom DOM hydration example | [Demo](https://demo.thi.ng/umbrella/hydrate-basics/) | [Source](https://
|
|
212
|
-
| <img src="https://
|
|
213
|
-
| <img src="https://
|
|
214
|
-
| <img src="https://
|
|
215
|
-
| <img src="https://
|
|
216
|
-
| <img src="https://
|
|
205
|
+
| Screenshot | Description | Live demo | Source |
|
|
206
|
+
|:-------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------|
|
|
207
|
+
| <img src="https://codeberg.org/thi.ng/umbrella/media/branch/develop/assets/examples/commit-heatmap.png" width="240"/> | Heatmap visualization of this mono-repo's commits | | [Source](https://codeberg.org/thi.ng/umbrella/src/branch/develop/examples/commit-heatmap) |
|
|
208
|
+
| <img src="https://codeberg.org/thi.ng/umbrella/media/branch/develop/assets/examples/commit-table-ssr.png" width="240"/> | Filterable commit log UI w/ minimal server to provide commit history | [Demo](https://demo.thi.ng/umbrella/commit-table-ssr/) | [Source](https://codeberg.org/thi.ng/umbrella/src/branch/develop/examples/commit-table-ssr) |
|
|
209
|
+
| <img src="https://codeberg.org/thi.ng/umbrella/media/branch/develop/assets/examples/hdiff.avif" width="240"/> | Applying thi.ng/hdiff to generate static HTML diff output | [Demo](https://demo.thi.ng/umbrella/hdiff/) | [Source](https://codeberg.org/thi.ng/umbrella/src/branch/develop/examples/hdiff) |
|
|
210
|
+
| <img src="https://codeberg.org/thi.ng/umbrella/media/branch/develop/assets/hdom-canvas/hdom-canvas-shapes-results.png" width="240"/> | Various hdom-canvas shape drawing examples & SVG conversion / export | [Demo](https://demo.thi.ng/umbrella/hdom-canvas-shapes/) | [Source](https://codeberg.org/thi.ng/umbrella/src/branch/develop/examples/hdom-canvas-shapes) |
|
|
211
|
+
| <img src="https://codeberg.org/thi.ng/umbrella/media/branch/develop/assets/examples/hiccup-css-image-transition.jpg" width="240"/> | Generating pure CSS image transitions | [Demo](https://demo.thi.ng/umbrella/hiccup-css-image-transition/) | [Source](https://codeberg.org/thi.ng/umbrella/src/branch/develop/examples/hiccup-css-image-transition) |
|
|
212
|
+
| | Hiccup / hdom DOM hydration example | [Demo](https://demo.thi.ng/umbrella/hydrate-basics/) | [Source](https://codeberg.org/thi.ng/umbrella/src/branch/develop/examples/hydrate-basics) |
|
|
213
|
+
| <img src="https://codeberg.org/thi.ng/umbrella/media/branch/develop/assets/examples/markdown-parser.jpg" width="240"/> | Markdown to Hiccup to HTML parser / transformer | [Demo](https://demo.thi.ng/umbrella/markdown/) | [Source](https://codeberg.org/thi.ng/umbrella/src/branch/develop/examples/markdown) |
|
|
214
|
+
| <img src="https://codeberg.org/thi.ng/umbrella/media/branch/develop/assets/examples/package-stats.png" width="240"/> | CLI util to visualize umbrella pkg stats | | [Source](https://codeberg.org/thi.ng/umbrella/src/branch/develop/examples/package-stats) |
|
|
215
|
+
| <img src="https://codeberg.org/thi.ng/umbrella/media/branch/develop/assets/examples/pointfree-svg.png" width="240"/> | Generate SVG using pointfree DSL | | [Source](https://codeberg.org/thi.ng/umbrella/src/branch/develop/examples/pointfree-svg) |
|
|
216
|
+
| <img src="https://codeberg.org/thi.ng/umbrella/media/branch/develop/assets/examples/rdom-formgen.jpg" width="240"/> | Basic usage of the declarative rdom-forms generator | [Demo](https://demo.thi.ng/umbrella/rdom-formgen/) | [Source](https://codeberg.org/thi.ng/umbrella/src/branch/develop/examples/rdom-formgen) |
|
|
217
|
+
| <img src="https://codeberg.org/thi.ng/umbrella/media/branch/develop/assets/examples/rstream-grid.jpg" width="240"/> | Interactive grid generator, SVG generation & export, undo/redo support | [Demo](https://demo.thi.ng/umbrella/rstream-grid/) | [Source](https://codeberg.org/thi.ng/umbrella/src/branch/develop/examples/rstream-grid) |
|
|
217
218
|
|
|
218
219
|
## API
|
|
219
220
|
|
|
@@ -391,9 +392,9 @@ serialize([div, {id: "foo"}, "bar"]);
|
|
|
391
392
|
### SVG generation, generators & lazy composition
|
|
392
393
|
|
|
393
394
|
Also see
|
|
394
|
-
[@thi.ng/hiccup-svg](https://
|
|
395
|
+
[@thi.ng/hiccup-svg](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hiccup-svg)
|
|
395
396
|
and
|
|
396
|
-
[@thi.ng/geom](https://
|
|
397
|
+
[@thi.ng/geom](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/geom)
|
|
397
398
|
for related (and more advanced) functionality.
|
|
398
399
|
|
|
399
400
|
```ts tangle:export/readme-circles.js
|
|
@@ -556,7 +557,7 @@ Re-formatted HTML output:
|
|
|
556
557
|
### Component objects
|
|
557
558
|
|
|
558
559
|
The sibling library
|
|
559
|
-
[@thi.ng/hdom](https://
|
|
560
|
+
[@thi.ng/hdom](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hdom)
|
|
560
561
|
supports components with basic life cycle methods (init, render, release). To
|
|
561
562
|
support serialization of hdom component trees, hiccup too supports such
|
|
562
563
|
components since version 2.0.0. For static serialization only the `render`
|
|
@@ -577,7 +578,7 @@ behavior of individual elements / tree branches:
|
|
|
577
578
|
|
|
578
579
|
- **`__escape`** - boolean flag to enable/disable entity escaping
|
|
579
580
|
- **`__skip`** - if true, skips serialization (also used by
|
|
580
|
-
[@thi.ng/hdom](https://
|
|
581
|
+
[@thi.ng/hdom](https://codeberg.org/thi.ng/umbrella/src/branch/develop/packages/hdom))
|
|
581
582
|
- **`__serialize`** - if false, skips serialization (hiccup only)
|
|
582
583
|
|
|
583
584
|
```js
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@thi.ng/hiccup",
|
|
3
|
-
"version": "5.4.
|
|
3
|
+
"version": "5.4.3",
|
|
4
4
|
"description": "HTML/SVG/XML serialization of nested data structures, iterables & closures",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"module": "./index.js",
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"sideEffects": false,
|
|
9
9
|
"repository": {
|
|
10
10
|
"type": "git",
|
|
11
|
-
"url": "git+https://
|
|
11
|
+
"url": "git+https://codeberg.org/thi.ng/umbrella.git",
|
|
12
12
|
"directory": "packages/hiccup"
|
|
13
13
|
},
|
|
14
14
|
"homepage": "https://thi.ng/hiccup",
|
|
@@ -41,10 +41,10 @@
|
|
|
41
41
|
"tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@thi.ng/api": "^8.12.
|
|
45
|
-
"@thi.ng/checks": "^3.8.
|
|
46
|
-
"@thi.ng/errors": "^2.6.
|
|
47
|
-
"@thi.ng/strings": "^3.
|
|
44
|
+
"@thi.ng/api": "^8.12.18",
|
|
45
|
+
"@thi.ng/checks": "^3.8.8",
|
|
46
|
+
"@thi.ng/errors": "^2.6.7",
|
|
47
|
+
"@thi.ng/strings": "^3.12.0"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"esbuild": "^0.27.2",
|
|
@@ -131,5 +131,5 @@
|
|
|
131
131
|
],
|
|
132
132
|
"year": 2016
|
|
133
133
|
},
|
|
134
|
-
"gitHead": "
|
|
134
|
+
"gitHead": "929fb6590178a41cbb77cbb87e07c59c61381607\n"
|
|
135
135
|
}
|