@vibe/core 3.35.0 → 3.36.0

package/dist/components/TextField/TextField.d.ts

@@ -3,65 +3,183 @@ import { TextFieldFeedbackState as TextFieldFeedbackStateEnum, TextFieldTextType
 import { TextFieldType, TextFieldSize } from "./TextField.types";
 import { VibeComponentProps, VibeComponent } from "../../types";
 export interface TextFieldProps extends VibeComponentProps {
+    /**
+     * The placeholder text displayed when the input is empty.
+     */
     placeholder?: string;
-    /** See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete for all of the available options */
+    /**
+     * Configures the browser's autocomplete behavior.
+     */
     autoComplete?: string;
+    /**
+     * The current value of the text field.
+     */
     value?: string;
+    /**
+     * Callback fired when the text field value changes.
+     */
     onChange?: (value: string, event: React.ChangeEvent<HTMLInputElement> | Pick<React.ChangeEvent<HTMLInputElement>, "target">) => void;
+    /**
+     * Callback fired when the text field loses focus.
+     */
     onBlur?: (event: React.FocusEvent) => void;
+    /**
+     * Callback fired when the text field gains focus.
+     */
     onFocus?: (event: React.FocusEvent) => void;
+    /**
+     * Callback fired when a key is pressed inside the text field.
+     */
     onKeyDown?: (event: React.KeyboardEvent) => void;
+    /**
+     * Callback fired when the mouse wheel is used inside the text field.
+     */
     onWheel?: (event: React.WheelEvent) => void;
+    /**
+     * The debounce rate for input value changes.
+     */
     debounceRate?: number;
+    /**
+     * If true, the input is automatically focused on mount.
+     */
     autoFocus?: boolean;
+    /**
+     * If true, disables the text field.
+     */
     disabled?: boolean;
+    /**
+     * If true, makes the text field read-only.
+     */
     readonly?: boolean;
+    /**
+     * A function to set a reference to the input element.
+     */
     setRef?: (node: HTMLElement) => void;
+    /**
+     * The primary icon displayed inside the text field.
+     */
     iconName?: string | React.FunctionComponent | null;
+    /**
+     * The secondary icon displayed inside the text field.
+     */
     secondaryIconName?: string | React.FunctionComponent | null;
+    /**
+     * The label displayed above the text field.
+     */
     title?: string;
-    /** SIZES is exposed on the component itself */
+    /**
+     * The size of the text field.
+     */
     size?: TextFieldSize;
-    /** Don't provide status for plain assistant text */
+    /**
+     * Validation state for the text field.
+     */
     validation?: {
         status?: "error" | "success";
         text?: string;
     };
+    /**
+     * Class name applied to the text field wrapper.
+     */
     wrapperClassName?: string;
+    /**
+     * Callback fired when the icon inside the text field is clicked.
+     */
     onIconClick?: (icon: string | React.FunctionComponent | null) => void;
+    /**
+     * If true, clears the input when the icon is clicked.
+     */
     clearOnIconClick?: boolean;
+    /**
+     * The icon displayed inside the label.
+     */
     labelIconName?: string | React.FunctionComponent | null;
+    /**
+     * If true, displays the character count.
+     */
     showCharCount?: boolean;
+    /**
+     * The ARIA label for the input field.
+     */
     inputAriaLabel?: string;
+    /**
+     * The ID of the container where search results are displayed.
+     */
     searchResultsContainerId?: string;
+    /**
+     * The ID of the currently active search result.
+     */
     activeDescendant?: string;
-    /**  Icon names labels for a11y */
+    /**
+     * Icon labels for accessibility.
+     */
     iconsNames?: {
         primary: string;
         secondary: string;
     };
-    /** TEXT_TYPES is exposed on the component itself */
+    /**
+     * The type of the text field.
+     */
     type?: TextFieldType;
+    /**
+     * The maximum number of characters allowed.
+     */
     maxLength?: number;
+    /**
+     * If true, allows the user to exceed the character limit set by `maxLength`.
+     */
     allowExceedingMaxLength?: boolean;
+    /**
+     * If true, trims whitespace from the input value.
+     */
     trim?: boolean;
-    /** ARIA role for container landmark */
+    /**
+     * The ARIA role of the text field.
+     */
     role?: string;
-    /** adds required to the input element */
+    /**
+     * If true, marks the input as required.
+     */
     required?: boolean;
+    /**
+     * The error message displayed when a required field is left empty.
+     */
     requiredErrorText?: string;
-    /** shows loading animation */
+    /**
+     * If true, displays a loading indicator inside the text field.
+     */
     loading?: boolean;
+    /**
+     * Test ID for the secondary icon.
+     */
     secondaryDataTestId?: string;
+    /**
+     * The tab order of the input field.
+     */
     tabIndex?: number;
+    /**
+     * The name attribute for the input field.
+     */
     name?: string;
+    /**
+     * If true, renders only an underline style for the text field.
+     */
     underline?: boolean;
     /**
-     * When true, component is controlled by an external state
+     * If true, the component is controlled by an external state.
      */
     controlled?: boolean;
+    /**
+     * Tooltip content for the primary icon.
+     */
     iconTooltipContent?: string;
+    /**
+     * Tooltip content for the secondary icon.
+     */
     secondaryTooltipContent?: string;
+    /**
+     * The text direction of the input.
+     */
     dir?: "ltr" | "rtl" | "auto";
 }
 declare const _default: ((VibeComponent<TextFieldProps & React.RefAttributes<unknown>, unknown> & Partial<{

package/dist/components/TextWithHighlight/TextWithHighlight.d.ts

@@ -2,22 +2,49 @@ import React from "react";
 import VibeComponentProps from "../../types/VibeComponentProps";
 import { TooltipPositions } from "../Tooltip/Tooltip.types";
 export interface TextWithHighlightProps extends VibeComponentProps {
-    /** Text to wrap */
+    /**
+     * The text content to display.
+     */
     text?: string;
+    /**
+     * The term to highlight within the text.
+     */
     highlightTerm?: string;
-    /** Number of highlighted parts */
+    /**
+     * The maximum number of highlighted terms allowed.
+     */
     limit?: number;
+    /**
+     * If true, the highlight search is case-insensitive.
+     */
     ignoreCase?: boolean;
-    /** Should use ellipsis */
+    /**
+     * If true, truncates overflowing text with an ellipsis.
+     */
     useEllipsis?: boolean;
-    /** Allow highlight every word as a separate term */
+    /**
+     * If true, allows splitting the highlight term into separate words.
+     */
     allowTermSplit?: boolean;
+    /**
+     * The number of lines to display before truncating with an ellipsis.
+     */
     linesToClamp?: number;
-    /** Tooltip to show when there is no overflow */
+    /**
+     * Tooltip content displayed when there is no overflow.
+     */
     nonEllipsisTooltip?: string;
-    /** HTML tag to wrap the selected text */
+    /**
+     * The HTML tag used to wrap highlighted text.
+     */
     wrappingTextTag?: keyof JSX.IntrinsicElements;
+    /**
+     * Class name applied to the wrapping element of highlighted text.
+     */
     wrappingElementClassName?: string;
+    /**
+     * The position of the tooltip when displayed.
+     */
     tooltipPosition?: TooltipPositions;
 }
 declare const TextWithHighlight: React.FC<TextWithHighlightProps>;

package/dist/components/ThemeProvider/ThemeProvider.d.ts

@@ -3,23 +3,26 @@ import { SystemTheme as SystemThemeEnum, Theme, ThemeColor as ThemeColorEnum } f
 import { SystemTheme } from "./ThemeProvider.types";
 export interface ThemeProviderProps {
     /**
-     * The theme config to apply, consists of a "name" - the name of css class that will be added to the children, which should be unique, and the object of colors overrides for each system theme.
+     * The theme configuration to apply. It consists of a `name` (a unique CSS class name added to the children)
+     * and an object of color overrides for each system theme.
      */
     themeConfig?: Theme;
     /**
-     * The children to render with the theme
+     * The children to be rendered with the applied theme.
      */
     children: ReactElement;
     /**
-     * String which adds up to theme name selector to make it more specific (in case if themeConfig.name is colliding with some other class name)
+     * A string added to the theme name selector to make it more specific, in case `themeConfig.name`
+     * collides with another class name.
      */
     themeClassSpecifier?: string;
     /**
-     * The system theme to apply to the body element on mount, if there is no theme class name on the body element already
+     * The system theme to apply to the `body` element on mount,
+     * if there is no system theme class name on the body already.
      */
     systemTheme?: SystemTheme;
     /**
-     * ClassName to add to the wrapping div
+     * Class name applied to the wrapping `div`.
      */
     className?: string;
 }

package/dist/components/Tipseen/Tipseen.d.ts

@@ -11,43 +11,101 @@ import { TooltipPositions } from "../Tooltip/Tooltip.types";
 import { TooltipPositions as TooltipPositionsEnum } from "../Tooltip/TooltipConstants";
 export interface TipseenProps extends VibeComponentProps {
     /**
-     * Classname for overriding TipseenTitle styles
+     * Class name applied to the Tipseen title.
      */
     titleClassName?: string;
+    /**
+     * The position of the Tipseen relative to the target element.
+     */
     position?: TooltipPositions;
+    /**
+     * The animation type used for showing/hiding the Tipseen.
+     */
     animationType?: DialogAnimationType;
+    /**
+     * The delay in milliseconds before hiding the Tipseen.
+     */
     hideDelay?: number;
+    /**
+     * The delay in milliseconds before showing the Tipseen.
+     */
     showDelay?: number;
+    /**
+     * The title text of the Tipseen.
+     */
     title?: string;
+    /**
+     * If true, hides the close button.
+     */
     hideCloseButton?: boolean;
+    /**
+     * The child element that triggers the Tipseen.
+     */
     children?: ReactElement;
+    /**
+     * The CSS selector of the container where the Tipseen should be rendered.
+     */
     containerSelector?: string;
+    /**
+     * Events that trigger hiding the Tipseen.
+     */
     hideTrigger?: DialogTriggerEvent | Array<DialogTriggerEvent>;
+    /**
+     * Events that trigger showing the Tipseen.
+     */
     showTrigger?: DialogTriggerEvent | Array<DialogTriggerEvent>;
+    /**
+     * The width of the Tipseen.
+     */
     width?: number;
+    /**
+     * Offset values for positioning adjustments.
+     */
     moveBy?: MoveBy;
+    /**
+     * If true, hides the Tipseen when the reference element is hidden.
+     */
     hideWhenReferenceHidden?: boolean;
+    /**
+     * Class name applied to the reference wrapper element.
+     */
     referenceWrapperClassName?: string;
     /**
-     * when false, the arrow of the tooltip is hidden
+     * If false, hides the arrow of the Tipseen.
      */
     tip?: boolean;
-    /** Class name for a tooltip's arrow */
+    /**
+     * Class name applied to the Tipseen arrow.
+     */
     tooltipArrowClassName?: string;
     /**
-     * PopperJS Modifiers type
+     * Custom Popper.js modifiers.
      * https://popper.js.org/docs/v2/modifiers/
      */
     modifiers?: Array<Modifier<unknown>>;
+    /**
+     * The aria-label for the close button.
+     */
     closeAriaLabel?: string;
+    /**
+     * Callback fired when the Tipseen is closed.
+     */
     onClose?: (event?: React.MouseEvent<HTMLButtonElement>) => void;
+    /**
+     * The content displayed inside the Tipseen.
+     */
     content: ElementContent;
     /**
-     * Control the color of the Tipseen close button. Dark theme can be useful while presenting bright images under the tipseen image
+     * The theme of the Tipseen close button.
      */
     closeButtonTheme?: TipseenCloseButtonTheme;
+    /**
+     * If true, renders the Tipseen as a floating element without a reference.
+     */
     floating?: boolean;
-    /** The color of the Tipseen */
+    /**
+     * The color theme of the Tipseen.
+     */
     color?: TipseenColor;
 }
 export declare const TipseenContext: React.Context<TipseenColor>;

package/dist/components/Tipseen/TipseenBasicContent.d.ts

@@ -2,8 +2,17 @@ import React from "react";
 import { VibeComponentProps } from "../../types";
 import { ElementContent } from "../../types/ElementContent";
 export interface TipseenBasicContentProps extends VibeComponentProps {
+    /**
+     * The title text displayed in the Tipseen content.
+     */
     title?: string;
+    /**
+     * Class name applied to the title.
+     */
     titleClassName?: string;
+    /**
+     * The content inside the Tipseen.
+     */
     children?: ElementContent | ElementContent[];
 }
 declare const TipseenBasicContent: React.FC<TipseenBasicContentProps>;

package/dist/components/Tipseen/TipseenContent.d.ts

@@ -3,21 +3,45 @@ import { VibeComponentProps } from "../../types";
 import { ElementContent } from "../../types/ElementContent";
 import { SubIcon } from "../../types";
 export interface TipseenContentProps extends VibeComponentProps {
+    /**
+     * The title text displayed in the Tipseen content.
+     */
     title?: string;
     /**
-     * Classname for overriding TipseenTitle styles
+     * Class name applied to the Tipseen title.
      */
     titleClassName?: string;
+    /**
+     * If true, hides the dismiss button.
+     */
     hideDismiss?: boolean;
+    /**
+     * The content inside the Tipseen.
+     */
     children?: ElementContent;
+    /**
+     * If true, hides the submit button.
+     */
     hideSubmit?: boolean;
+    /**
+     * The text displayed on the submit button.
+     */
     submitButtonText?: string;
     /**
      * Icon to display in the submit button
      */
     submitButtonIcon?: SubIcon;
+    /**
+     * Callback fired when the submit button is clicked.
+     */
     onSubmit?: (event: React.MouseEvent) => void;
+    /**
+     * The text displayed on the dismiss button.
+     */
     dismissButtonText?: string;
+    /**
+     * Callback fired when the dismiss button is clicked.
+     */
     onDismiss?: (event: React.MouseEvent) => void;
 }
 declare const TipseenContent: FC<TipseenContentProps>;

package/dist/components/Tipseen/TipseenImage.d.ts

@@ -1,8 +1,20 @@
 import React from "react";
 export interface TipseenImageProps {
+    /**
+     * The source URL of the image.
+     */
     src?: string | undefined;
+    /**
+     * The alternative text for the image, used for accessibility.
+     */
     alt?: string;
+    /**
+     * Class name applied to the image element.
+     */
     className?: string;
+    /**
+     * Class name applied to the TipseenMedia container.
+     */
     tipseenMediaClassName?: string;
 }
 declare const TipseenImage: React.FC<TipseenImageProps>;

package/dist/components/Tipseen/TipseenMedia/TipseenMedia.d.ts

@@ -2,6 +2,9 @@ import { PropsWithChildren, ReactNode } from "react";
 import VibeComponentProps from "../../../types/VibeComponentProps";
 import VibeComponent from "../../../types/VibeComponent";
 export interface TipseenMediaProps extends PropsWithChildren<VibeComponentProps> {
+    /**
+     * The media content displayed inside the Tipseen.
+     */
     children: ReactNode;
 }
 declare const TipseenMedia: VibeComponent<TipseenMediaProps, HTMLElement>;

package/dist/components/Tipseen/TipseenTitle.d.ts

@@ -1,6 +1,9 @@
 import { FC } from "react";
 import { VibeComponentProps } from "../../types";
 export interface TipseenTitleProps extends VibeComponentProps {
+    /**
+     * The title text displayed in the Tipseen.
+     */
     text?: string;
 }
 declare const TipseenTitle: FC<TipseenTitleProps>;

package/dist/components/Tipseen/TipseenWizard.d.ts

@@ -1,11 +1,17 @@
 import React, { FC } from "react";
 import { StepsProps } from "../Steps/Steps";
 export interface TipseenWizardProps extends StepsProps {
+    /**
+     * The title text displayed in the Tipseen Wizard.
+     */
     title?: string;
     /**
-     * Classname for overriding TipseenTitle styles
+     * Class name applied to the Tipseen title.
      */
     titleClassName?: string;
+    /**
+     * Callback fired when the wizard is completed.
+     */
     onFinish?: (e: React.MouseEvent | React.KeyboardEvent) => void;
 }
 declare const TipseenWizard: FC<TipseenWizardProps>;

package/dist/components/Toast/Toast.d.ts

@@ -4,25 +4,54 @@ import { ToastActionType as ToastActionTypeEnum, ToastType as ToastTypeEnum } fr
 import { ToastType, ToastAction } from "./Toast.types";
 import { VibeComponentProps } from "../../types";
 export interface ToastProps extends VibeComponentProps {
+    /**
+     * The actions available in the toast.
+     */
     actions?: ToastAction[];
-    /** If true, Toast is open (visible) */
+    /**
+     * If true, the toast is open (visible).
+     */
     open?: boolean;
+    /**
+     * If true, displays a loading indicator inside the toast.
+     */
     loading?: boolean;
+    /**
+     * The type of toast.
+     */
     type?: ToastType;
-    /** Possible to override the default icon */
+    /**
+     * The icon displayed in the toast.
+     */
     icon?: string | React.FC<IconSubComponentProps> | null;
-    /** If true, won't show the icon */
+    /**
+     * If true, hides the toast icon.
+     */
     hideIcon?: boolean;
-    /** The action to display */
+    /**
+     * The action element displayed in the toast.
+     */
     action?: JSX.Element;
-    /** If false, won't show the close button */
+    /**
+     * If false, hides the close button.
+     */
     closeable?: boolean;
+    /**
+     * Callback fired when the toast is closed.
+     */
     onClose?: () => void;
-    /** The number of milliseconds to wait before
-     * automatically closing the Toast
-     * (0 or null cancels this behaviour) */
+    /**
+     * The number of milliseconds before the toast automatically closes.
+     * (0 or null disables auto-close behavior).
+     */
     autoHideDuration?: number;
+    /**
+     * The content displayed inside the toast.
+     */
     children?: ReactElement | ReactElement[] | string;
+    /**
+     * The aria-label for the close button.
+     */
     closeButtonAriaLabel?: string;
 }
 declare const _default: ((import("../../types/VibeComponent").default<ToastProps, unknown> & Partial<{

package/dist/components/Toggle/MockToggle.d.ts

@@ -2,12 +2,33 @@ import { FC } from "react";
 import VibeComponentProps from "../../types/VibeComponentProps";
 import { ToggleSize } from "./Toggle.types";
 export interface MockToggleProps extends VibeComponentProps {
+    /**
+     * If true, hides the on/off labels.
+     */
     areLabelsHidden?: boolean;
+    /**
+     * If true, the toggle is in the "on" state.
+     */
     checked?: boolean;
+    /**
+     * The text displayed when the toggle is in the "off" state.
+     */
     offOverrideText?: string;
+    /**
+     * The text displayed when the toggle is in the "on" state.
+     */
     onOverrideText?: string;
+    /**
+     * Class name applied when the toggle is selected.
+     */
     selectedClassName?: string;
+    /**
+     * If true, disables the toggle.
+     */
     disabled: boolean;
+    /**
+     * The size of the toggle.
+     */
     size?: ToggleSize;
 }
 export declare const MockToggle: FC<MockToggleProps>;

package/dist/components/Toggle/Toggle.d.ts

@@ -3,20 +3,56 @@ import { VibeComponent, VibeComponentProps } from "../../types";
 import { ToggleSize } from "./Toggle.types";
 export interface ToggleProps extends VibeComponentProps {
     /**
-     * ClassName to override styles of selected toggle
+     * Class name applied when the toggle is selected.
      */
     toggleSelectedClassName?: string;
+    /**
+     * If true, the toggle is selected by default.
+     */
     isDefaultSelected?: boolean;
+    /**
+     * Controls the selected state of the toggle.
+     */
     isSelected?: boolean;
+    /**
+     * Callback fired when the toggle state changes.
+     */
     onChange?: (value: boolean, event: ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * The value associated with the toggle.
+     */
     value?: string;
+    /**
+     * The name attribute of the toggle input.
+     */
     name?: string;
+    /**
+     * If true, disables the toggle.
+     */
     disabled?: boolean;
+    /**
+     * If true, hides the on/off labels.
+     */
     areLabelsHidden?: boolean;
+    /**
+     * The text displayed when the toggle is in the "on" position.
+     */
     onOverrideText?: string;
+    /**
+     * The text displayed when the toggle is in the "off" position.
+     */
     offOverrideText?: string;
+    /**
+     * The ARIA label for accessibility.
+     */
     ariaLabel?: string;
+    /**
+     * The ID of the element controlled by the toggle.
+     */
     ariaControls?: string;
+    /**
+     * The size of the toggle.
+     */
     size?: ToggleSize;
 }
 declare const Toggle: VibeComponent<ToggleProps, HTMLInputElement>;