@splunk/react-ui 4.16.2 → 4.17.0

package/stubs-splunkui.d.ts

@@ -32,7 +32,10 @@ declare module '@splunk/ui-utils/format' {
 declare module '@splunk/ui-utils/focus' {
     // getSortedTabbableElements returns Elements
     // handleTab / takeFocus both call focus() which exists only on HTMLElement/SVGElement (modern browsers), but not Element
-    function getSortedTabbableElements(container: Element): Element[];
+    function getSortedTabbableElements(
+        container: Element,
+        options?: { ignoreTabIndex: boolean }
+    ): Element[];
     function isTabKey(event: KeyboardEvent<Element>): boolean;
     function handleTab(container: Element, event: KeyboardEvent): Element | null;
     function takeFocus(container: Element, defaultElement?: 'first' | 'container'): Element | null;

package/types/src/Button/icons/CaretSmallDown.d.ts

@@ -0,0 +1,2 @@
+declare const CaretSmallDown: () => JSX.Element;
+export default CaretSmallDown;

package/types/src/Button/icons/External.d.ts

@@ -0,0 +1,2 @@
+declare function External(): JSX.Element;
+export default External;

package/types/src/Code/Code.d.ts

@@ -16,6 +16,10 @@ interface CodePropsBase {
      * Applies syntax highlighting for a specific programming language.
      */
     language?: CodeSupportedLanguages;
+    /**
+     * In cases where `language` is not valid `Code` will use this value as the fallback for `language`.
+     */
+    languageFallback?: CodeSupportedLanguages;
     /**
      * Displays the indent guideline.
      */
@@ -26,12 +30,13 @@ interface CodePropsBase {
     value?: string;
 }
 declare type CodeProps = ComponentProps<CodePropsBase, 'pre'>;
-declare function Code({ elementRef, indentChars, language, showIndentGuide, value, ...otherProps }: CodeProps): JSX.Element;
+declare function Code({ elementRef, indentChars, language, languageFallback, showIndentGuide, value, ...otherProps }: CodeProps): JSX.Element;
 declare namespace Code {
     var propTypes: {
         elementRef: PropTypes.Requireable<object>;
         indentChars: PropTypes.Requireable<number>;
         language: PropTypes.Requireable<string>;
+        languageFallback: PropTypes.Requireable<string>;
         showIndentGuide: PropTypes.Requireable<boolean>;
         value: PropTypes.Requireable<string>;
     };

package/types/src/CollapsiblePanel/CollapsiblePanel.d.ts

@@ -75,7 +75,6 @@ interface CollapsiblePanelPropsBase {
     title: React.ReactNode;
     /**
      * Renders toggle button separate from `title`, allowing `title` to contain interactive elements.
-     * @includeTheme prisma
      */
     titleWithActions?: boolean;
 }

package/types/src/CollapsiblePanel/icons/ExpandPanel.d.ts

@@ -0,0 +1,11 @@
+import PropTypes from 'prop-types';
+interface ChevronRightIconProps {
+    open?: boolean;
+}
+declare const ChevronRight: {
+    ({ open }: ChevronRightIconProps): JSX.Element;
+    propTypes: {
+        open: PropTypes.Requireable<boolean>;
+    };
+};
+export default ChevronRight;

package/types/src/Date/Icon.d.ts

@@ -1,2 +1,2 @@
-import { SVGPropsOptionalViewBox } from '@splunk/react-icons/SVG';
+import { SVGPropsOptionalViewBox } from '@splunk/react-icons/SVGEnterprise';
 export default function CalendarIcon(props: SVGPropsOptionalViewBox): JSX.Element;

package/types/src/Dropdown/docs/examples/Submenu.d.ts

@@ -0,0 +1,2 @@
+declare function Submenu(): JSX.Element;
+export default Submenu;

package/types/src/DualListbox/DualListbox.d.ts

@@ -0,0 +1,87 @@
+import React from 'react';
+import Option from './Option';
+import { ComponentProps } from '../utils/types';
+/** @public */
+declare type DualListboxSelectHandler = (event: React.MouseEvent<HTMLButtonElement> | React.MouseEvent<HTMLLIElement> | React.KeyboardEvent<HTMLUListElement>, data: {
+    /**
+     * The list `name` associated to the batch action.
+     */
+    listName: string;
+    /**
+     * The values marked as selected with the given list.
+     */
+    values: string[];
+}) => void;
+/** @public */
+declare type DualListboxChangeHandler = (event: React.MouseEvent<HTMLButtonElement> | React.MouseEvent<HTMLLIElement> | React.KeyboardEvent<HTMLUListElement>, data: {
+    /**
+     * The values being changed.
+     */
+    affectedValues: string[];
+    /**
+     * The a11y text describing the move action.
+     * If `controlled="true"` the presentation of the text MUST be implemented by the consumer.
+     */
+    screenReaderMessage: string;
+    /**
+     * The list `name` associated to the source of the move action.
+     */
+    sourceListName: string;
+    /**
+     * The values now contained within the source list.
+     */
+    sourceValues: string[];
+    /**
+     * The list `name` associated to the target of the move action.
+     */
+    targetListName: string;
+    /**
+     * The values now contained within the target list.
+     */
+    targetValues: string[];
+}) => void;
+declare type ListboxConfig = {
+    name: string;
+    label: string;
+};
+interface DualListboxPropsBase {
+    /**
+     * All children must be instances of `DualListbox.Option`.
+     */
+    children?: React.ReactNode;
+    /**
+     * When true, `Options`'s `listName` and `selected` state props are fully controlled.
+     */
+    controlled?: boolean;
+    /**
+     * When true, fill height and width of the relative parent container.
+     */
+    fill?: boolean;
+    /**
+     * When false, display as inline-block with the default width.
+     * Ignored if `fill=true` set.
+     */
+    inline?: boolean;
+    /**
+     * List identifiers.
+     * `name` should map to child `Option`s `listName` prop, and will be returned with event calls.
+     * `label` will be used for visual and assistive text.
+     */
+    lists: ListboxConfig[];
+    /**
+     * Callback for selected options moving from one list to another.
+     */
+    onChange?: DualListboxChangeHandler;
+    /**
+     * Callback for single selected/de-select actions.
+     */
+    onSelect?: DualListboxSelectHandler;
+}
+declare type DualListboxProps = ComponentProps<DualListboxPropsBase, 'div'>;
+declare function DualListbox({ children, controlled, fill, inline, onChange, onSelect, lists, ...otherProps }: DualListboxProps): JSX.Element;
+declare namespace DualListbox {
+    var propTypes: React.WeakValidationMap<DualListboxPropsBase>;
+    var Option: typeof import("./Option").default;
+}
+export default DualListbox;
+export { DualListboxChangeHandler, DualListboxSelectHandler, DualListboxProps, DualListboxPropsBase, Option, };

package/types/src/DualListbox/DualListboxContext.d.ts

@@ -0,0 +1,27 @@
+import React from 'react';
+export declare type UpdateCallbackHandler = (callback?: React.DispatchWithoutAction) => void;
+export declare type UpdateNameCallbackHandler = (name: string, callback?: React.DispatchWithoutAction) => void;
+export declare type UpdateValueCallbackHandler = (value: string, callback?: React.DispatchWithoutAction) => void;
+export declare type GetActiveValueHandler = (name: string) => string | undefined;
+export declare type GetCountHandler = (name: string) => number;
+export declare type GetScreenReaderMessageHandler = () => string | undefined;
+export declare type GetSelectedStateHandler = (value: string) => boolean;
+export interface DualListboxContextValue {
+    controlled?: boolean;
+    getActiveValue?: GetActiveValueHandler;
+    getScreenReaderMessage?: GetScreenReaderMessageHandler;
+    getSelectedStateForValue?: GetSelectedStateHandler;
+    getSelectedValueCount?: GetCountHandler;
+    getValueCount?: GetCountHandler;
+    updateLabelRefreshHookByName?: UpdateNameCallbackHandler;
+    updateOptionRefreshHookByValue?: UpdateValueCallbackHandler;
+    updateScreenReaderRefreshHook?: UpdateCallbackHandler;
+}
+/**
+ * A React context used to inform subcomponets of DualListbox of parent component values.
+ * The context interface is `DualListboxContextValue`.
+ * Defaults to `'{}'`.
+ * @public
+ */
+declare const DualListboxContext: React.Context<DualListboxContextValue>;
+export default DualListboxContext;

package/types/src/DualListbox/Label.d.ts

@@ -0,0 +1,37 @@
+import React from 'react';
+import { SwitchCheckboxWithSomeClickHandler } from '@splunk/react-ui/Switch';
+import { ComponentProps } from '../utils/types';
+declare type ListboxLabelSwitchClickHandler = SwitchCheckboxWithSomeClickHandler;
+interface ListboxLabelPropsBase {
+    /**
+     * ID for the label. Used to label the switch and associated listbox.
+     */
+    id: string;
+    /**
+     * The list index, used in layout.
+     */
+    index: number;
+    /**
+     * Associated listbox id.
+     */
+    listId: string;
+    /**
+     * Name associated to the label and listbox. Used for event callbacks.
+     */
+    name: string;
+    /**
+     * Toggle callback for the "select-all" switch.
+     */
+    onSwitchClick: ListboxLabelSwitchClickHandler;
+    /**
+     * The value of this option and the label shown for it.
+     */
+    value: string;
+}
+declare type ListboxLabelProps = ComponentProps<ListboxLabelPropsBase, 'div'>;
+declare function ListboxLabel({ id, index, listId, name, onSwitchClick, value }: ListboxLabelProps): JSX.Element | null;
+declare namespace ListboxLabel {
+    var propTypes: React.WeakValidationMap<ListboxLabelPropsBase>;
+}
+export default ListboxLabel;
+export { ListboxLabelSwitchClickHandler };

package/types/src/DualListbox/Listbox.d.ts

@@ -0,0 +1,54 @@
+import React from 'react';
+import { ComponentProps } from '../utils/types';
+declare type ListboxClickHandler = (event: React.MouseEvent<HTMLLIElement> | React.KeyboardEvent<HTMLUListElement>, data: {
+    name: string;
+    value: string;
+}) => void;
+declare type ListboxKeyDownHandler = (event: React.KeyboardEvent<HTMLUListElement>, data: {
+    name: string;
+}) => void;
+declare type ListboxSelectAllClickHandler = (event: React.MouseEvent<HTMLButtonElement>, data: {
+    name: string;
+    selected: true | false | 'some';
+}) => void;
+interface ListboxPropsBase {
+    /**
+     * All children must be instances of `DualListbox.Option`.
+     */
+    children?: React.ReactNode;
+    /**
+     * Ref callback.
+     */
+    elementRef?: React.Ref<HTMLUListElement>;
+    /**
+     * The list index, used in layout.
+     */
+    index: number;
+    /**
+     * Label text for the listbox.
+     */
+    label: string;
+    /**
+     * Name associated to the listbox. Used for event callbacks.
+     */
+    name: string;
+    /**
+     * Callback for click event.
+     */
+    onClick?: ListboxClickHandler;
+    /**
+     * Callback for keydown event.
+     */
+    onKeyDown?: ListboxKeyDownHandler;
+    /**
+     * Callback for associated "select-all" switch.
+     */
+    onSelectAllClick?: ListboxSelectAllClickHandler;
+}
+declare type ListboxProps = ComponentProps<ListboxPropsBase, 'ul'>;
+declare function Listbox({ children, elementRef, index, label, name, onClick, onKeyDown, onSelectAllClick, ...otherProps }: ListboxProps): JSX.Element;
+declare namespace Listbox {
+    var propTypes: React.WeakValidationMap<ListboxPropsBase>;
+}
+export default Listbox;
+export { ListboxClickHandler, ListboxKeyDownHandler, ListboxSelectAllClickHandler };

package/types/src/DualListbox/ListboxContext.d.ts

@@ -0,0 +1,32 @@
+import React from 'react';
+import { UpdateNameCallbackHandler, UpdateValueCallbackHandler } from './DualListboxContext';
+export declare type OptionClickHandler = (event: React.MouseEvent<HTMLLIElement>, data: {
+    value: string;
+    name?: string;
+}) => void;
+export declare type GetOptionStateHandler = (value: string) => {
+    active: boolean;
+    selected: boolean;
+};
+export declare type GetLabelStateHandler = () => {
+    disabled: boolean;
+    selected: boolean | 'some';
+    selectedValueCount: number;
+    valueCount: number;
+};
+export interface ListboxContextValue {
+    controlled?: boolean;
+    onOptionClick?: OptionClickHandler;
+    getLabelState?: GetLabelStateHandler;
+    getOptionStateForValue?: GetOptionStateHandler;
+    updateLabelRefreshHookByName?: UpdateNameCallbackHandler;
+    updateOptionRefreshHookByValue?: UpdateValueCallbackHandler;
+}
+/**
+ * A React context used to inform subcomponets of Listbox of parent component values.
+ * The context interface is `ListboxContextValue`.
+ * Defaults to `'{}'`.
+ * @public
+ */
+declare const ListboxContext: React.Context<ListboxContextValue>;
+export default ListboxContext;

package/types/src/DualListbox/Option.d.ts

@@ -0,0 +1,35 @@
+import React from 'react';
+import { ComponentProps } from '../utils/types';
+declare type OptionClickHandler = (event: React.MouseEvent<HTMLLIElement>, data: {
+    value: string;
+}) => void;
+interface OptionPropsBase {
+    /**
+     * The id used for accessibility labelling.
+     */
+    id: string;
+    /**
+     * The display of this option, used in key matching.
+     */
+    label: string;
+    /**
+     * Parent list `name` associated to option.
+     * Used in intial state and controlled variants.
+     */
+    listName?: string;
+    /**
+     * When true, applies visual and assistive selected state.
+     */
+    selected?: boolean;
+    /**
+     * The value of this option, returned in events.
+     */
+    value: string;
+}
+declare type OptionProps = ComponentProps<OptionPropsBase, 'li'>;
+declare function Option({ id, label, selected: selectedProp, value, ...otherProps }: OptionProps): JSX.Element | null;
+declare namespace Option {
+    var propTypes: React.WeakValidationMap<OptionPropsBase>;
+}
+export default Option;
+export { OptionClickHandler };

package/types/src/DualListbox/ScreenReaderWrapper.d.ts

@@ -0,0 +1,4 @@
+declare function ScreenReaderWrapper({ ...otherProps }: {
+    [x: string]: any;
+}): JSX.Element | null;
+export default ScreenReaderWrapper;

package/types/src/DualListbox/ToolbarButton.d.ts

@@ -0,0 +1,38 @@
+import React from 'react';
+import { ComponentProps } from '../utils/types';
+declare type ButtonClickHandler = (event: React.MouseEvent<HTMLButtonElement>, data: {
+    name: string;
+}) => void;
+interface ToolbarButtonPropsBase {
+    /**
+     * Assitive text. Ideally should contain `tooltipLabel` as root of text.
+     */
+    ariaLabel: string;
+    /**
+     * Assitive value. aria shortcut key associated to the listbox actions.
+     */
+    ariaKeyShortcuts?: string;
+    /**
+     * Icon for the button.
+     */
+    icon: React.ReactNode;
+    /**
+     * Associated name for callbacks.
+     */
+    name: string;
+    /**
+     * Visible tooltip text. Ideally a short message.
+     */
+    tooltipLabel: string;
+    /**
+     * Default tooltipPlacement. Value should be opposite of action direction: e.g. place the tooltip to the left of the action that moves items to the right.
+     */
+    tooltipPlacement: 'above' | 'below' | 'left' | 'right';
+}
+declare type ToolbarButtonProps = ComponentProps<ToolbarButtonPropsBase, 'button'>;
+declare function ToolbarButton({ ariaLabel, ariaKeyShortcuts, icon, name, tooltipLabel, tooltipPlacement, ...otherProps }: ToolbarButtonProps): JSX.Element | null;
+declare namespace ToolbarButton {
+    var propsTypes: React.WeakValidationMap<ComponentProps<ToolbarButtonPropsBase, "button", never>>;
+}
+export default ToolbarButton;
+export { ButtonClickHandler };

package/types/src/DualListbox/ToolbarContext.d.ts

@@ -0,0 +1,21 @@
+import React from 'react';
+export declare type ButtonClickHandler = (event: React.MouseEvent<HTMLButtonElement>, data: {
+    name: string;
+}) => void;
+export declare type UpdateCallbackHandler = (name: string, callback?: React.DispatchWithoutAction) => void;
+export declare type GetButtonStateHandler = (value: string) => {
+    disabled: boolean;
+};
+export interface ToolbarContextValue {
+    updateButtonRefreshHookByName?: UpdateCallbackHandler;
+    onButtonClick?: ButtonClickHandler;
+    getButtonState?: GetButtonStateHandler;
+}
+/**
+ * A React context used to inform subcomponets of Toolbar of parent component values.
+ * The context interface is `ToolbarContextValue`.
+ * Defaults to `'{}'`.
+ * @public
+ */
+declare const ToolbarContext: React.Context<ToolbarContextValue>;
+export default ToolbarContext;

package/types/src/DualListbox/docs/examples/Basic.d.ts

@@ -0,0 +1,2 @@
+declare function Uncontrolled(): JSX.Element;
+export default Uncontrolled;

package/types/src/DualListbox/docs/examples/Controlled.d.ts

@@ -0,0 +1,2 @@
+declare const Controlled: () => JSX.Element;
+export default Controlled;

package/types/src/DualListbox/docs/examples/Fill.d.ts

@@ -0,0 +1,2 @@
+declare function Fill(): JSX.Element;
+export default Fill;

package/types/src/DualListbox/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './DualListbox';
+export * from './DualListbox';

package/types/src/DualListbox/listboxUtils.d.ts

@@ -0,0 +1,4 @@
+declare const arrayWithToggledValue: (valueArr: string[], toggleValue: string) => string[];
+declare const arrayWithRemovedValues: (valueArr: string[], removedValues: string[]) => string[];
+declare const findNextValue: (index: number, originalValues: string[], removedValues: string[]) => string | undefined;
+export { arrayWithToggledValue, arrayWithRemovedValues, findNextValue };

package/types/src/File/Icon.d.ts

@@ -1,2 +1,2 @@
-import { SVGPropsOptionalViewBox } from '@splunk/react-icons/SVG';
+import { SVGPropsOptionalViewBox } from '@splunk/react-icons/SVGEnterprise';
 export default function FileIcon(props: SVGPropsOptionalViewBox): JSX.Element;

package/types/src/File/IconCloud.d.ts

@@ -1,2 +1,2 @@
-import { SVGPropsOptionalViewBox } from '@splunk/react-icons/SVG';
+import { SVGPropsOptionalViewBox } from '@splunk/react-icons/SVGEnterprise';
 export default function FileIconCloud(props: SVGPropsOptionalViewBox): JSX.Element;

package/types/src/File/PaperClip.d.ts

@@ -1,2 +1,2 @@
-import { SVGPropsOptionalViewBox } from '@splunk/react-icons/SVG';
+import { SVGPropsOptionalViewBox } from '@splunk/react-icons/SVGEnterprise';
 export default function PaperClip(props: SVGPropsOptionalViewBox): JSX.Element;

package/types/src/File/Retry.d.ts

@@ -1,2 +1,2 @@
-import { SVGPropsOptionalViewBox } from '@splunk/react-icons/SVG';
+import { SVGPropsOptionalViewBox } from '@splunk/react-icons/SVGEnterprise';
 export default function Retry(props: SVGPropsOptionalViewBox): JSX.Element;

package/types/src/File/Trash.d.ts

@@ -1,2 +1,2 @@
-import { SVGPropsOptionalViewBox } from '@splunk/react-icons/SVG';
+import { SVGPropsOptionalViewBox } from '@splunk/react-icons/SVGEnterprise';
 export default function Trash(props: SVGPropsOptionalViewBox): JSX.Element;

package/types/src/File/docs/examples/Progress.d.ts

@@ -1,15 +1 @@
-import { Component } from 'react';
-import { FileRequestAddHandler } from '@splunk/react-ui/File';
-declare class Progress extends Component<{}, {
-    filename?: string;
-    uploadPercentage?: number;
-}> {
-    private fileReader;
-    private timer?;
-    constructor(props: {});
-    handleAddFiles: FileRequestAddHandler;
-    handleRemoveFile: () => void;
-    fakeUpload: () => void;
-    render(): JSX.Element;
-}
-export default Progress;
+export default function Progress(): JSX.Element;

package/types/src/FormRows/icons/FormRowsPlusIcon.d.ts

@@ -0,0 +1,2 @@
+declare const FormRowsPlusIcon: () => JSX.Element;
+export default FormRowsPlusIcon;

package/types/src/Heading/Heading.d.ts

@@ -1,5 +1,6 @@
 import React from 'react';
 import PropTypes from 'prop-types';
+import { TypographyTitleVariant } from '@splunk/themes/mixins';
 import { ComponentProps } from '../utils/types';
 interface HeadingPropsBase {
     children?: React.ReactNode;
@@ -8,10 +9,15 @@ interface HeadingPropsBase {
      */
     elementRef?: React.Ref<HTMLHeadingElement>;
     /**
-     * Corresponds to the respective `<hX>` HTML tags. Use `s` for section-style headings
-     * and `ss` for small section-style headings.
+     * Corresponds to the respective `<hX>` HTML tags and `typography(titleX)` `@splunk/themes` typography variant. Use `s` for section-style headings
+     * and `ss` for small section-style headings. Styles will be set corresponding to level if variant is not provided: e.g. `level=3` will default to using `title3` from `mixins`.
      */
-    level?: 1 | 2 | 3 | 4 | 's' | 'ss';
+    level?: 1 | 2 | 3 | 4 | 's' | 'ss' | 5 | 6;
+    /**
+     * Styles the component based on typography mixin title preset styles.
+     * If a variant is not provided, styles will be set corresponding to level: e.g. `level=3` will default to using `title3` from `mixins`.
+     */
+    variant?: TypographyTitleVariant;
 }
 declare type HeadingProps = ComponentProps<HeadingPropsBase, 'h1'>;
 declare const levelToElement: {
@@ -21,8 +27,10 @@ declare const levelToElement: {
     readonly '4': "h4";
     readonly s: "h4";
     readonly ss: "h5";
+    readonly '5': "h5";
+    readonly '6': "h6";
 };
-declare function Heading({ level, children, elementRef, ...otherProps }: HeadingProps): JSX.Element;
+declare function Heading({ level, children, variant, ...otherProps }: HeadingProps): JSX.Element;
 declare namespace Heading {
     var propTypes: {
         children: PropTypes.Requireable<PropTypes.ReactNodeLike>;

package/types/src/Heading/docs/examples/Variant.d.ts

@@ -0,0 +1,2 @@
+declare function Variant(): JSX.Element;
+export default Variant;

package/types/src/Image/Image.d.ts

@@ -25,7 +25,7 @@ interface ImagePropsBase {
      * null when it unmounts. */
     elementRef?: React.Ref<HTMLDivElement>;
     /** Show the component in an error state. */
-    error: boolean;
+    error?: boolean;
     /** The max-height of the preview in pixels. */
     maxHeight?: number;
     /** A callback for when the image changes. The function is passed an

package/types/src/Image/icons/Cross.d.ts

@@ -0,0 +1,2 @@
+declare const CrossIcon: () => JSX.Element;
+export default CrossIcon;

package/types/src/Link/icons/External.d.ts

@@ -0,0 +1,2 @@
+declare function External(): JSX.Element;
+export default External;

package/types/src/Menu/Divider.d.ts

@@ -9,5 +9,6 @@ declare namespace Divider {
     var filterFirst: boolean;
     var filterConsecutive: boolean;
     var filterLast: boolean;
+    var as: string;
 }
 export default Divider;

package/types/src/Menu/Heading.d.ts

@@ -23,5 +23,6 @@ declare namespace Heading {
     };
     var filterConsecutive: boolean;
     var filterLast: boolean;
+    var as: string;
 }
 export default Heading;