@galaxy-io/dls 1.4.10 → 1.4.12

package/dist/toast/ToastProvider.d.ts

@@ -1,16 +1,25 @@
 import { PropsWithChildren } from "react";
 import { ToastVariant, type ToastProps } from "./Toast";
+/** What you pass to `showToast`. Every `ToastProps` field except `onClose`, which the provider owns. */
 export type ShowToastProps = Omit<ToastProps, "onClose"> & {
+    /** Milliseconds before auto-dismiss. Pass `0` to make it stay. @default 3000 */
     timeout?: number;
+    /** Viewport offset. Toasts sharing the same four values stack together. */
     top?: number | string;
     left?: number | string;
     right?: number | string;
     bottom?: number | string;
 };
 export interface ToastContextProps {
+    /** Queue a toast. Returns its id, for dismissing it early via `hideToast`. */
     showToast: (options: ShowToastProps) => string;
+    /** Dismiss one toast by id, or every toast when called with no argument. */
     hideToast: (id?: string) => void;
 }
 export declare const ToastContext: import("react").Context<ToastContextProps | undefined>;
+/**
+ * Owns the toast queue. Mount it once near the root, then call `showToast` from
+ * `useToast()` anywhere below. Handles stacking, timers and dismissal.
+ */
 export declare const ToastProvider: ({ children }: PropsWithChildren) => import("react").JSX.Element;
 export { ToastVariant };

package/dist/toast/ToastProvider.js

@@ -16,6 +16,10 @@ var positionKey = (toast) => JSON.stringify([
 	toast.bottom,
 	toast.left
 ]);
+/**
+* Owns the toast queue. Mount it once near the root, then call `showToast` from
+* `useToast()` anywhere below. Handles stacking, timers and dismissal.
+*/
 var ToastProvider = ({ children }) => {
 	const [toasts, setToasts] = useState([]);
 	const timeoutRefs = useRef(/* @__PURE__ */ new Map());

package/dist/toast/useToast.d.ts

@@ -1 +1,8 @@
+/**
+ * Returns `{ showToast, hideToast }`. `showToast` returns the new toast's id,
+ * which you can pass to `hideToast` to dismiss that one early — call it with no
+ * argument to clear them all.
+ *
+ * Throws when called outside a `ToastProvider`.
+ */
 export declare const useToast: () => import("./ToastProvider").ToastContextProps;

package/dist/toast/useToast.js

@@ -1,6 +1,13 @@
 import { ToastContext } from "./ToastProvider.js";
 import { useContext } from "react";
 //#region src/toast/useToast.ts
+/**
+* Returns `{ showToast, hideToast }`. `showToast` returns the new toast's id,
+* which you can pass to `hideToast` to dismiss that one early — call it with no
+* argument to clear them all.
+*
+* Throws when called outside a `ToastProvider`.
+*/
 var useToast = () => {
 	const context = useContext(ToastContext);
 	if (!context) throw new Error("useToast must be used within a ToastProvider");

package/dist/tooltip/Tooltip.d.ts

@@ -1,4 +1,5 @@
 import type { PropsWithChildren } from "react";
+/** Placement relative to the trigger. The `AUTO_*` values pick a side that fits. */
 export declare enum TooltipPosition {
     TOP = "top",
     BOTTOM = "bottom",
@@ -16,22 +17,39 @@ export declare enum TooltipPosition {
     AUTO_START = "auto-start",
     AUTO_END = "auto-end"
 }
+/** Surface treatment of the tooltip bubble. */
 export declare enum TooltipVariant {
     BASE = "BASE",
     PRIMARY = "PRIMARY",
     SECONDARY = "SECONDARY",
     TERTIARY = "TERTIARY"
 }
-interface TooltipProps {
+export interface TooltipProps {
+    /** Tooltip content. A string is wrapped in `Text`; a node renders as-is. */
     body: string | React.ReactNode;
+    /** @default TooltipVariant.SECONDARY */
     variant?: TooltipVariant;
+    /** @default TooltipPosition.TOP */
     position?: TooltipPosition;
+    /** Milliseconds to hover before it appears. @default 0 */
     delay?: number;
+    /** `[skidding, distance]` in px from the trigger. @default [0, 4] */
     offset?: [number, number];
+    /** Keep it open while the pointer is over it, so links inside stay reachable. */
     isInteractive?: boolean;
+    /** Drop the 8px inset — for tooltips that host their own layout. */
     noPadding?: boolean;
+    /** Drop the hairline border. */
     noBorder?: boolean;
+    /** Render children bare, with no tooltip at all. */
     isDisabled?: boolean;
 }
+/**
+ * Wraps a trigger and shows `body` on hover or keyboard focus. Children are the
+ * trigger, wrapped in an inline-block span.
+ *
+ * Sits at z-index 10000, above modals and drawers. Set `isInteractive` if the
+ * body contains anything clickable.
+ */
 declare const Tooltip: ({ children, variant, body, position, delay, offset, isInteractive, noPadding, noBorder, isDisabled, }: PropsWithChildren<TooltipProps>) => string | number | boolean | Iterable<import("react").ReactNode> | import("react").JSX.Element | null | undefined;
 export default Tooltip;

package/dist/tooltip/Tooltip.js

@@ -6,6 +6,7 @@ import { match } from "ts-pattern";
 import { jsx } from "react/jsx-runtime";
 import Tippy from "@tippyjs/react";
 //#region src/tooltip/Tooltip.tsx
+/** Placement relative to the trigger. The `AUTO_*` values pick a side that fits. */
 var TooltipPosition = /* @__PURE__ */ function(TooltipPosition) {
 	TooltipPosition["TOP"] = "top";
 	TooltipPosition["BOTTOM"] = "bottom";
@@ -24,6 +25,7 @@ var TooltipPosition = /* @__PURE__ */ function(TooltipPosition) {
 	TooltipPosition["AUTO_END"] = "auto-end";
 	return TooltipPosition;
 }({});
+/** Surface treatment of the tooltip bubble. */
 var TooltipVariant = /* @__PURE__ */ function(TooltipVariant) {
 	TooltipVariant["BASE"] = "BASE";
 	TooltipVariant["PRIMARY"] = "PRIMARY";
@@ -54,6 +56,13 @@ var TooltipContent = withTheme(/*#__PURE__*/ styled("span")({
 		"tjda4tq-2": [_exp3()]
 	}
 }));
+/**
+* Wraps a trigger and shows `body` on hover or keyboard focus. Children are the
+* trigger, wrapped in an inline-block span.
+*
+* Sits at z-index 10000, above modals and drawers. Set `isInteractive` if the
+* body contains anything clickable.
+*/
 var Tooltip = ({ children, variant = "SECONDARY", body, position = "top", delay = 0, offset = [0, 4], isInteractive = false, noPadding = false, noBorder = false, isDisabled = false }) => {
 	if (isDisabled) return children;
 	return /* @__PURE__ */ jsx(Tippy, {

package/dist/transform/Fade.d.ts

@@ -1,6 +1,13 @@
 import type { PropsWithChildren } from "react";
 export interface FadeProps {
+    /** Seconds to wait before starting. @default 0 */
     delay?: number;
 }
+/**
+ * Fades children in on mount and out on unmount, over 200ms.
+ *
+ * The exit half only runs inside a framer-motion `AnimatePresence`. Fills its
+ * parent (100% × 100%).
+ */
 declare const Fade: ({ children, delay }: PropsWithChildren<FadeProps>) => import("react").JSX.Element;
 export default Fade;

package/dist/transform/Fade.js

@@ -1,6 +1,12 @@
 import { jsx } from "react/jsx-runtime";
 import { motion } from "framer-motion";
 //#region src/transform/Fade.tsx
+/**
+* Fades children in on mount and out on unmount, over 200ms.
+*
+* The exit half only runs inside a framer-motion `AnimatePresence`. Fills its
+* parent (100% × 100%).
+*/
 var Fade = ({ children, delay = 0 }) => {
 	return /* @__PURE__ */ jsx(motion.div, {
 		initial: { opacity: 0 },

package/dist/transform/Flash.d.ts

@@ -1,3 +1,7 @@
 import { PropsWithChildren } from "react";
+/**
+ * Pulses children between full and 40% opacity, forever, on a 1s cycle.
+ * Signals "in progress" — pair it with a real completion state.
+ */
 declare const Flash: ({ children }: PropsWithChildren) => import("react").JSX.Element;
 export default Flash;

package/dist/transform/Flash.js

@@ -7,6 +7,10 @@ var StyledFlash = /*#__PURE__*/ styled("span")({
 	class: "s18o9ih0",
 	propsAsIs: false
 });
+/**
+* Pulses children between full and 40% opacity, forever, on a 1s cycle.
+* Signals "in progress" — pair it with a real completion state.
+*/
 var Flash = ({ children }) => {
 	return /* @__PURE__ */ jsx(StyledFlash, { children });
 };

package/dist/transform/Rotate.d.ts

@@ -1,8 +1,15 @@
 import type { PropsWithChildren } from "react";
 export interface RotateProps {
+    /** Rotated to `deg` when true, back to 0 when false. */
     isRotated: boolean;
+    /** Angle in degrees at the rotated end. @default 180 */
     deg?: number;
+    /** Transition duration in seconds. @default 0.075 */
     speed?: number;
 }
+/**
+ * Tweens children between 0° and `deg` as `isRotated` flips. State-driven, not
+ * looping — the usual case is a chevron on an expand/collapse toggle.
+ */
 declare const Rotate: ({ children, isRotated, deg, speed }: PropsWithChildren<RotateProps>) => import("react").JSX.Element;
 export default Rotate;

package/dist/transform/Rotate.js

@@ -16,6 +16,10 @@ var RotateWrapper = /*#__PURE__*/ styled("div")({
 		"r530s5l-1": [_exp2()]
 	}
 });
+/**
+* Tweens children between 0° and `deg` as `isRotated` flips. State-driven, not
+* looping — the usual case is a chevron on an expand/collapse toggle.
+*/
 var Rotate = ({ children, isRotated, deg = 180, speed }) => {
 	return /* @__PURE__ */ jsx(RotateWrapper, {
 		$isRotated: isRotated,

package/dist/transform/ScaleFade.d.ts

@@ -1,6 +1,13 @@
 import type { PropsWithChildren } from "react";
 export interface ScaleFadeProps {
+    /** Seconds to wait before starting. @default 0 */
     delay?: number;
 }
+/**
+ * Fades children in while scaling from 95% to 100%, over 200ms. The entrance for
+ * things that pop: menus, popovers, toasts.
+ *
+ * The exit half only runs inside a framer-motion `AnimatePresence`.
+ */
 declare const ScaleFade: ({ children, delay }: PropsWithChildren<ScaleFadeProps>) => import("react").JSX.Element;
 export default ScaleFade;

package/dist/transform/ScaleFade.js

@@ -1,6 +1,12 @@
 import { jsx } from "react/jsx-runtime";
 import { motion } from "framer-motion";
 //#region src/transform/ScaleFade.tsx
+/**
+* Fades children in while scaling from 95% to 100%, over 200ms. The entrance for
+* things that pop: menus, popovers, toasts.
+*
+* The exit half only runs inside a framer-motion `AnimatePresence`.
+*/
 var ScaleFade = ({ children, delay = 0 }) => {
 	return /* @__PURE__ */ jsx(motion.div, {
 		initial: {

package/dist/transform/Spin.d.ts

@@ -1,7 +1,14 @@
 import type { PropsWithChildren } from "react";
 export interface SpinProps {
+    /** Rotations per second. Higher is faster. @default 1 */
     speed?: number;
+    /** @default true */
     isSpinning?: boolean;
 }
+/**
+ * Rotates children continuously — the loading spinner, usually wrapping an
+ * `Icon`. When `isSpinning` is false the children render bare, with no wrapper
+ * element, so toggling it does not shift layout.
+ */
 declare const Spin: ({ children, speed, isSpinning }: PropsWithChildren<SpinProps>) => import("react").JSX.Element;
 export default Spin;

package/dist/transform/Spin.js

@@ -9,6 +9,11 @@ var StyledSpin = /*#__PURE__*/ styled("div")({
 	propsAsIs: false,
 	vars: { "sonzivr-0": [_exp(), "s"] }
 });
+/**
+* Rotates children continuously — the loading spinner, usually wrapping an
+* `Icon`. When `isSpinning` is false the children render bare, with no wrapper
+* element, so toggling it does not shift layout.
+*/
 var Spin = ({ children, speed = 1, isSpinning = true }) => {
 	if (isSpinning) return /* @__PURE__ */ jsx(StyledSpin, {
 		$speed: speed,

package/dist/widget/Widget.d.ts

@@ -1,4 +1,5 @@
 import type { PropsWithChildren } from "react";
+/** Surface treatment — how much the card separates from the page behind it. */
 export declare enum WidgetVariant {
     BASE = "BASE",
     PRIMARY = "PRIMARY",
@@ -19,22 +20,38 @@ export declare enum WidgetVariant {
     PURPLE = "PURPLE",
     PINK = "PINK"
 }
-interface WidgetProps {
+export interface WidgetProps {
+    /** Not implemented — the component ignores it. Render your own header child. */
     header?: string;
+    /** A number is px. */
     minWidth?: number | string;
     maxWidth?: number | string;
     minHeight?: number | string;
     maxHeight?: number | string;
+    /** `width: 100%`. */
     fillWidth?: boolean;
+    /** `height: 100%`. */
     fillHeight?: boolean;
+    /** Overrides the default 12px inset. */
     padding?: React.CSSProperties["padding"];
+    /** Collapse padding to 0. Ignored when `padding` is set. */
     noPadding?: boolean;
+    /** Suppress the hover treatment even when `onClick` is set. */
     noHover?: boolean;
+    /** Drop the hairline border. */
     noBorder?: boolean;
+    /** Not implemented — the component ignores it. */
     isGradient?: boolean;
+    /** Selected styling — border picks up the Galaxy blue. */
     isSelected?: boolean;
+    /** @default WidgetVariant.PRIMARY */
     variant?: WidgetVariant;
+    /** Also flips the cursor to `pointer` and enables the hover treatment. */
     onClick?: (e: React.MouseEvent<HTMLDivElement>) => void;
 }
+/**
+ * The card primitive — a bordered, padded surface that groups related content.
+ * Hairline border, no shadow. Compose the inside with `FlexWrapper`.
+ */
 declare const Widget: ({ children, minHeight, maxHeight, minWidth, maxWidth, fillWidth, fillHeight, padding, noPadding, noHover, noBorder, isSelected, variant, onClick, }: PropsWithChildren<WidgetProps>) => import("react").JSX.Element;
 export default Widget;

package/dist/widget/Widget.js

@@ -5,6 +5,7 @@ import { styled } from "@linaria/react";
 import { match } from "ts-pattern";
 import { jsx } from "react/jsx-runtime";
 //#region src/widget/Widget.tsx
+/** Surface treatment — how much the card separates from the page behind it. */
 var WidgetVariant = /* @__PURE__ */ function(WidgetVariant) {
 	WidgetVariant["BASE"] = "BASE";
 	WidgetVariant["PRIMARY"] = "PRIMARY";
@@ -89,6 +90,10 @@ var StyledWidget = withTheme(/*#__PURE__*/ styled("div")({
 		"sx1o0cd-11": [_exp10()]
 	}
 }));
+/**
+* The card primitive — a bordered, padded surface that groups related content.
+* Hairline border, no shadow. Compose the inside with `FlexWrapper`.
+*/
 var Widget = ({ children, minHeight, maxHeight, minWidth, maxWidth, fillWidth, fillHeight, padding, noPadding, noHover, noBorder, isSelected, variant = "PRIMARY", onClick }) => {
 	return /* @__PURE__ */ jsx(StyledWidget, {
 		$minWidth: minWidth,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galaxy-io/dls",
-  "version": "1.4.10",
+  "version": "1.4.12",
   "description": "Galaxy Design Language System",
   "license": "UNLICENSED",
   "type": "module",