@fusion.dev/helix 0.153.0 → 0.154.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/custom-elements.json +697 -66
- package/dist/badge/root/badge-root.css.js +1 -1
- package/dist/badge/root/badge-root.d.ts +1 -0
- package/dist/card/root/card-root.css.js +3 -1
- package/dist/code/root/code-root.css.js +2 -2
- package/dist/code/root/code-root.d.ts +1 -0
- package/dist/code-block/root/code-block-root.css.js +4 -1
- package/dist/code-block/root/code-block-root.d.ts +1 -0
- package/dist/icon/root/icon-root.css.js +8 -1
- package/dist/icon/root/icon-root.d.ts +38 -1
- package/dist/icon/root/icon-root.js +17 -0
- package/dist/quote/root/quote-root.css.js +1 -1
- package/dist/skeleton/root/skeleton-root.css.js +11 -7
- package/dist/skeleton/root/skeleton-root.d.ts +18 -2
- package/dist/skeleton/root/skeleton-root.js +11 -0
- package/dist/stat/root/stat-root.css.js +1 -1
- package/lint.json +1 -1
- package/package.json +6 -6
- package/types/jsx.d.ts +413 -37
- package/types/vue.d.ts +105 -10
- package/types/words.d.ts +13 -0
package/types/vue.d.ts
CHANGED
|
@@ -2708,10 +2708,6 @@ twice what this says once.
|
|
|
2708
2708
|
Reflected and undefaulted, so a card that has not asked reads as a card
|
|
2709
2709
|
with no attribute on it and the stylesheet only describes the departure. */
|
|
2710
2710
|
mediaPlacement?: (HelixCard["mediaPlacement"]) | undefined;
|
|
2711
|
-
/** */
|
|
2712
|
-
"aria-labelledby"?: unknown;
|
|
2713
|
-
/** */
|
|
2714
|
-
"aria-label"?: unknown;
|
|
2715
2711
|
};
|
|
2716
2712
|
|
|
2717
2713
|
export type HelixCardVueEvents = {};
|
|
@@ -3795,6 +3791,22 @@ significant in code and a wrapped line reads as two. For prose-like code, such a
|
|
|
3795
3791
|
a log line, a wrap reads better than a scroll. Line numbers keep the lines
|
|
3796
3792
|
unwrapped, since a wrapped line would take one number and several rows. */
|
|
3797
3793
|
wrap?: (HelixCodeBlock["wrap"]) | undefined;
|
|
3794
|
+
/** The name of a block that scrolls, which is a tab stop while it does.
|
|
3795
|
+
|
|
3796
|
+
Where the block has a name, the scroller says it too, such as "Code,
|
|
3797
|
+
app.ts", as `code-name-label` puts it. */
|
|
3798
|
+
"code-label"?: (HelixCodeBlock["codeLabel"]) | undefined;
|
|
3799
|
+
/** The name of a block that scrolls, which is a tab stop while it does.
|
|
3800
|
+
|
|
3801
|
+
Where the block has a name, the scroller says it too, such as "Code,
|
|
3802
|
+
app.ts", as `code-name-label` puts it. */
|
|
3803
|
+
codeLabel?: (HelixCodeBlock["codeLabel"]) | undefined;
|
|
3804
|
+
/** The name of a block that scrolls, where the block has a name. `{code}` is
|
|
3805
|
+
`code-label` and `{name}` the block's name. */
|
|
3806
|
+
"code-name-label"?: (HelixCodeBlock["codeNameLabel"]) | undefined;
|
|
3807
|
+
/** The name of a block that scrolls, where the block has a name. `{code}` is
|
|
3808
|
+
`code-label` and `{name}` the block's name. */
|
|
3809
|
+
codeNameLabel?: (HelixCodeBlock["codeNameLabel"]) | undefined;
|
|
3798
3810
|
/** The expand button's words while the block shows every line. */
|
|
3799
3811
|
"collapse-label"?: (HelixCodeBlock["collapseLabel"]) | undefined;
|
|
3800
3812
|
/** The expand button's words while the block shows every line. */
|
|
@@ -8736,6 +8748,31 @@ export type HelixIconButtonVueEvents = {
|
|
|
8736
8748
|
export type HelixIconElementEvent<E = Event> = TypedEvent<HelixIcon, E>;
|
|
8737
8749
|
|
|
8738
8750
|
export type HelixIconVueProps = {
|
|
8751
|
+
/** A motion that draws the eye or says work is going on: `spin` turns the
|
|
8752
|
+
glyph without end, `pulse` fades it in and out, and `beat` swells it.
|
|
8753
|
+
|
|
8754
|
+
Absent is still. Reduced motion stills every one of them. */
|
|
8755
|
+
animation?: (HelixIcon["animation"]) | undefined;
|
|
8756
|
+
/** Whether the box takes the glyph's own proportions, its height from
|
|
8757
|
+
`--icon-size` and its width from the glyph's box.
|
|
8758
|
+
|
|
8759
|
+
Absent is a square, which lines icons up in a column. */
|
|
8760
|
+
"auto-width"?: (HelixIcon["autoWidth"]) | undefined;
|
|
8761
|
+
/** Whether the box takes the glyph's own proportions, its height from
|
|
8762
|
+
`--icon-size` and its width from the glyph's box.
|
|
8763
|
+
|
|
8764
|
+
Absent is a square, which lines icons up in a column. */
|
|
8765
|
+
autoWidth?: (HelixIcon["autoWidth"]) | undefined;
|
|
8766
|
+
/** Mirrors the glyph across an axis: `x` left to right, `y` top to bottom,
|
|
8767
|
+
`both` across both.
|
|
8768
|
+
|
|
8769
|
+
Absent draws it as it is. On a right-to-left page, `mirror` is the flip
|
|
8770
|
+
that follows the direction. */
|
|
8771
|
+
flip?: (HelixIcon["flip"]) | undefined;
|
|
8772
|
+
/** Turns the glyph clockwise by 90, 180 or 270 degrees.
|
|
8773
|
+
|
|
8774
|
+
Absent draws it upright. `--icon-rotate` turns it by any other angle. */
|
|
8775
|
+
rotate?: (HelixIcon["rotate"]) | undefined;
|
|
8739
8776
|
/** The icon's name, read by screen readers. Set it for an icon that is not
|
|
8740
8777
|
decorative. */
|
|
8741
8778
|
label?: (HelixIcon["label"]) | undefined;
|
|
@@ -8759,6 +8796,11 @@ the value instead.
|
|
|
8759
8796
|
A name written `prefix:name` asks the library registered under that
|
|
8760
8797
|
prefix. */
|
|
8761
8798
|
name?: (HelixIcon["name"]) | undefined;
|
|
8799
|
+
/** The URL of an SVG file to draw, fetched once a page and drawn in
|
|
8800
|
+
`currentColor` where the file does not color its shapes.
|
|
8801
|
+
|
|
8802
|
+
Wins over `name`; `icon` wins over both. Absent draws `name`. */
|
|
8803
|
+
src?: (HelixIcon["src"]) | undefined;
|
|
8762
8804
|
/** The icon to draw, as an object you import.
|
|
8763
8805
|
|
|
8764
8806
|
**The scalable door, and the one this library uses internally.** An icon is
|
|
@@ -8775,9 +8817,9 @@ for. Set both and this wins, the value being the more specific statement. */
|
|
|
8775
8817
|
};
|
|
8776
8818
|
|
|
8777
8819
|
export type HelixIconVueEvents = {
|
|
8778
|
-
/** `name` matches no registered icon and no library answers it, so nothing is drawn. */
|
|
8820
|
+
/** `name` matches no registered icon and no library answers it, or `src` is no SVG, so nothing is drawn. */
|
|
8779
8821
|
error: HelixIconElementEvent;
|
|
8780
|
-
/** A glyph a library gave later for `name` is drawn. */
|
|
8822
|
+
/** A glyph a library gave later for `name`, or the file at `src`, is drawn. */
|
|
8781
8823
|
load: HelixIconElementEvent;
|
|
8782
8824
|
};
|
|
8783
8825
|
|
|
@@ -13287,6 +13329,20 @@ export type HelixQrCodeVueEvents = {
|
|
|
13287
13329
|
export type HelixQuoteVueProps = {
|
|
13288
13330
|
/** URL identifying where the quotation came from. */
|
|
13289
13331
|
cite?: (HelixQuote["cite"]) | undefined;
|
|
13332
|
+
/** Whether to leave the quotation marks off, for a quotation set where the
|
|
13333
|
+
page draws its own.
|
|
13334
|
+
|
|
13335
|
+
Negative, because the marks are on by default and a boolean attribute is
|
|
13336
|
+
true whenever it is present. Reflected, because a stylesheet takes the
|
|
13337
|
+
marks off on it. */
|
|
13338
|
+
"no-marks"?: (HelixQuote["noMarks"]) | undefined;
|
|
13339
|
+
/** Whether to leave the quotation marks off, for a quotation set where the
|
|
13340
|
+
page draws its own.
|
|
13341
|
+
|
|
13342
|
+
Negative, because the marks are on by default and a boolean attribute is
|
|
13343
|
+
true whenever it is present. Reflected, because a stylesheet takes the
|
|
13344
|
+
marks off on it. */
|
|
13345
|
+
noMarks?: (HelixQuote["noMarks"]) | undefined;
|
|
13290
13346
|
};
|
|
13291
13347
|
|
|
13292
13348
|
export type HelixQuoteVueEvents = {};
|
|
@@ -14653,6 +14709,11 @@ fade the fill in and out, or `none` to sit still.
|
|
|
14653
14709
|
|
|
14654
14710
|
Reduced motion stills both. */
|
|
14655
14711
|
effect?: (HelixSkeleton["effect"]) | undefined;
|
|
14712
|
+
/** How many lines of text the placeholder stands for, with `shape="text"`.
|
|
14713
|
+
|
|
14714
|
+
Absent, or 1, is one line. Reflected, because the stylesheet sizes a
|
|
14715
|
+
paragraph by it. */
|
|
14716
|
+
lines?: (HelixSkeleton["lines"]) | undefined;
|
|
14656
14717
|
/** The shape of the placeholder: `text`, `circle`, or a block when unset.
|
|
14657
14718
|
|
|
14658
14719
|
Unset is a block, which is what most missing things are. A block is the
|
|
@@ -15385,7 +15446,10 @@ figures compared one against another keep their own widths. */
|
|
|
15385
15446
|
columns?: (HelixStatGroup["columns"]) | undefined;
|
|
15386
15447
|
/** Draws a rule between the figures, in addition to the space. */
|
|
15387
15448
|
divided?: (HelixStatGroup["divided"]) | undefined;
|
|
15388
|
-
/** Accessible name for the group.
|
|
15449
|
+
/** Accessible name for the group, which makes it a group.
|
|
15450
|
+
|
|
15451
|
+
Absent leaves the stats with no group around them, unless `aria-label` or
|
|
15452
|
+
`aria-labelledby` names it. */
|
|
15389
15453
|
label?: (HelixStatGroup["label"]) | undefined;
|
|
15390
15454
|
};
|
|
15391
15455
|
|
|
@@ -15418,6 +15482,29 @@ reports a hydration mismatch. The absent attribute is the column, which the
|
|
|
15418
15482
|
stylesheet reads as the base case, and the server spec asserts the host
|
|
15419
15483
|
carries nothing nobody wrote. */
|
|
15420
15484
|
direction?: (HelixStat["direction"]) | undefined;
|
|
15485
|
+
/** `Intl.NumberFormat` options `value` is written with, such as
|
|
15486
|
+
`{"notation":"compact"}` for `1.2M` or `{"style":"percent"}` for `98%`,
|
|
15487
|
+
written as JSON in the attribute.
|
|
15488
|
+
|
|
15489
|
+
Absent writes the number as the locale writes any number. */
|
|
15490
|
+
"format-options"?: (HelixStat["formatOptions"]) | undefined;
|
|
15491
|
+
/** `Intl.NumberFormat` options `value` is written with, such as
|
|
15492
|
+
`{"notation":"compact"}` for `1.2M` or `{"style":"percent"}` for `98%`,
|
|
15493
|
+
written as JSON in the attribute.
|
|
15494
|
+
|
|
15495
|
+
Absent writes the number as the locale writes any number. */
|
|
15496
|
+
formatOptions?: (HelixStat["formatOptions"]) | undefined;
|
|
15497
|
+
/** The locale `value` is written in, such as `de` for `1.234.567`.
|
|
15498
|
+
|
|
15499
|
+
Absent reads the nearest `lang`, then the runtime's own. Set it on a page
|
|
15500
|
+
rendered on a server, so the server and the browser write the figure
|
|
15501
|
+
alike. */
|
|
15502
|
+
locale?: (HelixStat["locale"]) | undefined;
|
|
15503
|
+
/** The figure as a number, written with `format-options` in `locale` in
|
|
15504
|
+
place of a slotted value.
|
|
15505
|
+
|
|
15506
|
+
Absent leaves the figure to the slot. */
|
|
15507
|
+
value?: (HelixStat["value"]) | undefined;
|
|
15421
15508
|
};
|
|
15422
15509
|
|
|
15423
15510
|
export type HelixStatVueEvents = {};
|
|
@@ -19308,6 +19395,8 @@ export type CustomCssProperties = {
|
|
|
19308
19395
|
"--badge-font-weight"?: (string) | undefined;
|
|
19309
19396
|
/** The space between the content and the count under `placement="inline"`. */
|
|
19310
19397
|
"--badge-gap"?: (string) | undefined;
|
|
19398
|
+
/** The size of an icon in the `icon` slot. The count's own size by default. */
|
|
19399
|
+
"--badge-icon-size"?: (string) | undefined;
|
|
19311
19400
|
/** Pulls the mark in from the corner, along both axes. */
|
|
19312
19401
|
"--badge-offset"?: (string) | undefined;
|
|
19313
19402
|
/** How far the indicator's corners are rounded. */
|
|
@@ -20168,7 +20257,11 @@ export type CustomCssProperties = {
|
|
|
20168
20257
|
"--heatmap-rows"?: (string) | undefined;
|
|
20169
20258
|
/** The tone of the cell it is set on. The component writes it, and the stylesheet that paints the cell reads it. */
|
|
20170
20259
|
"--heatmap-tone"?: (string) | undefined;
|
|
20171
|
-
/**
|
|
20260
|
+
/** How long one turn, pulse or beat of `animation` takes. */
|
|
20261
|
+
"--icon-animation-duration"?: (string) | undefined;
|
|
20262
|
+
/** An angle the glyph is turned by, such as `45deg`. `rotate` wins over it. */
|
|
20263
|
+
"--icon-rotate"?: (string) | undefined;
|
|
20264
|
+
/** The width and height of the icon's box. The height alone under `auto-width`. */
|
|
20172
20265
|
"--icon-size"?: (string) | undefined;
|
|
20173
20266
|
/** The aspect ratio of the box, such as `16 / 9`. */
|
|
20174
20267
|
"--image-aspect"?: (string) | undefined;
|
|
@@ -20974,6 +21067,8 @@ export type CustomCssProperties = {
|
|
|
20974
21067
|
"--skeleton-color"?: (string) | undefined;
|
|
20975
21068
|
/** How long one sweep or one pulse takes. */
|
|
20976
21069
|
"--skeleton-duration"?: (string) | undefined;
|
|
21070
|
+
/** The width of the last line of a `lines` paragraph. Defaults to 60%. */
|
|
21071
|
+
"--skeleton-last-line-size"?: (string) | undefined;
|
|
20977
21072
|
/** The corner of the block shape. */
|
|
20978
21073
|
"--skeleton-radius"?: (string) | undefined;
|
|
20979
21074
|
/** The highlight the sweep carries across the fill. */
|
|
@@ -21954,7 +22049,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
21954
22049
|
HelixIconButtonVueProps,
|
|
21955
22050
|
HelixIconButtonVueEvents
|
|
21956
22051
|
>;
|
|
21957
|
-
/** Draws in 'currentColor' and sizes from '--icon-size', so an icon takes the color of the text around it and a container can resize it without a property. Inside a button, '--icon-size' is set in 'em', so the icon scales with the button. */
|
|
22052
|
+
/** Draws in 'currentColor' and sizes from '--icon-size', so an icon takes the color of the text around it and a container can resize it without a property. Inside a button, '--icon-size' is set in 'em', so the icon scales with the button. **The glyph turns, flips and moves inside its own box**, so the line around it keeps its place: 'rotate' turns it by a quarter, a half or three quarters, '--icon-rotate' by any angle, 'flip' mirrors it across either axis, and 'animation' spins, pulses or beats it, as Web Awesome's icon does. Reduced motion stills every animation. 'auto-width' gives the box the glyph's own proportions, for a mark wider than it is tall. */
|
|
21958
22053
|
"helix-icon": DefineCustomElement<
|
|
21959
22054
|
HelixIcon,
|
|
21960
22055
|
HelixIconVueProps,
|
|
@@ -22308,7 +22403,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
22308
22403
|
HelixSelectVueProps,
|
|
22309
22404
|
HelixSelectVueEvents
|
|
22310
22405
|
>;
|
|
22311
|
-
/** Animates a highlight sweeping across the block, which reads as work in progress. A block fading in and out can look broken, so 'effect="pulse"' is a choice rather than the default. Around content with 'loading', the skeleton takes the content's box and paints over it, and the content is hidden until 'loading' is taken off. */
|
|
22406
|
+
/** Animates a highlight sweeping across the block, which reads as work in progress. A block fading in and out can look broken, so 'effect="pulse"' is a choice rather than the default. Around content with 'loading', the skeleton takes the content's box and paints over it, and the content is hidden until 'loading' is taken off. **'lines' draws a paragraph.** With 'shape="text"' and 'lines="3"', one element stands in for three lines of text: each line a 'skeleton' part one 'em' tall, spaced a body line height apart, and the last one shorter, as the end of a paragraph is. */
|
|
22312
22407
|
"helix-skeleton": DefineCustomElement<
|
|
22313
22408
|
HelixSkeleton,
|
|
22314
22409
|
HelixSkeletonVueProps,
|
package/types/words.d.ts
CHANGED
|
@@ -1002,6 +1002,19 @@ declare module '@fusion.dev/helix-core' {
|
|
|
1002
1002
|
valueMissingMessage: Message
|
|
1003
1003
|
}
|
|
1004
1004
|
'helix-code-block': {
|
|
1005
|
+
/**
|
|
1006
|
+
* The name of a block that scrolls, which is a tab stop while it does.
|
|
1007
|
+
*
|
|
1008
|
+
* English: `Code`
|
|
1009
|
+
*/
|
|
1010
|
+
codeLabel: Message
|
|
1011
|
+
/**
|
|
1012
|
+
* The name of a block that scrolls, where the block has a name. `{code}` is
|
|
1013
|
+
* `code-label` and `{name}` the block's name.
|
|
1014
|
+
*
|
|
1015
|
+
* English: `{code}, {name}`
|
|
1016
|
+
*/
|
|
1017
|
+
codeNameLabel: Message
|
|
1005
1018
|
/**
|
|
1006
1019
|
* The expand button's words while the block shows every line.
|
|
1007
1020
|
*
|