@lavalogic/scoria 0.36.0 → 0.37.0

package/dist/Components/IconProps.d.ts

@@ -1,24 +1,72 @@
 import type { Colour } from '../scss/colours.js';
+import type { CssLength } from '../Types/Internal/Misc.js';
 import type { Size } from '../Types/Internal/Size.js';
 import type { Variant } from '../Types/Internal/Variant.js';
 import type { icons } from './Icons.js';
+/**
+ * Props for the {@link Icon} component.
+ *
+ * The icon is looked up by `name` from the frozen `icons` registry in
+ * `Icons.ts`. SVG payloads are inlined via `{@html}` so the registry
+ * MUST remain frozen at all times. See `Icon.svelte` for the runtime
+ * invariant check.
+ *
+ * For accessibility, supply a meaningful `label` (becomes `aria-label`
+ * on the clickable button variant) or rely on the default which uses
+ * the icon `name`. Decorative icons should be wrapped in `aria-hidden`
+ * by the parent.
+ */
 export interface IconProps {
+    /** The name of the icon in the frozen registry. */
     name: keyof typeof icons;
+    /** Render size token. Defaults to {@link Size.Medium}. */
     size?: Size;
+    /** Click handler. Only fires when `clickable` is true. */
     onclick?: ((e: MouseEvent) => void) | undefined;
+    /**
+     * Accessible label, used as the `aria-label` on the clickable variant.
+     * Falls back to `name.toString()` when omitted.
+     */
     label?: string;
+    /** When true, position the icon absolutely using the offset props. */
     float?: boolean;
+    /** Visual variant. See {@link Variant}. */
     variant?: Variant;
+    /** Hide the icon visually while keeping its layout slot. */
     invisible?: boolean;
+    /** When true, wrap the SVG in a `<button>` and react to `onclick`. */
     clickable?: boolean;
+    /** `type` attribute used on the wrapping button. */
     clickableType?: 'button' | 'submit';
+    /** CSS `z-index` value for the absolute-positioned variant. */
     zindex?: number;
-    anchorX?: string;
-    anchorY?: string;
-    left?: string;
-    right?: string;
-    top?: string;
-    bottom?: string;
+    /**
+     * Branded CSS length string used in `translate(x, _)` when `float`
+     * is true. Construct via the `cssLength('1rem')` helper or an
+     * explicit `as CssLength` cast. Interpolated into the inline
+     * `style="..."` attribute as a CSS custom property.
+     *
+     * BREAKING (vNext): was `string`; now requires the `CssLength`
+     * brand. Migrate `anchorX="10px"` to
+     * `anchorX={cssLength('10px')}`.
+     */
+    anchorX?: CssLength | undefined;
+    /** Branded CSS length for `translate(_, y)` when `float` is true. See {@link anchorX}. */
+    anchorY?: CssLength | undefined;
+    /** Branded CSS length for the `left` offset when `float` is true. See {@link anchorX}. */
+    left?: CssLength | undefined;
+    /** Branded CSS length for the `right` offset when `float` is true. See {@link anchorX}. */
+    right?: CssLength | undefined;
+    /** Branded CSS length for the `top` offset when `float` is true. See {@link anchorX}. */
+    top?: CssLength | undefined;
+    /** Branded CSS length for the `bottom` offset when `float` is true. See {@link anchorX}. */
+    bottom?: CssLength | undefined;
+    /** Fill / stroke colour override drawn from the design palette. */
     colour?: Colour | undefined;
+    /**
+     * When true, applies the `spin` keyframe animation. The animation is
+     * wrapped in `motion-safe` so users with `prefers-reduced-motion:
+     * reduce` see a static icon.
+     */
     rotate?: boolean;
 }

package/dist/Components/Icons.d.ts

@@ -835,6 +835,14 @@ export declare const icons: {
         readonly box: 12;
         readonly svg: "<path d=\"M9.5 3H9V3.5H9.5V3Z\" />\n\t\t\t\t\t<path d=\"M9 4H9.5V4.5H9V4Z\" />\n\t\t\t\t\t<path d=\"M9.5 5H9V5.5H9.5V5Z\" />\n\t\t\t\t\t<path d=\"M9 6H9.5V6.5H9V6Z\" />\n\t\t\t\t\t<path d=\"M9.5 7H9V7.5H9.5V7Z\" />\n\t\t\t\t\t<path d=\"M9 8H9.5V8.5H9V8Z\" />\n\t\t\t\t\t<path d=\"M3 3H2.5V3.5H3V3Z\" />\n\t\t\t\t\t<path d=\"M2.5 4H3V4.5H2.5V4Z\" />\n\t\t\t\t\t<path d=\"M3 5H2.5V5.5H3V5Z\" />\n\t\t\t\t\t<path d=\"M2.5 6H3V6.5H2.5V6Z\" />\n\t\t\t\t\t<path d=\"M3 7H2.5V7.5H3V7Z\" />\n\t\t\t\t\t<path d=\"M2.5 8H3V8.5H2.5V8Z\" />\n\t\t\t\t\t<path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M1 2.5C1 1.94772 1.44772 1.5 2 1.5H10C10.5523 1.5 11 1.94772 11 2.5V9.5C11 10.0523 10.5523 10.5 10 10.5H2C1.44772 10.5 1 10.0523 1 9.5V2.5ZM4 2.5H8V5.5H4V2.5ZM4 6.5V9.5H8V6.5H4ZM8.5 2.5H10V9.5H8.5V2.5ZM3.5 2.5H2V9.5H3.5V2.5Z\" />";
     };
+    readonly visibility: {
+        readonly box: 24;
+        readonly svg: "<path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M12 4.5C7 4.5 2.73 7.61 1 12c1.73 4.39 6 7.5 11 7.5s9.27-3.11 11-7.5c-1.73-4.39-6-7.5-11-7.5zM12 17c-2.76 0-5-2.24-5-5s2.24-5 5-5 5 2.24 5 5-2.24 5-5 5zm0-8c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z\"/>";
+    };
+    readonly 'visibility-off': {
+        readonly box: 24;
+        readonly svg: "<path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M12 7c2.76 0 5 2.24 5 5 0 .65-.13 1.26-.36 1.83l2.92 2.92c1.51-1.26 2.7-2.89 3.43-4.75-1.73-4.39-6-7.5-11-7.5-1.4 0-2.74.25-3.98.7l2.16 2.16C10.74 7.13 11.35 7 12 7zM2 4.27l2.28 2.28.46.46C3.08 8.3 1.78 10.02 1 12c1.73 4.39 6 7.5 11 7.5 1.55 0 3.03-.3 4.38-.84l.42.42L19.73 22 21 20.73 3.27 3 2 4.27zM7.53 9.8l1.55 1.55c-.05.21-.08.43-.08.65 0 1.66 1.34 3 3 3 .22 0 .44-.03.65-.08l1.55 1.55c-.67.33-1.41.53-2.2.53-2.76 0-5-2.24-5-5 0-.79.2-1.53.53-2.2zm4.31-.78l3.15 3.15.02-.16c0-1.66-1.34-3-3-3l-.17.01z\"/>";
+    };
     readonly warehouse: {
         readonly box: 12;
         readonly svg: "<path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M0.5 4.58235L5.69615 1.58235C5.69615 1.58235 6.00402 1.39706 6.32495 1.58235L11.5211 4.58235L11.0211 5.44838L10.5 5.14752V10.5H1.5V5.1597L1 5.44838L0.5 4.58235ZM2.5 4.58235V9.5H4.25V6.5C4.25 6.22386 4.47386 6 4.75 6H7.25C7.52614 6 7.75 6.22386 7.75 6.5V9.5H9.5V4.57017L6.01055 2.55553L2.5 4.58235ZM6.75 7.25V9.5H5.25V7.25C5.25 7.11193 5.36193 7 5.5 7H6.5C6.63807 7 6.75 7.11193 6.75 7.25Z\" />";