@thi.ng/hiccup-html 2.2.1 → 2.2.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/CHANGELOG.md +1 -1
- package/README.md +8 -11
- package/api.d.ts +22 -22
- package/package.json +8 -8
- package/sections.d.ts +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
<!-- This file is generated - DO NOT EDIT! -->
|
|
2
2
|
|
|
3
|
-
# 
|
|
3
|
+
# 
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/@thi.ng/hiccup-html)
|
|
6
6
|
|
|
7
|
-
[](https://mastodon.thi.ng/@toxi)
|
|
8
8
|
|
|
9
9
|
This project is part of the
|
|
10
10
|
[@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
|
|
@@ -33,7 +33,7 @@ This project is part of the
|
|
|
33
33
|
|
|
34
34
|
## About
|
|
35
35
|
|
|
36
|
-
100+ type-checked HTML5 element functions for
|
|
36
|
+
100+ type-checked HTML5 element functions for @thi.ng/hiccup related infrastructure
|
|
37
37
|
|
|
38
38
|
The following type-checked factory functions are provided **so far** and
|
|
39
39
|
in most cases include specialized type definitions for element-specific
|
|
@@ -164,7 +164,7 @@ welcome!
|
|
|
164
164
|
|
|
165
165
|
- [@thi.ng/hdom](https://github.com/thi-ng/umbrella/tree/develop/packages/hdom) - Lightweight vanilla ES6 UI component trees with customizable branch-local behaviors
|
|
166
166
|
- [@thi.ng/rdom](https://github.com/thi-ng/umbrella/tree/develop/packages/rdom) - Lightweight, reactive, VDOM-less UI/DOM components with async lifecycle and [@thi.ng/hiccup](https://github.com/thi-ng/umbrella/tree/develop/packages/hiccup) compatible
|
|
167
|
-
- [@thi.ng/hiccup-svg](https://github.com/thi-ng/umbrella/tree/develop/packages/hiccup-svg) - SVG element functions for [@thi.ng/hiccup](https://github.com/thi-ng/umbrella/tree/develop/packages/hiccup) &
|
|
167
|
+
- [@thi.ng/hiccup-svg](https://github.com/thi-ng/umbrella/tree/develop/packages/hiccup-svg) - SVG element functions for [@thi.ng/hiccup](https://github.com/thi-ng/umbrella/tree/develop/packages/hiccup) & related tooling
|
|
168
168
|
|
|
169
169
|
## Installation
|
|
170
170
|
|
|
@@ -182,11 +182,8 @@ ES module import:
|
|
|
182
182
|
|
|
183
183
|
For Node.js REPL:
|
|
184
184
|
|
|
185
|
-
```
|
|
186
|
-
|
|
187
|
-
node --experimental-repl-await
|
|
188
|
-
|
|
189
|
-
> const hiccupHtml = await import("@thi.ng/hiccup-html");
|
|
185
|
+
```js
|
|
186
|
+
const hiccupHtml = await import("@thi.ng/hiccup-html");
|
|
190
187
|
```
|
|
191
188
|
|
|
192
189
|
Package sizes (brotli'd, pre-treeshake): ESM: 1.48 KB
|
|
@@ -355,7 +352,7 @@ const el = defElement<any>("a", { b: 1 });
|
|
|
355
352
|
|
|
356
353
|
## Authors
|
|
357
354
|
|
|
358
|
-
Karsten Schmidt
|
|
355
|
+
- [Karsten Schmidt](https://thi.ng)
|
|
359
356
|
|
|
360
357
|
If this project contributes to an academic publication, please cite it as:
|
|
361
358
|
|
|
@@ -370,4 +367,4 @@ If this project contributes to an academic publication, please cite it as:
|
|
|
370
367
|
|
|
371
368
|
## License
|
|
372
369
|
|
|
373
|
-
© 2020 - 2022 Karsten Schmidt // Apache
|
|
370
|
+
© 2020 - 2022 Karsten Schmidt // Apache License 2.0
|
package/api.d.ts
CHANGED
|
@@ -1,23 +1,23 @@
|
|
|
1
1
|
import type { Fn, IObjectOf, MaybeDeref, NumOrString } from "@thi.ng/api";
|
|
2
|
-
export
|
|
3
|
-
export
|
|
4
|
-
export
|
|
5
|
-
export
|
|
6
|
-
export
|
|
7
|
-
export
|
|
8
|
-
export
|
|
9
|
-
export
|
|
10
|
-
export
|
|
11
|
-
export
|
|
12
|
-
export
|
|
13
|
-
export
|
|
14
|
-
export
|
|
15
|
-
export
|
|
16
|
-
export
|
|
17
|
-
export
|
|
18
|
-
export
|
|
19
|
-
export
|
|
20
|
-
export
|
|
2
|
+
export type CDataContent = ["!CDATA", ...string[]];
|
|
3
|
+
export type AttribVal<T> = MaybeDeref<T | undefined>;
|
|
4
|
+
export type BooleanAttrib = AttribVal<boolean>;
|
|
5
|
+
export type NumericAttrib = AttribVal<number>;
|
|
6
|
+
export type StringAttrib = AttribVal<string>;
|
|
7
|
+
export type MultiStringAttrib = AttribVal<string | string[]>;
|
|
8
|
+
export type EventAttribVal<T> = Fn<T, any> | [Fn<T, any>, boolean | AddEventListenerOptions] | string;
|
|
9
|
+
export type EventAttribs<K extends string, T> = Record<K, EventAttribVal<T>>;
|
|
10
|
+
export type AnimationEventAttribs = EventAttribs<"onanimationcancel" | "onanimationend" | "onanimationiteration" | "onanimationstart", AnimationEvent>;
|
|
11
|
+
export type DragEventAttribs = EventAttribs<"ondrag" | "ondragend" | "ondragenter" | "ondragexit" | "ondragleave" | "ondragover" | "ondragstart" | "ondrop", DragEvent>;
|
|
12
|
+
export type FocusEventAttribs = EventAttribs<"onblur" | "onfocus" | "onfocusin" | "onfocusout", FocusEvent>;
|
|
13
|
+
export type InputEventAttribs = EventAttribs<"onchange" | "oninput", InputEvent>;
|
|
14
|
+
export type KeyboardEventAttribs = EventAttribs<"onkeydown" | "onkeypress" | "onkeyup", KeyboardEvent>;
|
|
15
|
+
export type MouseEventAttribs = EventAttribs<"onclick" | "ondblclick" | "oncontextmenu" | "onmousedown" | "onmouseenter" | "onmouseleave" | "onmousemove" | "onmouseout" | "onmouseover" | "onmouseup", MouseEvent>;
|
|
16
|
+
export type PointerEventAttribs = EventAttribs<"ongotpointercapture" | "onlostpointercapture" | "onpointercancel" | "onpointerdown" | "onpointerenter" | "onpointerleave" | "onpointermove" | "onpointerout" | "onpointerover" | "onpointerup", PointerEvent>;
|
|
17
|
+
export type SelectionEventAttribs = EventAttribs<"onselect" | "onselectionchange" | "onselectstart", Event>;
|
|
18
|
+
export type TouchEventAttribs = EventAttribs<"ontouchcancel" | "ontouchend" | "ontouchmove" | "ontouchstart", TouchEvent>;
|
|
19
|
+
export type TransitionEventAttribs = EventAttribs<"ontransitioncancel" | "ontransitionend" | "ontransitionrun" | "ontransitionstart", TransitionEvent>;
|
|
20
|
+
export type WheelEventAttribs = EventAttribs<"onwheel", WheelEvent>;
|
|
21
21
|
export interface GlobalEventAttribs extends AnimationEventAttribs, DragEventAttribs, FocusEventAttribs, InputEventAttribs, KeyboardEventAttribs, MouseEventAttribs, PointerEventAttribs, SelectionEventAttribs, TouchEventAttribs, TransitionEventAttribs, WheelEventAttribs {
|
|
22
22
|
onresize: EventAttribVal<UIEvent>;
|
|
23
23
|
onscroll: EventAttribVal<Event>;
|
|
@@ -52,14 +52,14 @@ export interface RDFaAttribs {
|
|
|
52
52
|
typeof: MultiStringAttrib;
|
|
53
53
|
vocab: StringAttrib;
|
|
54
54
|
}
|
|
55
|
-
export
|
|
55
|
+
export type LinkRel = "alternate" | "author" | "bookmark" | "canonical" | "dns-prefetch" | "external" | "help" | "icon" | "import" | "license" | "manifest" | "modulepreload" | "next" | "nofollow" | "noopener" | "noreferrer" | "opener" | "pingback" | "preconnect" | "prefetch" | "preload" | "prerender" | "prev" | "search" | "shortlink" | "stylesheet" | "tag";
|
|
56
56
|
/**
|
|
57
57
|
* All CSS property names for auto-completion with `style` attrib.
|
|
58
58
|
*
|
|
59
59
|
* @remarks
|
|
60
60
|
* Scraped from: https://developer.mozilla.org/en-US/docs/Web/CSS/Reference
|
|
61
61
|
*/
|
|
62
|
-
export
|
|
62
|
+
export type CSSProperty = "align-content" | "align-items" | "align-self" | "all" | "animation" | "animation-delay" | "animation-direction" | "animation-duration" | "animation-fill-mode" | "animation-iteration-count" | "animation-name" | "animation-play-state" | "animation-timing-function" | "backdrop-filter" | "backface-visibility" | "background" | "background-attachment" | "background-blend-mode" | "background-clip" | "background-color" | "background-image" | "background-origin" | "background-position" | "background-repeat" | "background-size" | "block-size" | "border" | "border-block" | "border-block-color" | "border-block-end" | "border-block-end-color" | "border-block-end-style" | "border-block-end-width" | "border-block-start" | "border-block-start-color" | "border-block-start-style" | "border-block-start-width" | "border-block-style" | "border-block-width" | "border-bottom" | "border-bottom-color" | "border-bottom-left-radius" | "border-bottom-right-radius" | "border-bottom-style" | "border-bottom-width" | "border-collapse" | "border-color" | "border-end-end-radius" | "border-end-start-radius" | "border-image" | "border-image-outset" | "border-image-repeat" | "border-image-slice" | "border-image-source" | "border-image-width" | "border-inline" | "border-inline-color" | "border-inline-end" | "border-inline-end-color" | "border-inline-end-style" | "border-inline-end-width" | "border-inline-start" | "border-inline-start-color" | "border-inline-start-style" | "border-inline-start-width" | "border-inline-style" | "border-inline-width" | "border-left" | "border-left-color" | "border-left-style" | "border-left-width" | "border-radius" | "border-right" | "border-right-color" | "border-right-style" | "border-right-width" | "border-spacing" | "border-start-end-radius" | "border-start-start-radius" | "border-style" | "border-top" | "border-top-color" | "border-top-left-radius" | "border-top-right-radius" | "border-top-style" | "border-top-width" | "border-width" | "bottom" | "box-decoration-break" | "box-shadow" | "box-sizing" | "break-after" | "break-before" | "break-inside" | "caption-side" | "caret-color" | "clear" | "clip" | "clip-path" | "color" | "color-adjust" | "column-count" | "column-fill" | "column-gap" | "column-rule" | "column-rule-color" | "column-rule-style" | "column-rule-width" | "column-span" | "column-width" | "columns" | "contain" | "content" | "counter-increment" | "counter-reset" | "counter-set" | "cursor" | "direction" | "display" | "empty-cells" | "filter" | "flex" | "flex-basis" | "flex-direction" | "flex-flow" | "flex-grow" | "flex-shrink" | "flex-wrap" | "float" | "font" | "font-family" | "font-feature-settings" | "font-kerning" | "font-language-override" | "font-optical-sizing" | "font-size" | "font-size-adjust" | "font-stretch" | "font-style" | "font-synthesis" | "font-variant" | "font-variant-alternates" | "font-variant-caps" | "font-variant-east-asian" | "font-variant-ligatures" | "font-variant-numeric" | "font-variant-position" | "font-variation-settings" | "font-weight" | "gap" | "grid" | "grid-area" | "grid-auto-columns" | "grid-auto-flow" | "grid-auto-rows" | "grid-column" | "grid-column-end" | "grid-column-start" | "grid-gap" | "grid-row" | "grid-row-end" | "grid-row-start" | "grid-template" | "grid-template-areas" | "grid-template-columns" | "grid-template-rows" | "hanging-punctuation" | "height" | "hyphens" | "image-orientation" | "image-rendering" | "inline-size" | "inset" | "inset-block" | "inset-block-end" | "inset-block-start" | "inset-inline" | "inset-inline-end" | "inset-inline-start" | "isolation" | "justify-content" | "justify-items" | "justify-self" | "left" | "letter-spacing" | "line-break" | "line-height" | "list-style" | "list-style-image" | "list-style-position" | "list-style-type" | "margin" | "margin-block" | "margin-block-end" | "margin-block-start" | "margin-bottom" | "margin-inline" | "margin-inline-end" | "margin-inline-start" | "margin-left" | "margin-right" | "margin-top" | "mask" | "mask-border" | "mask-border-mode" | "mask-border-outset" | "mask-border-repeat" | "mask-border-slice" | "mask-border-source" | "mask-border-width" | "mask-clip" | "mask-composite" | "mask-image" | "mask-mode" | "mask-origin" | "mask-position" | "mask-repeat" | "mask-size" | "mask-type" | "max-block-size" | "max-height" | "max-inline-size" | "max-width" | "min-block-size" | "min-height" | "min-inline-size" | "min-width" | "mix-blend-mode" | "object-fit" | "object-position" | "offset" | "offset-anchor" | "offset-distance" | "offset-path" | "offset-rotate" | "opacity" | "order" | "orphans" | "outline" | "outline-color" | "outline-offset" | "outline-style" | "outline-width" | "overflow" | "overflow-anchor" | "overflow-block" | "overflow-inline" | "overflow-wrap" | "overflow-x" | "overflow-y" | "overscroll-behavior" | "overscroll-behavior-block" | "overscroll-behavior-inline" | "overscroll-behavior-x" | "overscroll-behavior-y" | "padding" | "padding-block" | "padding-block-end" | "padding-block-start" | "padding-bottom" | "padding-inline" | "padding-inline-end" | "padding-inline-start" | "padding-left" | "padding-right" | "padding-top" | "page-break-after" | "page-break-before" | "page-break-inside" | "paint-order" | "perspective" | "perspective-origin" | "place-content" | "place-items" | "place-self" | "pointer-events" | "position" | "quotes" | "resize" | "right" | "rotate" | "row-gap" | "scale" | "scroll-behavior" | "scroll-margin" | "scroll-margin-block" | "scroll-margin-block-end" | "scroll-margin-block-start" | "scroll-margin-bottom" | "scroll-margin-inline" | "scroll-margin-inline-end" | "scroll-margin-inline-start" | "scroll-margin-left" | "scroll-margin-right" | "scroll-margin-top" | "scroll-padding" | "scroll-padding-block" | "scroll-padding-block-end" | "scroll-padding-block-start" | "scroll-padding-bottom" | "scroll-padding-inline" | "scroll-padding-inline-end" | "scroll-padding-inline-start" | "scroll-padding-left" | "scroll-padding-right" | "scroll-padding-top" | "scroll-snap-align" | "scroll-snap-stop" | "scroll-snap-type" | "scrollbar-color" | "scrollbar-width" | "shape-image-threshold" | "shape-margin" | "shape-outside" | "tab-size" | "table-layout" | "text-align" | "text-align-last" | "text-combine-upright" | "text-decoration" | "text-decoration-color" | "text-decoration-line" | "text-decoration-skip-ink" | "text-decoration-style" | "text-decoration-thickness" | "text-emphasis" | "text-emphasis-color" | "text-emphasis-position" | "text-emphasis-style" | "text-indent" | "text-justify" | "text-orientation" | "text-overflow" | "text-rendering" | "text-shadow" | "text-transform" | "text-underline-offset" | "text-underline-position" | "top" | "touch-action" | "transform" | "transform-box" | "transform-origin" | "transform-style" | "transition" | "transition-delay" | "transition-duration" | "transition-property" | "transition-timing-function" | "translate" | "turn" | "unicode-bidi" | "unset" | "vertical-align" | "visibility" | "white-space" | "widows" | "width" | "will-change" | "word-break" | "word-spacing" | "word-wrap" | "writing-mode" | "z-index";
|
|
63
63
|
/**
|
|
64
64
|
* Additional CSS properties for SVG elements.
|
|
65
65
|
*
|
|
@@ -69,7 +69,7 @@ export declare type CSSProperty = "align-content" | "align-items" | "align-self"
|
|
|
69
69
|
* - https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/Presentation
|
|
70
70
|
* - https://css-tricks.com/svg-properties-and-css/
|
|
71
71
|
*/
|
|
72
|
-
export
|
|
72
|
+
export type CSSSVGProperty = "alignment-baseline" | "baseline-shift" | "clip" | "clip-path" | "clip-rule" | "color-interpolation" | "color-interpolation-filters" | "color-profile" | "color-rendering" | "cursor" | "d" | "direction" | "display" | "dominant-baseline" | "enable-background" | "fill" | "fill-opacity" | "fill-rule" | "filter" | "flood-color" | "flood-opacity" | "font-family" | "font-size" | "font-size-adjust" | "font-stretch" | "font-variant" | "font-weight" | "glyph-orientation-horizontal" | "glyph-orientation-vertical" | "image-rendering" | "kerning" | "letter-spacing" | "lighting-color" | "marker" | "marker-end" | "marker-mid" | "marker-start" | "mask" | "opacity" | "overflow" | "pointer-events" | "shape-rendering" | "solid-color" | "solid-opacity" | "stop-color" | "stop-opacity" | "stroke" | "stroke-dasharray" | "stroke-dashoffset" | "stroke-linecap" | "stroke-linejoin" | "stroke-miterlimit" | "stroke-opacity" | "stroke-width" | "text-anchor" | "text-decoration" | "text-rendering" | "transform" | "unicode-bidi" | "vector-effect" | "visibility" | "word-spacing" | "writing-mode";
|
|
73
73
|
export interface Attribs extends GlobalEventAttribs, MicroformatAttribs, RDFaAttribs {
|
|
74
74
|
accesskey: StringAttrib;
|
|
75
75
|
autocapitalize: AttribVal<"off" | "on" | "sentences" | "words" | "characters">;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@thi.ng/hiccup-html",
|
|
3
|
-
"version": "2.2.
|
|
3
|
+
"version": "2.2.3",
|
|
4
4
|
"description": "100+ type-checked HTML5 element functions for @thi.ng/hiccup related infrastructure",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"module": "./index.js",
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"url": "https://patreon.com/thing_umbrella"
|
|
22
22
|
}
|
|
23
23
|
],
|
|
24
|
-
"author": "Karsten Schmidt
|
|
24
|
+
"author": "Karsten Schmidt (https://thi.ng)",
|
|
25
25
|
"license": "Apache-2.0",
|
|
26
26
|
"scripts": {
|
|
27
27
|
"build": "yarn clean && tsc --declaration",
|
|
@@ -34,15 +34,15 @@
|
|
|
34
34
|
"test": "testament test"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@thi.ng/api": "^8.
|
|
37
|
+
"@thi.ng/api": "^8.6.1"
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|
|
40
|
-
"@microsoft/api-extractor": "^7.33.
|
|
41
|
-
"@thi.ng/testament": "^0.3.
|
|
40
|
+
"@microsoft/api-extractor": "^7.33.7",
|
|
41
|
+
"@thi.ng/testament": "^0.3.7",
|
|
42
42
|
"rimraf": "^3.0.2",
|
|
43
43
|
"tools": "^0.0.1",
|
|
44
|
-
"typedoc": "^0.23.
|
|
45
|
-
"typescript": "^4.
|
|
44
|
+
"typedoc": "^0.23.22",
|
|
45
|
+
"typescript": "^4.9.4"
|
|
46
46
|
},
|
|
47
47
|
"keywords": [
|
|
48
48
|
"browser",
|
|
@@ -110,5 +110,5 @@
|
|
|
110
110
|
],
|
|
111
111
|
"year": 2020
|
|
112
112
|
},
|
|
113
|
-
"gitHead": "
|
|
113
|
+
"gitHead": "7b2af448da8a63fb21704a79cc4cdf1f3d7d7a64\n"
|
|
114
114
|
}
|
package/sections.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ export interface HtmlAttribs extends Attribs {
|
|
|
3
3
|
xmlns: StringAttrib;
|
|
4
4
|
}
|
|
5
5
|
export declare const html: import("./def.js").ElementFactory<Partial<HtmlAttribs>, any>;
|
|
6
|
-
export
|
|
6
|
+
export type BodyEventAttribs = EventAttribs<"onafterprint" | "onbeforeprint" | "onbeforeunload" | "onerror" | "onhashchange" | "onlanguagechange" | "onload" | "onmessage" | "onoffline" | "ononline" | "onpopstate" | "onredo" | "onstorage" | "onundo" | "onunload", Event>;
|
|
7
7
|
export interface BodyAttribs extends Attribs, BodyEventAttribs {
|
|
8
8
|
}
|
|
9
9
|
export declare const body: import("./def.js").ElementFactory<Partial<BodyAttribs>, any>;
|