use-scroll-animate 6.4.0 → 6.6.0

package/dist/components/widgets.d.cts

@@ -231,6 +231,131 @@ interface UsaStarRatingElement extends UsaElement {
 }
 declare function defineStarRating(tag?: string): CustomElementConstructor | undefined;
 
+/**
+ * `<usa-milestones>` (6.5) — a scroll-drawn timeline: a progress line grows
+ * down the rail as you scroll, and each milestone (a child element, with an
+ * optional `data-date`) pops its dot and slides its card in when the line
+ * reaches it. Cards alternate sides on wide screens (`layout="alternate"`,
+ * default) or sit on one side (`layout="left"`); below 640 px they always
+ * stack. Events `usa:reach` (`{ index }`). Reduced motion: everything is
+ * shown, the line is full.
+ */
+interface UsaMilestonesElement extends UsaElement {
+    readonly reached: number;
+}
+declare function defineMilestones(tag?: string): CustomElementConstructor | undefined;
+
+/**
+ * `<usa-masonry-flow>` (6.5) — a masonry grid whose items glide to their
+ * new places (FLIP) whenever the layout changes: resize, items added or
+ * removed, `filter()`, `shuffle()`, `sort()`. Columns come from `min`
+ * (minimum column width, px) and `gap`. Hidden items scale out, shown ones
+ * scale in. Event `usa:layout` (`{ columns }`). Reduced motion: items jump.
+ */
+interface UsaMasonryFlowElement extends UsaElement {
+    readonly columns: number;
+    layout(animate?: boolean): void;
+    filter(fn: ((el: HTMLElement) => boolean) | string | null): void;
+    shuffle(): void;
+    sort(compare: (a: HTMLElement, b: HTMLElement) => number): void;
+}
+declare function defineMasonryFlow(tag?: string): CustomElementConstructor | undefined;
+
+/**
+ * `<usa-compare>` (6.5) — before / after image compare slider. The first
+ * child is "before", the second "after" (images, videos or any element).
+ * Drag the handle (or anywhere with `hover`), click to jump, or use the
+ * keyboard (it is a `role="slider"`: arrows, Page Up / Down, Home / End).
+ * `position` (0–100, default 50), `orientation="horizontal | vertical"`,
+ * `intro` plays a short sweep when it scrolls into view, `labels="Before,
+ * After"`. Event `usa:change` (`{ position }`). Reduced motion: no intro
+ * sweep or eased jumps.
+ */
+interface UsaCompareElement extends UsaElement {
+    position: number;
+}
+declare function defineCompare(tag?: string): CustomElementConstructor | undefined;
+
+/**
+ * `<usa-cube-gallery>` (6.5) — a gallery on a turning 3D cube: the current
+ * slide and the next one sit on adjacent faces and the cube rotates between
+ * them. Swipe / drag, arrow keys, prev / next buttons, `autoplay` (ms;
+ * pauses on hover, focus and off screen), `axis="y | x"`. API `next()`,
+ * `prev()`, `goTo(i)`, `index`; event `usa:change`. Reduced motion: slides
+ * switch with a fade.
+ */
+interface UsaCubeGalleryElement extends UsaElement {
+    readonly index: number;
+    next(): void;
+    prev(): void;
+    goTo(i: number): void;
+}
+declare function defineCubeGallery(tag?: string): CustomElementConstructor | undefined;
+
+/**
+ * `<usa-dock>` (6.6) — a macOS-style dock: items magnify with a smooth
+ * cosine falloff as the pointer moves along it, neighbours make room, and a
+ * click bounces the item (`bounce`). Children are the items (`<a>` /
+ * `<button>`, each with an accessible name); `data-label` shows a tooltip
+ * label above the hovered item. Attributes: `magnify` (max scale, 1.9),
+ * `range` (px of influence, 140), `orientation="horizontal | vertical"`.
+ * Keyboard focus magnifies the focused item. Reduced motion: no
+ * magnification or bounce (labels still show).
+ */
+interface UsaDockElement extends UsaElement {
+    readonly items: HTMLElement[];
+}
+declare function defineDock(tag?: string): CustomElementConstructor | undefined;
+
+/**
+ * `<usa-nav-morph>` (6.6) — navigation links with an indicator that morphs
+ * between them: it follows the hovered / focused link (stretching from the
+ * old one, leading edge first) and settles back on the current page
+ * (`aria-current="page"`, `active` index, or a click). `indicator="underline |
+ * pill | blob | dot"`. Arrow keys move focus across links. Event
+ * `usa:change` (`{ index }`). Reduced motion: the indicator jumps.
+ */
+interface UsaNavMorphElement extends UsaElement {
+    active: number;
+}
+declare const NAV_INDICATORS: readonly ["underline", "pill", "blob", "dot"];
+declare function defineNavMorph(tag?: string): CustomElementConstructor | undefined;
+
+/**
+ * `<usa-menu-toggle>` (6.6) — the hamburger button that morphs into its
+ * "open" icon: `variant="cross"` (✕, default), `arrow` (←), `minus` (—) or
+ * `plus-x` (+ turning into ✕). It is a real `<button>`-like control
+ * (`role="button"`, Space / Enter, `aria-expanded`); `for="<id>"` sets
+ * `aria-controls` and toggles the `hidden` attribute (or `.open()` /
+ * `.close()` / `.show()`) of that element. `pressed` reflects the state.
+ * Event `usa:toggle` (`{ open }`). Reduced motion: the icon switches without
+ * the morph.
+ */
+interface UsaMenuToggleElement extends UsaElement {
+    open: boolean;
+    toggle(force?: boolean): void;
+}
+declare const TOGGLE_VARIANTS: readonly ["cross", "arrow", "minus", "plus-x"];
+declare function defineMenuToggle(tag?: string): CustomElementConstructor | undefined;
+
+/**
+ * `<usa-tip>` (6.6) — tooltip / popover 2.0. Wrap the trigger; the tip
+ * content is the `text` attribute or a child with `[slot="tip"]` / `[data-tip]`
+ * (rich content). It springs out of the trigger with its arrow,
+ * auto-flips to stay inside the viewport and shifts along the edge.
+ * `placement="top | bottom | left | right"`, `trigger="hover | click"`
+ * (`click` = popover: toggles, Esc / outside click close), `delay` (ms).
+ * Hover tips also open on keyboard focus and close on Esc (WCAG 1.4.13).
+ * Events `usa:open`, `usa:close`. Reduced motion: a short fade.
+ */
+interface UsaTipElement extends UsaElement {
+    readonly opened: boolean;
+    show(): void;
+    hide(): void;
+}
+declare const TIP_PLACEMENTS: readonly ["top", "bottom", "left", "right"];
+declare function defineTip(tag?: string): CustomElementConstructor | undefined;
+
 /**
  * motionary/components/widgets — the 6.x animated UI widgets, in their own
  * entry so `motionary/components` and `components/lite` keep their size
@@ -264,8 +389,16 @@ declare global {
         'usa-odometer': UsaOdometerElement;
         'usa-skeleton-reveal': UsaSkeletonRevealElement;
         'usa-star-rating': UsaStarRatingElement;
+        'usa-milestones': UsaMilestonesElement;
+        'usa-masonry-flow': UsaMasonryFlowElement;
+        'usa-compare': UsaCompareElement;
+        'usa-cube-gallery': UsaCubeGalleryElement;
+        'usa-dock': UsaDockElement;
+        'usa-nav-morph': UsaNavMorphElement;
+        'usa-menu-toggle': UsaMenuToggleElement;
+        'usa-tip': UsaTipElement;
     }
 }
 
-export { CAROUSEL_EFFECTS, MENU_EFFECTS, MODAL_EFFECTS, PROGRESS_VARIANTS, SHEET_SIDES, SKELETON_VARIANTS, TAB_INDICATORS, TOAST_POSITIONS, WIDGETS, WIDGET_TAGS, defineCarousel, defineDisclosure, defineMenu, defineModal, defineOdometer, defineProgressRing, defineSheet, defineSkeletonReveal, defineStarRating, defineStories, defineTabBar, defineToastStack, defineWidgets, stackToast };
-export type { StackToastOptions, UsaCarouselElement, UsaDisclosureElement, UsaMenuElement, UsaModalElement, UsaOdometerElement, UsaProgressRingElement, UsaSheetElement, UsaSkeletonRevealElement, UsaStarRatingElement, UsaStoriesElement, UsaTabBarElement, UsaToastStackElement };
+export { CAROUSEL_EFFECTS, MENU_EFFECTS, MODAL_EFFECTS, NAV_INDICATORS, PROGRESS_VARIANTS, SHEET_SIDES, SKELETON_VARIANTS, TAB_INDICATORS, TIP_PLACEMENTS, TOAST_POSITIONS, TOGGLE_VARIANTS, WIDGETS, WIDGET_TAGS, defineCarousel, defineCompare, defineCubeGallery, defineDisclosure, defineDock, defineMasonryFlow, defineMenu, defineMenuToggle, defineMilestones, defineModal, defineNavMorph, defineOdometer, defineProgressRing, defineSheet, defineSkeletonReveal, defineStarRating, defineStories, defineTabBar, defineTip, defineToastStack, defineWidgets, stackToast };
+export type { StackToastOptions, UsaCarouselElement, UsaCompareElement, UsaCubeGalleryElement, UsaDisclosureElement, UsaDockElement, UsaMasonryFlowElement, UsaMenuElement, UsaMenuToggleElement, UsaMilestonesElement, UsaModalElement, UsaNavMorphElement, UsaOdometerElement, UsaProgressRingElement, UsaSheetElement, UsaSkeletonRevealElement, UsaStarRatingElement, UsaStoriesElement, UsaTabBarElement, UsaTipElement, UsaToastStackElement };

package/dist/components/widgets.d.ts

@@ -231,6 +231,131 @@ interface UsaStarRatingElement extends UsaElement {
 }
 declare function defineStarRating(tag?: string): CustomElementConstructor | undefined;
 
+/**
+ * `<usa-milestones>` (6.5) — a scroll-drawn timeline: a progress line grows
+ * down the rail as you scroll, and each milestone (a child element, with an
+ * optional `data-date`) pops its dot and slides its card in when the line
+ * reaches it. Cards alternate sides on wide screens (`layout="alternate"`,
+ * default) or sit on one side (`layout="left"`); below 640 px they always
+ * stack. Events `usa:reach` (`{ index }`). Reduced motion: everything is
+ * shown, the line is full.
+ */
+interface UsaMilestonesElement extends UsaElement {
+    readonly reached: number;
+}
+declare function defineMilestones(tag?: string): CustomElementConstructor | undefined;
+
+/**
+ * `<usa-masonry-flow>` (6.5) — a masonry grid whose items glide to their
+ * new places (FLIP) whenever the layout changes: resize, items added or
+ * removed, `filter()`, `shuffle()`, `sort()`. Columns come from `min`
+ * (minimum column width, px) and `gap`. Hidden items scale out, shown ones
+ * scale in. Event `usa:layout` (`{ columns }`). Reduced motion: items jump.
+ */
+interface UsaMasonryFlowElement extends UsaElement {
+    readonly columns: number;
+    layout(animate?: boolean): void;
+    filter(fn: ((el: HTMLElement) => boolean) | string | null): void;
+    shuffle(): void;
+    sort(compare: (a: HTMLElement, b: HTMLElement) => number): void;
+}
+declare function defineMasonryFlow(tag?: string): CustomElementConstructor | undefined;
+
+/**
+ * `<usa-compare>` (6.5) — before / after image compare slider. The first
+ * child is "before", the second "after" (images, videos or any element).
+ * Drag the handle (or anywhere with `hover`), click to jump, or use the
+ * keyboard (it is a `role="slider"`: arrows, Page Up / Down, Home / End).
+ * `position` (0–100, default 50), `orientation="horizontal | vertical"`,
+ * `intro` plays a short sweep when it scrolls into view, `labels="Before,
+ * After"`. Event `usa:change` (`{ position }`). Reduced motion: no intro
+ * sweep or eased jumps.
+ */
+interface UsaCompareElement extends UsaElement {
+    position: number;
+}
+declare function defineCompare(tag?: string): CustomElementConstructor | undefined;
+
+/**
+ * `<usa-cube-gallery>` (6.5) — a gallery on a turning 3D cube: the current
+ * slide and the next one sit on adjacent faces and the cube rotates between
+ * them. Swipe / drag, arrow keys, prev / next buttons, `autoplay` (ms;
+ * pauses on hover, focus and off screen), `axis="y | x"`. API `next()`,
+ * `prev()`, `goTo(i)`, `index`; event `usa:change`. Reduced motion: slides
+ * switch with a fade.
+ */
+interface UsaCubeGalleryElement extends UsaElement {
+    readonly index: number;
+    next(): void;
+    prev(): void;
+    goTo(i: number): void;
+}
+declare function defineCubeGallery(tag?: string): CustomElementConstructor | undefined;
+
+/**
+ * `<usa-dock>` (6.6) — a macOS-style dock: items magnify with a smooth
+ * cosine falloff as the pointer moves along it, neighbours make room, and a
+ * click bounces the item (`bounce`). Children are the items (`<a>` /
+ * `<button>`, each with an accessible name); `data-label` shows a tooltip
+ * label above the hovered item. Attributes: `magnify` (max scale, 1.9),
+ * `range` (px of influence, 140), `orientation="horizontal | vertical"`.
+ * Keyboard focus magnifies the focused item. Reduced motion: no
+ * magnification or bounce (labels still show).
+ */
+interface UsaDockElement extends UsaElement {
+    readonly items: HTMLElement[];
+}
+declare function defineDock(tag?: string): CustomElementConstructor | undefined;
+
+/**
+ * `<usa-nav-morph>` (6.6) — navigation links with an indicator that morphs
+ * between them: it follows the hovered / focused link (stretching from the
+ * old one, leading edge first) and settles back on the current page
+ * (`aria-current="page"`, `active` index, or a click). `indicator="underline |
+ * pill | blob | dot"`. Arrow keys move focus across links. Event
+ * `usa:change` (`{ index }`). Reduced motion: the indicator jumps.
+ */
+interface UsaNavMorphElement extends UsaElement {
+    active: number;
+}
+declare const NAV_INDICATORS: readonly ["underline", "pill", "blob", "dot"];
+declare function defineNavMorph(tag?: string): CustomElementConstructor | undefined;
+
+/**
+ * `<usa-menu-toggle>` (6.6) — the hamburger button that morphs into its
+ * "open" icon: `variant="cross"` (✕, default), `arrow` (←), `minus` (—) or
+ * `plus-x` (+ turning into ✕). It is a real `<button>`-like control
+ * (`role="button"`, Space / Enter, `aria-expanded`); `for="<id>"` sets
+ * `aria-controls` and toggles the `hidden` attribute (or `.open()` /
+ * `.close()` / `.show()`) of that element. `pressed` reflects the state.
+ * Event `usa:toggle` (`{ open }`). Reduced motion: the icon switches without
+ * the morph.
+ */
+interface UsaMenuToggleElement extends UsaElement {
+    open: boolean;
+    toggle(force?: boolean): void;
+}
+declare const TOGGLE_VARIANTS: readonly ["cross", "arrow", "minus", "plus-x"];
+declare function defineMenuToggle(tag?: string): CustomElementConstructor | undefined;
+
+/**
+ * `<usa-tip>` (6.6) — tooltip / popover 2.0. Wrap the trigger; the tip
+ * content is the `text` attribute or a child with `[slot="tip"]` / `[data-tip]`
+ * (rich content). It springs out of the trigger with its arrow,
+ * auto-flips to stay inside the viewport and shifts along the edge.
+ * `placement="top | bottom | left | right"`, `trigger="hover | click"`
+ * (`click` = popover: toggles, Esc / outside click close), `delay` (ms).
+ * Hover tips also open on keyboard focus and close on Esc (WCAG 1.4.13).
+ * Events `usa:open`, `usa:close`. Reduced motion: a short fade.
+ */
+interface UsaTipElement extends UsaElement {
+    readonly opened: boolean;
+    show(): void;
+    hide(): void;
+}
+declare const TIP_PLACEMENTS: readonly ["top", "bottom", "left", "right"];
+declare function defineTip(tag?: string): CustomElementConstructor | undefined;
+
 /**
  * motionary/components/widgets — the 6.x animated UI widgets, in their own
  * entry so `motionary/components` and `components/lite` keep their size
@@ -264,8 +389,16 @@ declare global {
         'usa-odometer': UsaOdometerElement;
         'usa-skeleton-reveal': UsaSkeletonRevealElement;
         'usa-star-rating': UsaStarRatingElement;
+        'usa-milestones': UsaMilestonesElement;
+        'usa-masonry-flow': UsaMasonryFlowElement;
+        'usa-compare': UsaCompareElement;
+        'usa-cube-gallery': UsaCubeGalleryElement;
+        'usa-dock': UsaDockElement;
+        'usa-nav-morph': UsaNavMorphElement;
+        'usa-menu-toggle': UsaMenuToggleElement;
+        'usa-tip': UsaTipElement;
     }
 }
 
-export { CAROUSEL_EFFECTS, MENU_EFFECTS, MODAL_EFFECTS, PROGRESS_VARIANTS, SHEET_SIDES, SKELETON_VARIANTS, TAB_INDICATORS, TOAST_POSITIONS, WIDGETS, WIDGET_TAGS, defineCarousel, defineDisclosure, defineMenu, defineModal, defineOdometer, defineProgressRing, defineSheet, defineSkeletonReveal, defineStarRating, defineStories, defineTabBar, defineToastStack, defineWidgets, stackToast };
-export type { StackToastOptions, UsaCarouselElement, UsaDisclosureElement, UsaMenuElement, UsaModalElement, UsaOdometerElement, UsaProgressRingElement, UsaSheetElement, UsaSkeletonRevealElement, UsaStarRatingElement, UsaStoriesElement, UsaTabBarElement, UsaToastStackElement };
+export { CAROUSEL_EFFECTS, MENU_EFFECTS, MODAL_EFFECTS, NAV_INDICATORS, PROGRESS_VARIANTS, SHEET_SIDES, SKELETON_VARIANTS, TAB_INDICATORS, TIP_PLACEMENTS, TOAST_POSITIONS, TOGGLE_VARIANTS, WIDGETS, WIDGET_TAGS, defineCarousel, defineCompare, defineCubeGallery, defineDisclosure, defineDock, defineMasonryFlow, defineMenu, defineMenuToggle, defineMilestones, defineModal, defineNavMorph, defineOdometer, defineProgressRing, defineSheet, defineSkeletonReveal, defineStarRating, defineStories, defineTabBar, defineTip, defineToastStack, defineWidgets, stackToast };
+export type { StackToastOptions, UsaCarouselElement, UsaCompareElement, UsaCubeGalleryElement, UsaDisclosureElement, UsaDockElement, UsaMasonryFlowElement, UsaMenuElement, UsaMenuToggleElement, UsaMilestonesElement, UsaModalElement, UsaNavMorphElement, UsaOdometerElement, UsaProgressRingElement, UsaSheetElement, UsaSkeletonRevealElement, UsaStarRatingElement, UsaStoriesElement, UsaTabBarElement, UsaTipElement, UsaToastStackElement };