@splunk/react-ui 5.0.0-beta.3 → 5.0.0-beta.5

package/types/src/ControlGroup/docs/examples/CustomizedLabelTarget.d.ts

@@ -1,9 +1,9 @@
 import React, { Component } from 'react';
 import { SwitchClickHandler } from '@splunk/react-ui/Switch';
-declare class CustomizedLabelTarget extends Component<{}, {
+declare class CustomizedLabelTarget extends Component<object, {
     values: number[];
 }> {
-    constructor(props: {});
+    constructor(props: object);
     handleClick: SwitchClickHandler;
     render(): React.JSX.Element;
 }

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

@@ -1,9 +1,9 @@
 import React, { Component } from 'react';
 import { DateChangeHandler } from '@splunk/react-ui/Date';
-declare class Controlled extends Component<{}, {
+declare class Controlled extends Component<object, {
     value: string;
 }> {
-    constructor(props: {});
+    constructor(props: object);
     handleChange: DateChangeHandler;
     render(): React.JSX.Element;
 }

package/types/src/Date/docs/examples/HighlightToday.d.ts

@@ -1,9 +1,9 @@
 import React, { Component } from 'react';
 import { DateChangeHandler } from '@splunk/react-ui/Date';
-declare class HighlightToday extends Component<{}, {
+declare class HighlightToday extends Component<object, {
     value: string;
 }> {
-    constructor(props: {});
+    constructor(props: object);
     handleChange: DateChangeHandler;
     render(): React.JSX.Element;
 }

package/types/src/DefinitionList/DefinitionListContext.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 interface DefinitionListContextValue {
     separatorCharacter?: '.' | string;
     termWidth?: string;

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

@@ -53,6 +53,10 @@ interface DualListboxPropsBase {
      * When true, `Options`'s `listName` and `selected` state props are fully controlled.
      */
     controlled?: boolean;
+    /**
+     * A React ref which is set to the DOM element when the component mounts, and null when it unmounts.
+     */
+    elementRef?: React.Ref<HTMLDivElement>;
     /**
      * When true, fill height and width of the relative parent container.
      */
@@ -78,7 +82,7 @@ interface DualListboxPropsBase {
     onSelect?: DualListboxSelectHandler;
 }
 type DualListboxProps = ComponentProps<DualListboxPropsBase, 'div'>;
-declare function DualListbox({ children, controlled, fill, inline, onChange, onSelect, lists, ...otherProps }: DualListboxProps): React.JSX.Element;
+declare function DualListbox({ children, controlled, elementRef, fill, inline, onChange, onSelect, lists, ...otherProps }: DualListboxProps): React.JSX.Element;
 declare namespace DualListbox {
     var propTypes: React.WeakValidationMap<DualListboxPropsBase>;
     var Option: typeof import("./Option").default;

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

@@ -9,22 +9,22 @@ type FileRequestAddHandler = (files: globalThis.File[], data: {
 /** @public */
 type FileRequestRemoveHandler = (data: {
     event: {
-        itemId?: any;
+        itemId?: string;
         name: string;
     };
     filename: string;
     index: number;
-    itemId?: any;
+    itemId?: string;
     name?: string;
 }) => void;
 type FileRequestRetryHandler = (data: {
     event: {
-        itemId?: any;
+        itemId?: string;
         name: string;
     };
     filename: string;
     index: number;
-    itemId?: any;
+    itemId?: string;
     name?: string;
 }) => void;
 interface FilePropsBase {

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

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { ItemClickHandler } from './Item';
 export interface FileContext {
     disabled: boolean;

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

@@ -2,7 +2,7 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import { ComponentProps } from '../utils/types';
 type ItemClickHandler = (data: {
-    itemId?: any;
+    itemId?: string;
     name: string;
     index: number;
 }) => void;
@@ -14,8 +14,14 @@ interface ItemPropsBase {
     elementRef?: React.Ref<HTMLDivElement>;
     /** Show the Item in an error state. */
     error?: boolean;
+    /**
+     * The icon or thumbnail image to show before the label.
+     * If not passed this will be generated from the filename extension.
+     * @private
+     */
+    icon?: React.ReactNode;
     /** A unique for this file. */
-    itemId?: any;
+    itemId?: string;
     /** The name is displayed on the item. */
     name: string;
     /** @private */
@@ -25,13 +31,15 @@ interface ItemPropsBase {
     uploadPercentage?: number;
 }
 type ItemProps = ComponentProps<ItemPropsBase, 'div'>;
-declare function Item({ disabled, elementRef, error, itemId, name, index, uploadPercentage, ...otherProps }: ItemProps): React.JSX.Element;
+declare function Item({ disabled, elementRef, error, icon, itemId, name, index, uploadPercentage, ...otherProps }: ItemProps): React.JSX.Element;
 declare namespace Item {
     var propTypes: {
         disabled: PropTypes.Requireable<boolean>;
         elementRef: PropTypes.Requireable<object>;
         error: PropTypes.Requireable<boolean>;
         /** @private */
+        icon: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        /** @private */
         index: PropTypes.Requireable<number>;
         itemId: PropTypes.Requireable<any>;
         name: PropTypes.Validator<string>;

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

@@ -1,6 +1,7 @@
 import React from 'react';
 interface ItemIconProps {
     name: string;
+    icon?: React.ReactNode;
 }
-declare const ItemIcon: ({ name }: ItemIconProps) => React.JSX.Element;
+declare const ItemIcon: ({ name, icon }: ItemIconProps) => React.JSX.Element;
 export default ItemIcon;

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

@@ -1,10 +1,10 @@
 import React, { Component } from 'react';
 import { FileRequestAddHandler } from '@splunk/react-ui/File';
-declare class Disabled extends Component<{}, {
+declare class Disabled extends Component<object, {
     filename?: string;
 }> {
     private fileReader;
-    constructor(props: {});
+    constructor(props: object);
     handleAddFiles: FileRequestAddHandler;
     handleRemoveFile: () => void;
     render(): React.JSX.Element;

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

@@ -1,11 +1,11 @@
 import React, { Component } from 'react';
 import { FileRequestAddHandler } from '@splunk/react-ui/File';
-declare class DropAnywhere extends Component<{}, {
+declare class DropAnywhere extends Component<object, {
     filename?: string;
     open: boolean;
 }> {
     private fileReader;
-    constructor(props: {});
+    constructor(props: object);
     handleAddFiles: FileRequestAddHandler;
     handleRemoveFile: () => void;
     handleOpen: () => void;

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

@@ -4,11 +4,11 @@ interface FileItem {
     name: string;
     value?: string | ArrayBuffer | null;
 }
-declare class Multi extends Component<{}, {
+declare class Multi extends Component<object, {
     files: FileItem[];
 }> {
     static loadFile(file: globalThis.File): FileItem;
-    constructor(props: {});
+    constructor(props: object);
     handleAddFiles: FileRequestAddHandler;
     handleRemoveFile: FileRequestRemoveHandler;
     render(): React.JSX.Element;

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

@@ -1,10 +1,10 @@
 import React, { Component } from 'react';
 import { FileRequestAddHandler } from '@splunk/react-ui/File';
-declare class Single extends Component<{}, {
+declare class Single extends Component<object, {
     filename?: string;
 }> {
     private fileReader;
-    constructor(props: {});
+    constructor(props: object);
     handleAddFiles: FileRequestAddHandler;
     handleRemoveFile: () => void;
     render(): React.JSX.Element;

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

@@ -29,7 +29,7 @@ interface FormRowsPropsBase {
     onRequestMove?: FormRowsRequestMoveHandler;
 }
 type FormRowsProps = ComponentProps<FormRowsPropsBase, 'div'>;
-declare function FormRows({ addLabel, children, disabled, header, menu, onRequestAdd, onRequestMove, ...otherProps }: FormRowsProps): React.JSX.Element;
+declare function FormRows({ addLabel, children, disabled, elementRef, header, menu, onRequestAdd, onRequestMove, ...otherProps }: FormRowsProps): React.JSX.Element;
 declare namespace FormRows {
     var propTypes: {
         addLabel: PropTypes.Requireable<string>;
@@ -42,9 +42,9 @@ declare namespace FormRows {
         onRequestMove: PropTypes.Requireable<(...args: any[]) => any>;
     };
     var Row: typeof import("./Row").default;
-    var addRow: (element: React.ReactElement<any, string | React.JSXElementConstructor<any>>, items: React.ReactElement<any, string | React.JSXElementConstructor<any>>[]) => React.ReactElement<any, string | React.JSXElementConstructor<any>>[];
-    var moveRow: (fromIndex: number, toIndex: number, items: React.ReactElement<any, string | React.JSXElementConstructor<any>>[]) => React.ReactElement<any, string | React.JSXElementConstructor<any>>[];
-    var removeRow: (index: number, items: React.ReactElement<any, string | React.JSXElementConstructor<any>>[]) => React.ReactElement<any, string | React.JSXElementConstructor<any>>[];
+    var addRow: (element: React.ReactElement, items: React.ReactElement[]) => React.ReactElement<any, string | React.JSXElementConstructor<any>>[];
+    var moveRow: (fromIndex: number, toIndex: number, items: React.ReactElement[]) => React.ReactElement<any, string | React.JSXElementConstructor<any>>[];
+    var removeRow: (index: number, items: React.ReactElement[]) => React.ReactElement<any, string | React.JSXElementConstructor<any>>[];
 }
 export default FormRows;
 export { Row };

package/types/src/FormRows/FormRowsContext.d.ts

@@ -1,7 +1,6 @@
-/// <reference types="react" />
 import { RowKeyDownHandler } from './Row';
 export interface FormRowsContext {
-    disabledDeleteButton: boolean | undefined;
+    disabledRemoveButton: boolean | undefined;
     onKeyDown?: RowKeyDownHandler;
     hasOnRequestAdd?: boolean;
     sortable: boolean;

package/types/src/FormRows/SortableRow.d.ts

@@ -8,7 +8,7 @@ type RowRequestRemoveHandler = (event: React.MouseEvent<HTMLButtonElement>, data
 }) => void;
 interface RowPropsBase {
     children?: React.ReactNode;
-    /** Index of the row. */
+    /** Index of the row. This is required if the rows are sortable. */
     index?: number;
     /** Callback when Remove button is clicked. */
     onRequestRemove?: RowRequestRemoveHandler;

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

@@ -1,9 +1,9 @@
 import React, { Component } from 'react';
 import { FormRowsRequestMoveHandler, RowRequestRemoveHandler } from '@splunk/react-ui/FormRows';
-declare class Basic extends Component<{}, {
+declare class Basic extends Component<object, {
     items: React.ReactElement[];
 }> {
-    constructor(props: {});
+    constructor(props: object);
     handleRequestAdd: () => void;
     handleRequestMove: FormRowsRequestMoveHandler;
     handleRequestRemove: RowRequestRemoveHandler;

package/types/src/FormRows/docs/examples/Header.d.ts

@@ -1,9 +1,9 @@
 import React, { Component } from 'react';
 import { FormRowsRequestMoveHandler, RowRequestRemoveHandler } from '@splunk/react-ui/FormRows';
-declare class Header extends Component<{}, {
+declare class Header extends Component<object, {
     items: React.ReactElement[];
 }> {
-    constructor(props: {});
+    constructor(props: object);
     handleRequestAdd: () => void;
     handleRequestMove: FormRowsRequestMoveHandler;
     handleRequestRemove: RowRequestRemoveHandler;

package/types/src/FormRows/docs/examples/Menu.d.ts

@@ -1,10 +1,10 @@
 import React, { Component } from 'react';
 import { FormRowsRequestMoveHandler, RowRequestRemoveHandler } from '@splunk/react-ui/FormRows';
 import { SelectChangeHandler } from '@splunk/react-ui/Select';
-declare class Menu extends Component<{}, {
+declare class Menu extends Component<object, {
     items: React.ReactElement[];
 }> {
-    constructor(props: {});
+    constructor(props: object);
     handleRequestAdd: SelectChangeHandler;
     handleRequestMove: FormRowsRequestMoveHandler;
     handleRequestRemove: RowRequestRemoveHandler;

package/types/src/FormRows/docs/examples/ReorderOnly.d.ts

@@ -1,9 +1,9 @@
 import React, { Component } from 'react';
 import { FormRowsRequestMoveHandler } from '@splunk/react-ui/FormRows';
-declare class ReorderOnly extends Component<{}, {
+declare class ReorderOnly extends Component<object, {
     items: React.ReactElement[];
 }> {
-    constructor(props: {});
+    constructor(props: object);
     handleRequestMove: FormRowsRequestMoveHandler;
     render(): React.JSX.Element;
 }

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

@@ -26,8 +26,6 @@ interface ImagePropsBase {
     elementRef?: React.Ref<HTMLDivElement>;
     /** Show the component in an error state. */
     error?: boolean;
-    /** The max-height of the preview in pixels. */
-    maxHeight?: number;
     /** A callback for when the image changes. The function is passed an
      * object containing two keys: `filename` and `imageDataURI`. Both are
      * `null` if the image was removed. */
@@ -38,7 +36,7 @@ declare const isAllowedFilename: (filename: string, allowExtensions: string[]) =
 /**
  * Image provides the ability to accept image files and present a preview of the image.
  */
-declare function Image({ allowExtensions, defaultFilename: defaultFilenameProp, defaultImageDataURI, disabled, error, maxHeight, onImageChange, ...otherProps }: ImageProps): React.JSX.Element;
+declare function Image({ allowExtensions, defaultFilename: defaultFilenameProp, defaultImageDataURI, disabled, error, onImageChange, ...otherProps }: ImageProps): React.JSX.Element;
 declare namespace Image {
     var propTypes: {
         allowExtensions: PropTypes.Requireable<(string | null | undefined)[]>;
@@ -48,7 +46,6 @@ declare namespace Image {
         dropAnywhere: PropTypes.Requireable<boolean>;
         elementRef: PropTypes.Requireable<object>;
         error: PropTypes.Requireable<boolean>;
-        maxHeight: PropTypes.Requireable<number>;
         onImageChange: PropTypes.Requireable<(...args: any[]) => any>;
     };
 }

package/types/src/JSONTree/docs/examples/Events.d.ts

@@ -1,11 +1,11 @@
 import React, { Component } from 'react';
 import { JSONTreeClickValueHandler, JSONTreeClickKeyHandler } from '@splunk/react-ui/JSONTree';
-declare class Events extends Component<{}, {
+declare class Events extends Component<object, {
     key: string;
     keyPath?: (string | number)[];
     value: string;
 }> {
-    constructor(props: {});
+    constructor(props: object);
     onClickJSONValue: JSONTreeClickValueHandler;
     onClickJSONKey: JSONTreeClickKeyHandler;
     render(): React.JSX.Element;

package/types/src/Layout/Layout.d.ts

@@ -20,3 +20,4 @@ export declare namespace Layout {
     };
 }
 export default Layout;
+export type { LayoutProps, LayoutPropsBase };

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

@@ -31,6 +31,10 @@ interface LinkPropsBase {
      * The URL or path to link to.
      */
     to?: string;
+    /**
+     * @private
+     */
+    tag?: 'a' | 'button';
 }
 type LinkLinkProps = ComponentProps<LinkPropsBase, 'a', 'href'>;
 type LinkButtonProps = ComponentProps<LinkPropsBase, 'button'>;

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

@@ -1,3 +1,2 @@
-/// <reference types="react" />
-declare const External: import("styled-components").StyledComponent<({ children, variant, ...otherprops }: import("@splunk/react-icons/ArrowSquareTopRightInset").IconBaseProps) => import("react").JSX.Element | null, any, {}, never>;
+declare const External: import("styled-components").StyledComponent<({ children, variant, ...otherprops }: import("@splunk/react-icons/ArrowSquareTopRightInset").IconBaseProps) => React.JSX.Element | null, any, import("@splunk/themes").OptionalThemedProps<import("@splunk/themes").AnyTheme>, never>;
 export default External;

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

@@ -1,6 +1,6 @@
 import React from 'react';
 import { ComponentProps } from '../utils/types';
-type DividerProps = ComponentProps<{}, 'div'>;
+type DividerProps = ComponentProps<object, 'div'>;
 /**
  * A non-interactive menu item used to visually separate groups of items in the menu.
  */

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

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 export interface MenuContextValue {
     role?: string;
     preventFocus?: boolean;

package/types/src/Message/Message.d.ts

@@ -21,7 +21,7 @@ interface MessagePropsBase {
     type?: 'info' | 'warning' | 'error' | 'success';
 }
 type MessageProps = ComponentProps<MessagePropsBase, 'div'>;
-declare function Message({ appearance, children, type, onRequestRemove, ...otherProps }: MessageProps): React.JSX.Element;
+declare function Message({ appearance, children, elementRef, onRequestRemove, type, ...otherProps }: MessageProps): React.JSX.Element;
 declare namespace Message {
     var propTypes: {
         appearance: PropTypes.Requireable<string>;

package/types/src/MessageBar/MessageBar.d.ts

@@ -6,17 +6,21 @@ interface MessageBarPropsBase {
      * Text is required and should be concise.
      */
     children: React.ReactNode;
+    /**
+     * A React ref which is set to the DOM element when the component mounts and null when it unmounts.
+     */
+    elementRef?: React.Ref<HTMLDivElement>;
     /**
      * Includes a close button. Always consider including a close button.
      */
-    onRequestClose?: React.MouseEventHandler<HTMLButtonElement>;
+    onRequestClose?: React.MouseEventHandler<HTMLButtonElement | HTMLAnchorElement>;
     /**
      * Sets the severity of this `MessageBar`.
      * */
     type: 'info' | 'warning' | 'error' | 'success';
 }
 type MessageBarProps = ComponentProps<MessageBarPropsBase, 'div'>;
-declare function MessageBar({ children, type, onRequestClose, ...otherProps }: MessageBarProps): React.JSX.Element;
+declare function MessageBar({ children, elementRef, onRequestClose, type, ...otherProps }: MessageBarProps): React.JSX.Element;
 declare namespace MessageBar {
     var propTypes: {
         children: PropTypes.Validator<NonNullable<PropTypes.ReactNodeLike>>;

package/types/src/Modal/ModalContext.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { ModalRequestCloseHandler } from './Modal';
 export interface ModalContext {
     divider?: 'header' | 'footer' | 'both' | 'none';

package/types/src/Multiselect/Compact.d.ts

@@ -1,9 +1,8 @@
-import React, { Component } from 'react';
-import { Divider, Heading } from '@splunk/react-ui/Menu';
+import React from 'react';
+import PropTypes from 'prop-types';
 import { MultiselectChangeHandler, MultiselectFilterChangeHandler, MultiselectScrollBottomHandler } from './Multiselect';
-import Option from './Option';
 import { SelectBaseProps } from '../Select/SelectBase';
-import { ClassComponentProps } from '../utils/types';
+import { ComponentProps } from '../utils/types';
 interface CompactPropsBase {
     animateLoading?: boolean;
     /**
@@ -151,23 +150,49 @@ interface CompactPropsBase {
     /** @private */
     toggle?: SelectBaseProps['toggle'];
 }
-declare const defaultProps: Required<Pick<CompactPropsBase, 'allowNewValues' | 'animateLoading' | 'defaultPlacement' | 'disabled' | 'inline' | 'isLoadingOptions' | 'menuStyle' | 'noOptionsMessage' | 'placeholder' | 'showSelectedValuesFirst' | 'tabConfirmsNewValue'>>;
-type CompactProps = ClassComponentProps<CompactPropsBase, typeof defaultProps, 'button'>;
-interface CompactState {
-    activeIndex: number;
-    filterKeyword: string;
-    open: boolean;
-    textHasFocus: boolean;
-    topValues: (string | number | boolean)[];
-    values: (string | number | boolean)[];
-}
-declare class Compact extends Component<CompactProps, CompactState> {
-    static propTypes: React.WeakValidationMap<CompactProps>;
-    static defaultProps: Required<Pick<CompactPropsBase, "placeholder" | "disabled" | "inline" | "defaultPlacement" | "animateLoading" | "noOptionsMessage" | "menuStyle" | "allowNewValues" | "isLoadingOptions" | "showSelectedValuesFirst" | "tabConfirmsNewValue">>;
-    static Option: typeof Option;
-    static Divider: typeof Divider;
-    static Heading: typeof Heading;
-    render(): React.JSX.Element;
+type CompactProps = ComponentProps<CompactPropsBase, 'button'>;
+declare function Compact({ allowNewValues, animateLoading, children, controlledFilter, defaultPlacement, defaultValues, describedBy, disabled, elementRef, error, filter, footerMessage, inline, inputId, inputRef, isLoadingOptions, labelledBy, loadingMessage, menuStyle, name, noOptionsMessage, onChange, onClose, onFilterChange, onOpen, onScroll, onScrollBottom, placeholder, repositionMode, selectAllAppearance, showSelectedValuesFirst, tabConfirmsNewValue, values, virtualization, ...otherProps }: CompactProps): React.JSX.Element;
+declare namespace Compact {
+    var propTypes: {
+        allowNewValues: PropTypes.Requireable<boolean>;
+        animateLoading: PropTypes.Requireable<boolean>;
+        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        controlledFilter: PropTypes.Requireable<boolean>;
+        defaultPlacement: PropTypes.Requireable<string>;
+        defaultValues: PropTypes.Requireable<any[]>;
+        describedBy: PropTypes.Requireable<string>;
+        disabled: PropTypes.Requireable<boolean>;
+        elementRef: PropTypes.Requireable<object>;
+        error: PropTypes.Requireable<boolean>;
+        filter: PropTypes.Requireable<string | boolean>;
+        footerMessage: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        inline: PropTypes.Requireable<boolean>;
+        inputId: PropTypes.Requireable<string>;
+        inputRef: PropTypes.Requireable<object>;
+        isLoadingOptions: PropTypes.Requireable<boolean>;
+        labelledBy: PropTypes.Requireable<string>;
+        loadingMessage: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        menuStyle: PropTypes.Requireable<object>;
+        name: PropTypes.Requireable<string>;
+        noOptionsMessage: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        onChange: PropTypes.Requireable<(...args: any[]) => any>;
+        onClose: PropTypes.Requireable<(...args: any[]) => any>;
+        onFilterChange: PropTypes.Requireable<(...args: any[]) => any>;
+        onOpen: PropTypes.Requireable<(...args: any[]) => any>;
+        onScroll: PropTypes.Requireable<(...args: any[]) => any>;
+        onScrollBottom: PropTypes.Requireable<(...args: any[]) => any>;
+        placeholder: PropTypes.Requireable<string>;
+        repositionMode: PropTypes.Requireable<string>;
+        selectAllAppearance: PropTypes.Requireable<string>;
+        showSelectedValuesFirst: PropTypes.Requireable<string>;
+        tabConfirmsNewValue: PropTypes.Requireable<boolean>;
+        values: PropTypes.Requireable<any[]>;
+        /** @private */
+        virtualization: PropTypes.Requireable<number>;
+    };
+    var Option: typeof import("./Option").default;
+    var Divider: typeof import("@splunk/react-ui/Menu").Divider;
+    var Heading: typeof import("@splunk/react-ui/Menu").Heading;
 }
 export default Compact;
 export { CompactPropsBase };