@splunk/react-ui 4.6.0 → 4.9.0

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

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { ComponentProps } from '../utils/types';
 declare type DividerProps = ComponentProps<{}, 'div'>;
 /**

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -21,6 +21,8 @@ declare type LinkLinkProps = ComponentProps<LinkPropsBase, 'a', 'href'>;
 declare type LinkButtonProps = ComponentProps<LinkPropsBase, 'button'>;
 declare type LinkProps = LinkLinkProps | LinkButtonProps;
 /**
+ * @deprecated `Message.Link` is deprecated and will be removed in a future major version. Use `Link` instead.
+ *
  * A `Link` styled to work with `Message`'s `banner` appearance.
  */
 declare function Link({ children, ...otherProps }: LinkProps): JSX.Element;

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

@@ -4,7 +4,12 @@ import Link from './Link';
 import { ComponentProps } from '../utils/types';
 interface MessagePropsBase {
     /**
+     *
      * Changes the style of the Message.
+     *
+     * @deprecatedValue 'banner'
+     * The `banner` value is deprecated and will be removed in a future major version. Use `MessageBar` instead.
+     *
      */
     appearance?: 'default' | 'fill' | 'banner';
     children?: React.ReactNode;
@@ -18,7 +23,7 @@ interface MessagePropsBase {
      */
     onRequestRemove?: React.MouseEventHandler<HTMLButtonElement>;
     /** Sets the severity or type of this `Message`. */
-    type?: 'info' | 'success' | 'warning' | 'error';
+    type?: 'info' | 'warning' | 'error' | 'success';
 }
 declare type MessageProps = ComponentProps<MessagePropsBase, 'div'>;
 declare function Message({ appearance, children, type, onRequestRemove, ...otherProps }: MessageProps): JSX.Element;

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

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

package/types/src/Message/docs/examples/Content.d.ts

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

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

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

package/types/src/Message/docs/examples/Removable.d.ts

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

package/types/src/Message/docs/examples/prisma/Title.d.ts

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

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

@@ -0,0 +1,28 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { ComponentProps } from '../utils/types';
+interface MessageBarPropsBase {
+    /**
+     * Text is required and should be concise.
+     */
+    children: React.ReactNode;
+    /**
+     * Includes a close button. Always consider including a close button.
+     */
+    onRequestClose?: React.MouseEventHandler<HTMLButtonElement>;
+    /**
+     * Sets the severity of this `MessageBar`.
+     * */
+    type: 'info' | 'warning' | 'error' | 'success';
+}
+declare type MessageBarProps = ComponentProps<MessageBarPropsBase, 'div'>;
+declare function MessageBar({ children, type, onRequestClose, ...otherProps }: MessageBarProps): JSX.Element;
+declare namespace MessageBar {
+    var propTypes: {
+        children: PropTypes.Validator<string | number | boolean | {} | PropTypes.ReactElementLike | PropTypes.ReactNodeArray>;
+        onRequestClose: PropTypes.Requireable<(...args: any[]) => any>;
+        type: PropTypes.Validator<string>;
+    };
+}
+export default MessageBar;
+export type { MessageBarPropsBase };

package/types/src/MessageBar/docs/examples/Types.d.ts

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

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

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

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

@@ -51,6 +51,7 @@ declare class Modal extends Component<ModalProps> {
     static Body: typeof Body;
     static Footer: typeof Footer;
     constructor(props: Readonly<ModalProps>);
+    componentDidMount(): void;
     componentDidUpdate(prevProps: ModalProps): void;
     private getDefaultMotionStyle;
     private getMotionStyle;

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

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

package/types/src/Modal/docs/examples/InitialFocus.d.ts

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

package/types/src/Modal/docs/examples/TypicalUsage.d.ts

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

package/types/src/Modal/docs/examples/Undismissable.d.ts

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

package/types/src/Modal/docs/examples/prisma/TypicalUsage.d.ts

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

package/types/src/Monogram/Monogram.d.ts

@@ -24,9 +24,9 @@ interface MonogramPropsBase {
     /** Enables interactive mode. */
     onClick?: MonogramClickHandler;
     /**
-     * Adjusts the size of the `Monogram`.
+     *  @deprecated The `xlarge` option has been marked for deprecation and will be removed in a future major version.
      *
-     * @deprecated The `xlarge` option has been marked for deprecation and will be removed in a future major version.
+     * Adjusts the size of the `Monogram`.
      */
     size?: 'small' | 'medium' | 'large' | 'xlarge';
 }

package/types/src/Monogram/docs/examples/BackgroundAuto.d.ts

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

package/types/src/Monogram/docs/examples/BackgroundCustom.d.ts

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

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

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

package/types/src/Monogram/docs/examples/Interactive.d.ts

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

package/types/src/Monogram/docs/examples/Size.d.ts

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

package/types/src/Multiselect/docs/examples/Children.d.ts

@@ -0,0 +1,10 @@
+import { Component } from 'react';
+import { MultiselectChangeHandler } from '@splunk/react-ui/Multiselect';
+declare class Children extends Component<{}, {
+    values: (string | number | boolean)[];
+}> {
+    constructor(props: {});
+    handleChange: MultiselectChangeHandler;
+    render(): JSX.Element;
+}
+export default Children;

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

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

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

@@ -0,0 +1,10 @@
+import { Component } from 'react';
+import { MultiselectChangeHandler } from '@splunk/react-ui/Multiselect';
+declare class Controlled extends Component<{}, {
+    values: (string | number | boolean)[];
+}> {
+    constructor(props: {});
+    handleChange: MultiselectChangeHandler;
+    render(): JSX.Element;
+}
+export default Controlled;

package/types/src/Multiselect/docs/examples/CustomizeSelected.d.ts

@@ -0,0 +1,10 @@
+import { Component } from 'react';
+import { MultiselectChangeHandler } from '@splunk/react-ui/Multiselect';
+declare class CustomizeSelected extends Component<{}, {
+    values: (string | number | boolean)[];
+}> {
+    constructor(props: {});
+    handleChange: MultiselectChangeHandler;
+    render(): JSX.Element;
+}
+export default CustomizeSelected;

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

@@ -0,0 +1,10 @@
+import { Component } from 'react';
+import { MultiselectChangeHandler } from '@splunk/react-ui/Multiselect';
+declare class Disabled extends Component<{}, {
+    values: (string | number | boolean)[];
+}> {
+    constructor(props: {});
+    handleChange: MultiselectChangeHandler;
+    render(): JSX.Element;
+}
+export default Disabled;

package/types/src/Multiselect/docs/examples/Error.d.ts

@@ -0,0 +1,10 @@
+import { Component } from 'react';
+import { MultiselectChangeHandler } from '@splunk/react-ui/Multiselect';
+declare class MultiselectError extends Component<{}, {
+    values: (string | number | boolean)[];
+}> {
+    constructor(props: {});
+    handleChange: MultiselectChangeHandler;
+    render(): JSX.Element;
+}
+export default MultiselectError;

package/types/src/Multiselect/docs/examples/Fetching.d.ts

@@ -0,0 +1,23 @@
+import { Component } from 'react';
+import { MultiselectChangeHandler, MultiselectFilterChangeHandler } from '@splunk/react-ui/Multiselect';
+import { Movie, MovieOption } from '@splunk/react-ui/fixtures/FetchOptions';
+interface ExampleState {
+    fullCount: number;
+    isLoading: boolean;
+    options: MovieOption[];
+    values: (string | number | boolean)[];
+}
+declare class Fetching extends Component<{}, ExampleState> {
+    private fetchOptions;
+    constructor(props: {});
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    handleChange: MultiselectChangeHandler;
+    handleFetch: (keyword?: string | undefined) => void;
+    handleFilterChange: MultiselectFilterChangeHandler;
+    createOption: (movie: Movie | MovieOption, isSelected?: boolean) => JSX.Element;
+    generateOptions: () => JSX.Element[];
+    footerMessage: () => string | null;
+    render(): JSX.Element;
+}
+export default Fetching;

package/types/src/Multiselect/docs/examples/Headings.d.ts

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

package/types/src/Multiselect/docs/examples/Icons.d.ts

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

package/types/src/Multiselect/docs/examples/LoadMoreOnScrollBottom.d.ts

@@ -0,0 +1,26 @@
+import { Component } from 'react';
+import { MultiselectChangeHandler, MultiselectFilterChangeHandler } from '@splunk/react-ui/Multiselect';
+import { Movie, MovieOption } from '@splunk/react-ui/fixtures/FetchOptions';
+interface ExampleState {
+    fullCount: number;
+    isLoading: boolean;
+    isLoadingMore: boolean;
+    options: MovieOption[];
+    values: (string | number | boolean)[];
+}
+declare class LoadMoreOnScrollBottom extends Component<{}, ExampleState> {
+    private fetchOptions;
+    constructor(props: {});
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    handleChange: MultiselectChangeHandler;
+    handleFetch: (keyword?: string | undefined) => void;
+    handleFetchMore: (currentOptions: MovieOption[]) => void;
+    handleFilterChange: MultiselectFilterChangeHandler;
+    handleScrollBottom: () => void;
+    createOption: (movie: Movie | MovieOption, isSelected?: boolean) => JSX.Element;
+    generateOptions: () => JSX.Element[];
+    footerMessage: () => string;
+    render(): JSX.Element;
+}
+export default LoadMoreOnScrollBottom;

package/types/src/Multiselect/docs/examples/NewValues.d.ts

@@ -0,0 +1,10 @@
+import { Component } from 'react';
+import { MultiselectChangeHandler } from '@splunk/react-ui/Multiselect';
+declare class NewValues extends Component<{}, {
+    values: (string | number | boolean)[];
+}> {
+    constructor(props: {});
+    handleChange: MultiselectChangeHandler;
+    render(): JSX.Element;
+}
+export default NewValues;

package/types/src/Multiselect/docs/examples/TabInput.d.ts

@@ -0,0 +1,10 @@
+import { Component } from 'react';
+import { MultiselectChangeHandler } from '@splunk/react-ui/Multiselect';
+declare class TabInput extends Component<{}, {
+    values: (string | number | boolean)[];
+}> {
+    constructor(props: {});
+    handleChange: MultiselectChangeHandler;
+    render(): JSX.Element;
+}
+export default TabInput;

package/types/src/Multiselect/docs/examples/Uncontrolled.d.ts

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

package/types/src/Number/IncrementIcon.d.ts

@@ -1,3 +1,2 @@
-/// <reference types="react" />
 import { SVGPropsOptionalViewBox } from '@splunk/react-icons/SVG';
 export default function SortedUp(props: SVGPropsOptionalViewBox): JSX.Element;