@ssa-ui-kit/core 3.25.0 → 3.26.0

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

@@ -1,5 +1,6 @@
 import type { UseFormReturn, FieldError } from 'react-hook-form';
 import { InputProps } from '../Input/types';
+import { LabelBadge } from '../Label/types';
 /**
  * Props for the TextField component
  *
@@ -55,6 +56,12 @@ export interface TextFieldProps extends InputProps, Partial<Pick<UseFormReturn,
      * Label text displayed above the input field
      */
     label?: string;
+    /**
+     * Status badge to the right of the label, e.g.
+     * `{ text: 'mapped', color: 'primary' }`. Announced as the field's
+     * description. Needs a `label`.
+     */
+    labelBadge?: LabelBadge;
     /**
      * React Hook Form field error object
      * Used to display validation error messages

package/dist/components/Textarea/types.d.ts

@@ -111,6 +111,10 @@ export interface TextareaProps extends Partial<Pick<UseFormReturn, 'register'>>
      * Defaults to `formElement-${name}` when not provided.
      */
     id?: string;
+    /**
+     * Ids of the elements describing the textarea — a label badge, helper text
+     */
+    'aria-describedby'?: string;
     /**
      * Paste event handler
      * Fired when content is pasted into the textarea

package/dist/components/Typeahead/Typeahead.context.d.ts

@@ -11,6 +11,7 @@ export declare const TypeaheadContext: React.Context<{
     isMultiple: boolean | undefined;
     singleLine: boolean;
     typeaheadId: string;
+    labelId: string | undefined;
     triggerRef: React.RefObject<HTMLDivElement | null>;
     className: string | undefined;
     startIcon: React.ReactNode;
@@ -24,8 +25,16 @@ export declare const TypeaheadContext: React.Context<{
     status: "error" | "success" | "basic";
     error: import("react-hook-form").FieldError | import("react-hook-form").Merge<import("react-hook-form").FieldError, import("react-hook-form").FieldErrorsImpl<any>> | undefined;
     placeholder: string | null | undefined;
-    options: (React.ReactElement<any, string | React.JSXElementConstructor<any>> | null)[];
+    listId: string;
+    menuItems: import("..").ContextMenuItem<import("./types").TypeaheadValue>[];
+    activeValue: import("./types").TypeaheadValue | null;
+    setActiveValue: React.Dispatch<React.SetStateAction<import("./types").TypeaheadValue | null>>;
+    inputAriaProps: {
+        'aria-controls': string | undefined;
+        'aria-activedescendant': string | undefined;
+    };
     customOptionValue: string | null;
+    handleOptionAction: (value: import("./types").TypeaheadValue) => void;
     handleChange: ({ value, shouldClose, resetInput, }: {
         value?: string | number;
         shouldClose?: boolean;

package/dist/components/Typeahead/Typeahead.d.ts

@@ -172,4 +172,4 @@ import { TypeaheadProps } from './types';
  *
  * @see https://www.w3.org/WAI/ARIA/apg/patterns/combobox/examples/combobox-select-only/
  */
-export declare const Typeahead: ({ name, label, value, defaultValue, selectedItems, defaultSelectedItems, isOpen, disabled, isDisabled, isMultiple, singleLine, children, className, startIcon, endIcon, error, success, helperText, validationSchema, placeholder, startIconClassName, endIconClassName, popoverClassName, optionsClassName, wrapperClassName, filterOptions, autoSelect, allowCustomValues, width, onChange, onEmptyChange, onClearAll, onRemoveSelectedClick, renderOption, }: TypeaheadProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Typeahead: ({ name, label, labelBadge, value, defaultValue, selectedItems, defaultSelectedItems, isOpen, disabled, isDisabled, isMultiple, singleLine, children, className, startIcon, endIcon, error, success, helperText, validationSchema, placeholder, startIconClassName, endIconClassName, popoverClassName, optionsClassName, wrapperClassName, filterOptions, autoSelect, allowCustomValues, width, onChange, onEmptyChange, onClearAll, onRemoveSelectedClick, renderOption, }: TypeaheadProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/dist/components/Typeahead/components/TypeaheadOptions.d.ts

@@ -1,2 +1,14 @@
 import { TypeaheadItemsListProps } from '../types';
-export declare const TypeaheadOptions: ({ noItemsMessage, children, }: TypeaheadItemsListProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+/**
+ * TypeaheadOptions - The Typeahead's option list: a `ContextMenu` driven from
+ * the Typeahead's input. The options themselves come from the `TypeaheadOption`
+ * children of `Typeahead`, filtered by the typed text. Rendered by
+ * `Typeahead` itself; reads everything from the Typeahead context.
+ *
+ * @example
+ * ```tsx
+ * // Inside a Typeahead's popup
+ * <TypeaheadOptions noItemsMessage="Nobody matches" />
+ * ```
+ */
+export declare const TypeaheadOptions: ({ noItemsMessage, className, }: TypeaheadItemsListProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/dist/components/Typeahead/styles.d.ts

@@ -75,3 +75,8 @@ export declare const TypeaheadTrigger: import("@emotion/styled").StyledComponent
     isOpen: boolean;
     status: ReturnType<typeof useTypeahead>["status"];
 }, {}, {}>;
+/** A user-typed value that is not one of the options. */
+export declare const CustomValueLabel: import("@emotion/styled").StyledComponent<{
+    theme?: Theme;
+    as?: React.ElementType;
+}, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, {}>;

package/dist/components/Typeahead/types.d.ts

@@ -1,5 +1,6 @@
 import { CommonProps } from '../../types/emotion';
 import { FieldError } from 'react-hook-form';
+import { LabelBadge } from '../Label/types';
 /**
  * Allowed value types for Typeahead options
  */
@@ -139,6 +140,12 @@ export interface TypeaheadProps {
      * Label text displayed above the input
      */
     label?: string;
+    /**
+     * Status badge to the right of the label, e.g.
+     * `{ text: 'mapped', color: 'primary' }`. Announced as the input's
+     * description. Needs a `label`.
+     */
+    labelBadge?: LabelBadge;
     /**
      * Helper text displayed below the input
      */
@@ -214,11 +221,17 @@ export interface TypeaheadProps {
  * Props used by the useTypeahead hook
  * Internal type that picks specific props from TypeaheadProps
  */
-export type UseTypeaheadProps = Pick<TypeaheadProps, 'selectedItems' | 'defaultSelectedItems' | 'isDisabled' | 'children' | 'isMultiple' | 'singleLine' | 'onChange' | 'onClearAll' | 'onRemoveSelectedClick' | 'onEmptyChange' | 'renderOption' | 'isOpen' | 'className' | 'startIcon' | 'endIcon' | 'startIconClassName' | 'endIconClassName' | 'name' | 'validationSchema' | 'error' | 'success' | 'placeholder' | 'filterOptions' | 'autoSelect' | 'allowCustomValues'>;
+export type UseTypeaheadProps = Pick<TypeaheadProps, 'selectedItems' | 'defaultSelectedItems' | 'isDisabled' | 'children' | 'isMultiple' | 'singleLine' | 'onChange' | 'onClearAll' | 'onRemoveSelectedClick' | 'onEmptyChange' | 'renderOption' | 'isOpen' | 'className' | 'startIcon' | 'endIcon' | 'startIconClassName' | 'endIconClassName' | 'name' | 'validationSchema' | 'error' | 'success' | 'placeholder' | 'filterOptions' | 'autoSelect' | 'allowCustomValues' | 'label'>;
 /**
  * Props for TypeaheadOptions container component
  */
 export interface TypeaheadItemsListProps extends CommonProps {
+    /**
+     * Ignored: the options come from the `TypeaheadOption` children of
+     * `Typeahead`, through context.
+     *
+     * @deprecated Has no effect. Removed in the next major release.
+     */
     children?: React.ReactNode;
     noItemsMessage?: string;
 }

package/dist/components/Typeahead/useTypeahead.d.ts

@@ -1,12 +1,13 @@
 import React from 'react';
 import { OpenChangeReason } from '@floating-ui/react';
+import { ContextMenuItem } from '../ContextMenu';
 import { TypeaheadOptionProps, TypeaheadValue, UseTypeaheadProps } from './types';
 type HandleChangeParams = {
     value?: string | number;
     shouldClose?: boolean;
     resetInput?: boolean;
 };
-export declare const useTypeahead: ({ name, isOpen: isInitOpen, selectedItems: providedSelectedItems, defaultSelectedItems, isDisabled, isMultiple, singleLine, children, className, startIcon, endIcon, startIconClassName, endIconClassName, validationSchema, error, success, placeholder, filterOptions, autoSelect, allowCustomValues, onChange, onClearAll, onRemoveSelectedClick, onEmptyChange, renderOption, }: UseTypeaheadProps) => {
+export declare const useTypeahead: ({ name, isOpen: isInitOpen, selectedItems: providedSelectedItems, defaultSelectedItems, isDisabled, isMultiple, singleLine, children, className, startIcon, endIcon, startIconClassName, endIconClassName, validationSchema, error, success, placeholder, filterOptions, autoSelect, allowCustomValues, onChange, onClearAll, onRemoveSelectedClick, onEmptyChange, renderOption, label, }: UseTypeaheadProps) => {
     isOpen: boolean;
     isDisabled: boolean | undefined;
     optionsWithKey: Record<string | number, TypeaheadOptionProps>;
@@ -16,6 +17,7 @@ export declare const useTypeahead: ({ name, isOpen: isInitOpen, selectedItems: p
     isMultiple: boolean | undefined;
     singleLine: boolean;
     typeaheadId: string;
+    labelId: string | undefined;
     triggerRef: React.RefObject<HTMLDivElement | null>;
     className: string | undefined;
     startIcon: React.ReactNode;
@@ -29,8 +31,16 @@ export declare const useTypeahead: ({ name, isOpen: isInitOpen, selectedItems: p
     status: "error" | "success" | "basic";
     error: import("react-hook-form").FieldError | import("react-hook-form").Merge<import("react-hook-form").FieldError, import("react-hook-form").FieldErrorsImpl<any>> | undefined;
     placeholder: string | null | undefined;
-    options: (React.ReactElement<any, string | React.JSXElementConstructor<any>> | null)[];
+    listId: string;
+    menuItems: ContextMenuItem<TypeaheadValue>[];
+    activeValue: TypeaheadValue | null;
+    setActiveValue: React.Dispatch<React.SetStateAction<TypeaheadValue | null>>;
+    inputAriaProps: {
+        'aria-controls': string | undefined;
+        'aria-activedescendant': string | undefined;
+    };
     customOptionValue: string | null;
+    handleOptionAction: (value: TypeaheadValue) => void;
     handleChange: ({ value, shouldClose, resetInput, }: HandleChangeParams) => void;
     useFormResult: import("react-hook-form").UseFormReturn<import("react-hook-form").FieldValues, any, import("react-hook-form").FieldValues>;
     register: import("react-hook-form").UseFormRegister<import("react-hook-form").FieldValues>;

package/dist/components/index.d.ts

@@ -25,6 +25,8 @@ export { default as Radio } from './Radio';
 export type { RadioProps } from './Radio/types';
 export { default as RadioGroup } from './RadioGroup';
 export type * from './RadioGroup/types';
+export * from './ContextMenu';
+export type * from './ContextMenu/types';
 export { default as Dropdown } from './Dropdown';
 export type * from './Dropdown/types';
 export { default as DropdownArrow } from './DropdownArrow';
@@ -91,6 +93,7 @@ export type * from './Chip/types';
 export { default as Avatar } from './Avatar';
 export * from './Avatar/types';
 export { default as Label } from './Label';
+export { getLabelBadgeId } from './Label';
 export type * from './Label/types';
 export { default as Indicator } from './Indicator';
 export type * from './Indicator/types';
@@ -119,6 +122,8 @@ export * from './NavBar';
 export * from './CollapsibleNavBar';
 export * from './Header';
 export type * from './Header/types';
+export * from './Footer';
+export type * from './Footer/types';
 export * from './TreeView';
 export { default as Tab } from './Tab';
 export { default as TabBar } from './TabBar';