@salt-ds/core 1.44.0 → 1.45.0

package/dist-types/stepper/Step.d.ts

@@ -0,0 +1,46 @@
+import { type ComponentPropsWithoutRef, type ReactNode } from "react";
+import type { ButtonProps } from "../button";
+export interface StepProps extends Omit<ComponentPropsWithoutRef<"li">, "onToggle"> {
+    /**
+     * The label of the step
+     */
+    label?: ReactNode;
+    /**
+     * Description text is displayed just below the label
+     **/
+    description?: ReactNode;
+    /**
+     * Optional string to determine the status of the step.
+     */
+    status?: StepStatus;
+    /**
+     * The stage of the step
+     */
+    stage?: StepStage;
+    /**
+     * Whether the step item is expanded.
+     */
+    expanded?: boolean;
+    /**
+     * Initial expanded state of the step.
+     */
+    defaultExpanded?: boolean;
+    /**
+     * Callback fired when the step is toggled.
+     */
+    onToggle?: ButtonProps["onClick"];
+}
+export declare type StepId = string;
+export declare type StepStatus = "warning" | "error";
+export declare type StepStage = "pending" | "locked" | "completed" | "inprogress" | "active";
+export declare type StepDepth = number;
+export interface StepProps extends Omit<ComponentPropsWithoutRef<"li">, "onToggle"> {
+    label?: ReactNode;
+    description?: ReactNode;
+    status?: StepStatus;
+    stage?: StepStage;
+    expanded?: boolean;
+    defaultExpanded?: boolean;
+    onToggle?: ButtonProps["onClick"];
+}
+export declare function Step({ id: idProp, label, description, status, stage, expanded: expandedProp, defaultExpanded, onToggle, className, style, children, ...rest }: StepProps): import("react/jsx-runtime").JSX.Element;

package/dist-types/stepper/Stepper.d.ts

@@ -0,0 +1,9 @@
+import { type ComponentPropsWithoutRef } from "react";
+export declare type StepperOrientation = "horizontal" | "vertical";
+export interface StepperProps extends ComponentPropsWithoutRef<"ol"> {
+    /**
+     * The orientation of the stepper: defaults to horizontal.
+     */
+    orientation?: StepperOrientation;
+}
+export declare const Stepper: import("react").ForwardRefExoticComponent<StepperProps & import("react").RefAttributes<HTMLOListElement>>;

package/dist-types/stepper/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Stepper";
+export * from "./Step";

package/dist-types/stepper/internal/StepConnector.d.ts

@@ -0,0 +1 @@
+export declare function StepConnector(): import("react/jsx-runtime").JSX.Element;

package/dist-types/stepper/internal/StepExpandTrigger.d.ts

@@ -0,0 +1,5 @@
+import { type ButtonProps } from "../../button";
+export interface StepExpandTriggerProps extends ButtonProps {
+    expanded: boolean;
+}
+export declare function StepExpandTrigger({ id, expanded, className, ...props }: StepExpandTriggerProps): import("react/jsx-runtime").JSX.Element;

package/dist-types/stepper/internal/StepIcon.d.ts

@@ -0,0 +1,8 @@
+import type { IconProps } from "@salt-ds/icons";
+import type { StepStage, StepStatus } from "../Step";
+export interface StepIconProps extends IconProps {
+    stage: StepStage;
+    status?: StepStatus;
+    sizeMultiplier?: IconProps["size"];
+}
+export declare function StepIcon({ status, stage, size, sizeMultiplier, className, ...props }: StepIconProps): import("react/jsx-runtime").JSX.Element;

package/dist-types/stepper/internal/StepScreenReaderOnly.d.ts

@@ -0,0 +1,5 @@
+import type { ComponentPropsWithoutRef, ReactNode } from "react";
+export interface StepScreenReaderOnlyProps extends ComponentPropsWithoutRef<"div"> {
+    children?: ReactNode;
+}
+export declare function StepScreenReaderOnly({ children, ...props }: StepScreenReaderOnlyProps): import("react/jsx-runtime").JSX.Element;

package/dist-types/stepper/internal/StepText.d.ts

@@ -0,0 +1,5 @@
+import { type TextProps } from "../../text";
+export interface StepTextProps extends TextProps<"div"> {
+    purpose: "label" | "description";
+}
+export declare function StepText({ id, purpose, className, styleAs, children, ...props }: StepTextProps): import("react/jsx-runtime").JSX.Element;

package/dist-types/stepper/internal/StepperProvider.d.ts

@@ -0,0 +1,9 @@
+import { type ReactNode } from "react";
+import type { StepperOrientation } from "../Stepper";
+export declare const StepperOrientationContext: import("react").Context<StepperOrientation>;
+export declare const StepDepthContext: import("react").Context<number>;
+export interface StepperProviderProps {
+    orientation: StepperOrientation;
+    children: ReactNode;
+}
+export declare function StepperProvider({ orientation: orientationProp, children, }: StepperProviderProps): import("react/jsx-runtime").JSX.Element;

package/dist-types/toggle-button/ToggleButton.d.ts

@@ -1,7 +1,31 @@
 import { type ComponentPropsWithoutRef, type MouseEvent } from "react";
+import type { ButtonAppearance, ButtonSentiment } from "../button";
 export interface ToggleButtonProps extends ComponentPropsWithoutRef<"button"> {
-    selected?: boolean;
+    /**
+     * The appearance of the toggle button.
+     * @default solid
+     */
+    appearance?: Extract<ButtonAppearance, "bordered" | "solid">;
+    /**
+     * Callback fired when the toggle button's selection state is changed.
+     */
     onChange?: (event: MouseEvent<HTMLButtonElement>) => void;
+    /**
+     * If `true`, the toggle button will be read-only.
+     */
+    readOnly?: boolean;
+    /**
+     * The sentiment of the toggle button.
+     * @default neutral
+     */
+    sentiment?: ButtonSentiment;
+    /**
+     * Whether the toggle button is a selected state.
+     */
+    selected?: boolean;
+    /**
+     * Value of the toggle button, to be used when in a controlled state.
+     */
     value: string | ReadonlyArray<string> | number | undefined;
 }
 export declare const ToggleButton: import("react").ForwardRefExoticComponent<ToggleButtonProps & import("react").RefAttributes<HTMLButtonElement>>;

package/dist-types/toggle-button-group/ToggleButtonGroup.d.ts

@@ -1,6 +1,12 @@
 import { type ComponentPropsWithoutRef, type SyntheticEvent } from "react";
+import type { ButtonAppearance, ButtonSentiment } from "../button";
 import { type Value } from "./ToggleButtonGroupContext";
 export interface ToggleButtonGroupProps extends Omit<ComponentPropsWithoutRef<"div">, "onChange"> {
+    /**
+     * The appearance of all the toggle buttons within the group.
+     * @default solid
+     */
+    appearance?: Extract<ButtonAppearance, "bordered" | "solid">;
     /**
      * The default value. Use when the component is not controlled.
      */
@@ -10,17 +16,25 @@ export interface ToggleButtonGroupProps extends Omit<ComponentPropsWithoutRef<"d
      */
     disabled?: boolean;
     /**
-     * The value. Use when the component is controlled.
+     * Value of the toggle button group, to be used when the component is controlled.
      */
     value?: Value;
     /**
      * Callback fired when the selection changes.
-     * @param event
      */
     onChange?: (event: SyntheticEvent<HTMLButtonElement>) => void;
+    /**
+     * If `true`, the toggle button group will be read-only.
+     */
+    readOnly?: boolean;
     /**
      * The orientation of the toggle buttons.
      */
     orientation?: "horizontal" | "vertical";
+    /**
+     * The visual sentimenent of all the toggle buttons within the group.
+     * @default neutral
+     */
+    sentiment?: ButtonSentiment;
 }
 export declare const ToggleButtonGroup: import("react").ForwardRefExoticComponent<ToggleButtonGroupProps & import("react").RefAttributes<HTMLDivElement>>;

package/dist-types/toggle-button-group/ToggleButtonGroupContext.d.ts

@@ -1,12 +1,16 @@
 import { type SyntheticEvent } from "react";
+import type { ButtonAppearance, ButtonSentiment } from "../button";
 export declare type Value = string | readonly string[] | number | undefined;
 export interface ToggleButtonGroupContextValue {
+    appearance?: Extract<ButtonAppearance, "bordered" | "solid">;
     disabled?: boolean;
-    select: (event: SyntheticEvent<HTMLButtonElement>) => void;
-    isSelected: (id: Value) => boolean;
     focus: (id: Value) => void;
     isFocused: (id: Value) => boolean;
+    isSelected: (id: Value) => boolean;
     orientation: "horizontal" | "vertical";
+    readOnly?: boolean;
+    select: (event: SyntheticEvent<HTMLButtonElement>) => void;
+    sentiment?: ButtonSentiment;
 }
 export declare const ToggleButtonGroupContext: import("react").Context<ToggleButtonGroupContextValue | undefined>;
 export declare function useToggleButtonGroup(): ToggleButtonGroupContextValue | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salt-ds/core",
-  "version": "1.44.0",
+  "version": "1.45.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",