@thi.ng/hiccup 5.1.17 → 5.1.18

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-03-01T15:22:50Z
+- **Last updated**: 2024-03-02T14:05:52Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -216,6 +216,8 @@ Tag names support
 style ID & class attribute expansion:
 
 ```ts
+import { serialize } from "@thi.ng/hiccup";
+
 serialize(
     ["div#yo.hello.world", "Look ma, ", ["strong", "no magic!"]]
 );
@@ -236,6 +238,8 @@ If the 2nd array element is not a plain object, it's treated as normal
 child node (see previous example).
 
 ```ts
+import { serialize } from "@thi.ng/hiccup";
+
 serialize(
     ["div.notice",
         {
@@ -288,6 +292,8 @@ Function values for event attributes (any attrib name starting with
 ### Simple components
 
 ```ts
+import { serialize } from "@thi.ng/hiccup";
+
 const thumb = (src) => ["img.thumb", { src, alt: "thumbnail" }];
 
 serialize(
@@ -315,6 +321,8 @@ The context object should contain any global component configuration,
 e.g. for theming purposes.
 
 ```ts
+import { serialize } from "@thi.ng/hiccup";
+
 const header = (ctx, body) =>
     ["h1", ctx.theme.title, body];
 
@@ -344,6 +352,8 @@ yourself. Likewise, if a component function doesn't make use of the context you
 can use either:
 
 ```ts
+import { serialize } from "@thi.ng/hiccup";
+
 // skip the context arg and require direct invocation
 const div = (attribs, body) => ["div", attribs, body];
 
@@ -354,6 +364,8 @@ serialize(div({id: "foo"}, "bar"));
 Or...
 
 ```ts
+import { serialize } from "@thi.ng/hiccup";
+
 // ignore the first arg (context) and support both direct & indirect calls
 const div = (_, attribs, body) => ["div", attribs, body];
 
@@ -567,7 +579,10 @@ Single or multiline comments can be included using the special `COMMENT`
 tag (`__COMMENT__`) (always WITHOUT attributes!).
 
 ```ts
+import { COMMENT } from "@thi.ng/hiccup";
+
 [COMMENT, "Hello world"]
+// serializes to:
 // <!-- Hello world -->
 
 [COMMENT, "Hello", "world"]
@@ -663,6 +678,8 @@ that function is called. The return value the function MUST be a valid
 new tree (or undefined).
 
 ```ts
+import { serialize } from "@thi.ng/hiccup";
+
 const foo = (ctx, a, b) => ["div#" + a, ctx.foo, b];
 
 serialize([foo, "id", "body"], { foo: { class: "black" } })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/hiccup",
-  "version": "5.1.17",
+  "version": "5.1.18",
   "description": "HTML/SVG/XML serialization of nested data structures, iterables & closures",
   "type": "module",
   "module": "./index.js",
@@ -38,11 +38,11 @@
     "@thi.ng/api": "^8.9.27",
     "@thi.ng/checks": "^3.5.1",
     "@thi.ng/errors": "^2.4.19",
-    "@thi.ng/strings": "^3.7.19"
+    "@thi.ng/strings": "^3.7.20"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.40.1",
-    "@thi.ng/atom": "^5.2.34",
+    "@thi.ng/atom": "^5.2.35",
     "esbuild": "^0.20.0",
     "rimraf": "^5.0.5",
     "typedoc": "^0.25.7",
@@ -127,5 +127,5 @@
     ],
     "year": 2016
   },
-  "gitHead": "d660ae8fd1bf64d919b4334f19509f1f539d70f6\n"
+  "gitHead": "df9e312af741d87e6b450afcfea6a6e381662b1e\n"
 }

package/serialize.d.ts

@@ -100,6 +100,8 @@ export interface SerializeOpts {
  * interface.
  *
  * ```js
+ * import { serialize } from "@thi.ng/hiccup";
+ *
  * const foo = (ctx, a, b) => ["div#" + a, ctx.foo, b];
  *
  * serialize([foo, "id", "body"], { ctx: { foo: { class: "black" } } })
@@ -122,7 +124,10 @@ export interface SerializeOpts {
  * (`"__COMMENT__"`) (always WITHOUT attributes!).
  *
  * ```js
+ * import { COMMENT } from "@thi.ng/hiccup";
+ *
  * [COMMENT, "Hello world"]
+ * // serializes to:
  * // <!-- Hello world -->
  *
  * [COMMENT, "Hello", "world"]