@vibe/core 3.68.0-alpha-cd9cf.0 → 3.68.1

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

@@ -0,0 +1,194 @@
+import React from "react";
+import { TextFieldFeedbackState as TextFieldFeedbackStateEnum, TextFieldTextType as TextFieldTextTypeEnum } from "./TextFieldConstants";
+import { type TextFieldType, type TextFieldSize } from "./TextField.types";
+import { type VibeComponentProps } from "../../types";
+export interface TextFieldProps extends VibeComponentProps {
+    /**
+     * The placeholder text displayed when the input is empty.
+     */
+    placeholder?: string;
+    /**
+     * 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;
+    /**
+     * The size of the text field.
+     */
+    size?: TextFieldSize;
+    /**
+     * Validation state for the text field.
+     */
+    validation?: {
+        status?: "error" | "success";
+        text?: string | React.ReactNode;
+    };
+    /**
+     * 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 labels for accessibility.
+     */
+    iconsNames?: {
+        primary: string;
+        secondary: string;
+    };
+    /**
+     * 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;
+    /**
+     * The ARIA role of the text field.
+     */
+    role?: string;
+    /**
+     * If true, marks the input as required.
+     */
+    required?: boolean;
+    /**
+     * The error message displayed when a required field is left empty.
+     */
+    requiredErrorText?: string;
+    /**
+     * 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;
+    /**
+     * 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: React.ForwardRefExoticComponent<TextFieldProps & React.RefAttributes<unknown>> & {
+    sizes: {
+        readonly SMALL: "small";
+        readonly MEDIUM: "medium";
+        readonly LARGE: "large";
+    };
+    types: typeof TextFieldTextTypeEnum;
+    feedbacks: typeof TextFieldFeedbackStateEnum;
+};
+export default _default;

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

@@ -0,0 +1,3 @@
+export type TextFieldType = "text" | "password" | "search" | "date" | "datetime-local" | "number" | "tel" | "url" | "email";
+export type TextFieldFeedbackState = "error" | "success";
+export type TextFieldSize = "small" | "medium" | "large";

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

@@ -0,0 +1,42 @@
+import { BASE_SIZES } from "../../constants";
+export declare enum TextFieldAriaLabel {
+    CHAR = "Input char count",
+    VALIDATION_TEXT = "Additional helper text"
+}
+declare const OLD_TEXT_FIELD_SIZES: {
+    s: "small";
+    md: "medium";
+    l: "large";
+};
+export type TextFieldSize = (typeof BASE_SIZES)[keyof typeof BASE_SIZES] | keyof typeof OLD_TEXT_FIELD_SIZES;
+/**
+ * @deprecated
+ */
+export declare enum TextFieldTextType {
+    TEXT = "text",
+    PASSWORD = "password",
+    SEARCH = "search",
+    DATE = "date",
+    DATE_TIME = "datetime-local",
+    NUMBER = "number",
+    TEL = "tel",
+    URL = "url",
+    EMAIL = "email"
+}
+/**
+ * @deprecated
+ */
+export declare enum TextFieldFeedbackState {
+    ERROR = "error",
+    SUCCESS = "success"
+}
+export declare const FEEDBACK_CLASSES: {
+    error: string;
+    success: string;
+};
+export declare const SIZE_MAPPER: {
+    small: string;
+    medium: string;
+    large: string;
+};
+export {};

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

@@ -0,0 +1,2 @@
+export { default as TextField, type TextFieldProps } from "./TextField";
+export * from "./TextField.types";

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

@@ -0,0 +1,57 @@
+import React from "react";
+import { type TooltipProps } from "../../components/Tooltip/Tooltip";
+import type VibeComponentProps from "../../types/VibeComponentProps";
+import { type TooltipPositions } from "../Tooltip/Tooltip.types";
+export interface TextWithHighlightProps extends VibeComponentProps {
+    /**
+     * The text content to display.
+     */
+    text?: string;
+    /**
+     * The term to highlight within the text.
+     */
+    highlightTerm?: string;
+    /**
+     * The maximum number of highlighted terms allowed.
+     */
+    limit?: number;
+    /**
+     * If true, the highlight search is case-insensitive.
+     */
+    ignoreCase?: boolean;
+    /**
+     * If true, truncates overflowing text with an ellipsis.
+     */
+    useEllipsis?: boolean;
+    /**
+     * 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 content displayed when there is no overflow.
+     */
+    nonEllipsisTooltip?: string;
+    /**
+     * 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.
+     * @deprecated Use `tooltipProps.position` instead.
+     */
+    tooltipPosition?: TooltipPositions;
+    /**
+     * Additional props to customize the tooltip component.
+     */
+    tooltipProps?: Partial<TooltipProps>;
+}
+declare const TextWithHighlight: React.FC<TextWithHighlightProps>;
+export default TextWithHighlight;

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

@@ -0,0 +1 @@
+export { default as TextWithHighlight, type TextWithHighlightProps } from "./TextWithHighlight";

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

@@ -0,0 +1,33 @@
+import React, { type ReactElement } from "react";
+import { SystemTheme as SystemThemeEnum, type Theme, ThemeColor as ThemeColorEnum } from "./ThemeProviderConstants";
+import { type SystemTheme } from "./ThemeProvider.types";
+export interface ThemeProviderProps {
+    /**
+     * 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 be rendered with the applied theme.
+     */
+    children: ReactElement;
+    /**
+     * 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 system theme class name on the body already.
+     */
+    systemTheme?: SystemTheme;
+    /**
+     * Class name applied to the wrapping `div`.
+     */
+    className?: string;
+}
+declare const _default: React.FC<ThemeProviderProps> & {
+    systemThemes: typeof SystemThemeEnum;
+    colors: typeof ThemeColorEnum;
+};
+export default _default;

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

@@ -0,0 +1,5 @@
+export type SystemTheme = "light" | "dark" | "black";
+/**
+ * Colors which are eligible for theming
+ */
+export type ThemeColor = "primary-color" | "primary-hover-color" | "primary-selected-color" | "primary-selected-hover-color" | "primary-selected-on-secondary-color" | "text-color-on-primary" | "brand-color" | "brand-hover-color" | "brand-selected-color" | "brand-selected-hover-color" | "text-color-on-brand";

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

@@ -0,0 +1,52 @@
+/**
+ * System themes: dark, light, black
+ */
+/**
+ * @deprecated
+ */
+export declare enum SystemTheme {
+    LIGHT = "light",
+    DARK = "dark",
+    BLACK = "black"
+}
+/**
+ * Colors which are eligible for theming
+ */
+/**
+ * @deprecated
+ */
+export declare enum ThemeColor {
+    primaryColor = "primary-color",
+    primaryHoverColor = "primary-hover-color",
+    primarySelectedColor = "primary-selected-color",
+    primarySelectedHoverColor = "primary-selected-hover-color",
+    primarySelectedOnSecondaryColor = "primary-selected-on-secondary-color",
+    textColorOnPrimary = "text-color-on-primary",
+    brandColor = "brand-color",
+    brandHoverColor = "brand-hover-color",
+    brandSelectedColor = "brand-selected-color",
+    brandSelectedHoverColor = "brand-selected-hover-color",
+    textColorOnBrand = "text-color-on-brand"
+}
+export type Theme = {
+    /**
+     * The name of the theme - name of css class that will be added to the children - should be unique
+     */
+    name: string;
+    colors: SystemThemeColorMap;
+};
+type SystemThemeColorMap = {
+    [key in SystemTheme]?: ThemeColorTokenValueMap;
+};
+export type ThemeColorTokenValueMap = ThemeColorTokenValue | ThemeCustomClassValue;
+export type ThemeColorTokenValue = {
+    [key in ThemeColor]?: string;
+};
+type ThemeCustomClassValue = {
+    [key: string]: ThemeColorTokenValue | ThemeCustomClassValue;
+};
+export declare const SystemThemeClassMap: SystemThemeClassMapType;
+type SystemThemeClassMapType = {
+    [key in SystemTheme]: string;
+};
+export {};

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

@@ -0,0 +1,10 @@
+import { type Theme } from "./ThemeProviderConstants";
+import { type SystemTheme } from "./ThemeProvider.types";
+export declare const shouldGenerateTheme: (themeConfig: Theme) => boolean;
+export declare const generateThemeCssOverride: (themeConfig: Theme, themeClassSpecifier: string) => string;
+export declare const generateRandomAlphaString: (length?: number) => string;
+export declare const addAppThemeSuffix: (systemTheme: SystemTheme) => string;
+export declare const getBodySystemThemeClassName: () => string;
+export declare const isAnySystemThemeClassNameOnBody: () => boolean;
+export declare const addSystemThemeClassNameToBody: (systemTheme: SystemTheme) => void;
+export declare const removeSystemThemeClassNameFromBody: (systemTheme: SystemTheme) => void;

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

@@ -0,0 +1,2 @@
+export { default as ThemeProvider, type ThemeProviderProps } from "./ThemeProvider";
+export * from "./ThemeProvider.types";

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

@@ -0,0 +1,119 @@
+import { type ReactElement } from "react";
+import { AnimationType as AnimationTypeEnum, HideShowEvent as HideShowEventEnum } from "../Dialog/DialogConstants";
+import { type DialogAnimationType, type DialogTriggerEvent } from "../Dialog/Dialog.types";
+import { TipseenCloseButtonTheme as TipseenCloseButtonThemeEnum, TipseenColor as TipseenColorEnum } from "./TipseenConstants";
+import { type TipseenCloseButtonTheme, type TipseenColor } from "./Tipseen.types";
+import { type ElementContent, type VibeComponentProps } from "../../types";
+import { type MoveBy } from "../../types/MoveBy";
+import { type Modifier } from "react-popper";
+import React from "react";
+import { type TooltipPositions } from "../Tooltip/Tooltip.types";
+import { TooltipPositions as TooltipPositionsEnum } from "../Tooltip/TooltipConstants";
+export interface TipseenProps extends VibeComponentProps {
+    /**
+     * 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;
+    /**
+     * If false, hides the arrow of the Tipseen.
+     */
+    tip?: boolean;
+    /**
+     * Class name applied to the Tipseen arrow.
+     */
+    tooltipArrowClassName?: string;
+    /**
+     * 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;
+    /**
+     * 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 theme of the Tipseen.
+     */
+    color?: TipseenColor;
+}
+export declare const TipseenContext: React.Context<TipseenColor>;
+declare const _default: React.ForwardRefExoticComponent<TipseenProps & React.RefAttributes<HTMLElement>> & {
+    closeButtonThemes: typeof TipseenCloseButtonThemeEnum;
+    animationTypes: typeof AnimationTypeEnum;
+    hideShowTriggers: typeof HideShowEventEnum;
+    colors: typeof TipseenColorEnum;
+    positions: typeof TooltipPositionsEnum;
+};
+export default _default;

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

@@ -0,0 +1,2 @@
+export type TipseenCloseButtonTheme = "light" | "dark" | "fixed-light" | "fixed-dark";
+export type TipseenColor = "primary" | "inverted";

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

@@ -0,0 +1,19 @@
+import React from "react";
+import { type VibeComponentProps } from "../../types";
+import { type 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>;
+export default TipseenBasicContent;

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

@@ -0,0 +1,20 @@
+export declare const SUBMIT_BUTTON_TEXT = "Submit";
+export declare const DISMISS_BUTTON_TEXT = "Dismiss";
+export declare const TIPSEEN_CLOSE_BUTTON_TEST_ID = "close-tipseen";
+export declare const TIPSEEN_CLOSE_BUTTON_ARIA_LABEL = "Close";
+/**
+ * @deprecated
+ */
+export declare enum TipseenCloseButtonTheme {
+    LIGHT = "light",
+    DARK = "dark",
+    FIXED_LIGHT = "fixed-light",
+    FIXED_DARK = "fixed-dark"
+}
+/**
+ * @deprecated
+ */
+export declare enum TipseenColor {
+    PRIMARY = "primary",
+    INVERTED = "inverted"
+}

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

@@ -0,0 +1,48 @@
+import React, { type FC } from "react";
+import { type VibeComponentProps } from "../../types";
+import { type ElementContent } from "../../types/ElementContent";
+import { type SubIcon } from "../../types";
+export interface TipseenContentProps extends VibeComponentProps {
+    /**
+     * The title text displayed in the Tipseen content.
+     */
+    title?: string;
+    /**
+     * 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>;
+export default TipseenContent;

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

@@ -0,0 +1,21 @@
+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>;
+export default TipseenImage;

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

@@ -0,0 +1,10 @@
+import React, { type PropsWithChildren, type ReactNode } from "react";
+import { type VibeComponentProps } from "../../../types";
+export interface TipseenMediaProps extends PropsWithChildren<VibeComponentProps> {
+    /**
+     * The media content displayed inside the Tipseen.
+     */
+    children: ReactNode;
+}
+declare const TipseenMedia: React.ForwardRefExoticComponent<TipseenMediaProps & React.RefAttributes<HTMLElement>>;
+export default TipseenMedia;

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

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