@splunk/react-ui 4.17.1 → 4.19.0

package/types/src/Color/Palette.d.ts

@@ -0,0 +1,46 @@
+import React from 'react';
+import Clickable from '@splunk/react-ui/Clickable';
+interface PaletteProps {
+    /**
+     * In the prisma theme, controls if the palette is expanded
+     */
+    expanded: boolean;
+    /**
+     * Complete list of palettes values to be rendered as swatches
+     * In enterprise themes this list is always shown.
+     * In prisma themes the entire list is only shown when the palette is `expanded`
+     */
+    palette: (string | null)[];
+    /**
+     * Current value of the Color input
+     */
+    value?: string | null;
+    /**
+     * This ref is passed to the swatch that should be focused for Color to control focus
+     */
+    swatchToFocusRef: React.RefObject<Clickable & HTMLInputElement> | null;
+    /**
+     * Callback for handling when a swatch is selected
+     */
+    onSwatchClick: (event: React.MouseEvent<HTMLButtonElement>, data: {
+        value?: string | null;
+    }) => void;
+    /**
+     * ref for the expandButton so Color can control the state
+     */
+    expandButtonRef: React.RefObject<Clickable> | null;
+    /**
+     * Callback for handling when the expand button is pressed
+     */
+    onPaletteExpand: (event: React.MouseEvent<HTMLAnchorElement | HTMLButtonElement>) => void;
+    /**
+     * Render function for injecting the toolbar and input below the rendered swatches
+     */
+    renderInput?: () => JSX.Element;
+    /**
+     * Callback for handling activation of the system color picker, only used in prisma themes.
+     */
+    onSystemColorPickerChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
+}
+declare function Palette({ expanded, palette, value, swatchToFocusRef, onSwatchClick, expandButtonRef, onPaletteExpand, onSystemColorPickerChange, renderInput, }: PaletteProps): JSX.Element;
+export default Palette;

package/types/src/Concertina/Panel.d.ts

@@ -42,6 +42,7 @@ declare class Panel extends Component<PanelProps, PanelState> {
     private lastHeight?;
     static propTypes: React.WeakValidationMap<ClassComponentProps<PanelPropsBase, Required<Pick<PanelPropsBase, "status">>, "div", never>>;
     static defaultProps: Required<Pick<PanelPropsBase, "status">>;
+    context: React.ContextType<typeof ConcertinaContext>;
     static contextType: React.Context<ConcertinaContext>;
     constructor(props: Readonly<PanelProps>);
     componentDidUpdate(prevProps: Readonly<PanelProps>, prevState: Readonly<PanelState>): void;

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

@@ -1,5 +1,4 @@
 import React, { Component } from 'react';
-import PropTypes from 'prop-types';
 import Row from './Row';
 import type { RowRequestRemoveHandler, RowWithoutSortable } from './Row';
 import { ClassComponentProps } from '../utils/types';
@@ -33,7 +32,7 @@ declare type FormRowsProps = ClassComponentProps<FormRowsPropsBase, typeof defau
 declare class FormRows extends Component<FormRowsProps, {}> {
     static propTypes: React.WeakValidationMap<ClassComponentProps<FormRowsPropsBase, Required<Pick<FormRowsPropsBase, "header" | "disabled" | "addLabel">>, "div", never>>;
     static defaultProps: Required<Pick<FormRowsPropsBase, "header" | "disabled" | "addLabel">>;
-    static Row: React.ComponentClass<Pick<import("./Row").RowPropsBase, "children" | "value" | "elementRef" | "index" | "onRequestRemove" | "rowIndex"> & Pick<PropTypes.InferProps<React.WeakValidationMap<import("./Row").RowPropsBase>>, never> & Pick<import("./Row").RowPropsBase, never>, any>;
+    static Row: typeof Row;
     /**
      * Static function for adding a row.
      *

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

@@ -1,5 +1,4 @@
 import React, { Component } from 'react';
-import PropTypes from 'prop-types';
 import FormRowsContext from './FormRowsContext';
 declare type RowKeyDownHandler = (event: React.KeyboardEvent<HTMLDivElement>, data: {
     index: number;
@@ -14,26 +13,18 @@ interface RowPropsBase {
      * A React ref which is set to the DOM element when the component mounts and null when it unmounts.
      */
     elementRef?: React.Ref<HTMLDivElement>;
-    /** 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;
-    /**
-     * @private
-     * Sortable HOC consumes and removes `index`, so we have `rowIndex` to keep
-     * track of it internally.
-     */
-    rowIndex?: number;
     /** The contents of Row */
     value?: React.ReactNode;
 }
 declare class Row extends Component<RowPropsBase, {}> {
     static propTypes: React.WeakValidationMap<RowPropsBase>;
+    context: React.ContextType<typeof FormRowsContext>;
     static contextType: React.Context<FormRowsContext>;
-    private handleKeyDown;
-    private handleRequestRemove;
     render(): JSX.Element;
 }
-declare const SortableRow: React.ComponentClass<Pick<RowPropsBase, "children" | "value" | "elementRef" | "index" | "onRequestRemove" | "rowIndex"> & Pick<PropTypes.InferProps<React.WeakValidationMap<RowPropsBase>>, never> & Pick<RowPropsBase, never>, any>;
-export default SortableRow;
+export default Row;
 export type { Row as RowWithoutSortable, RowKeyDownHandler, RowPropsBase, RowRequestRemoveHandler };

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

@@ -0,0 +1,19 @@
+import React from 'react';
+/** @public */
+declare type RowRequestRemoveHandler = (event: React.MouseEvent<HTMLButtonElement>, data: {
+    index: number;
+}) => void;
+interface RowInternalPropsBase {
+    children?: React.ReactNode;
+    /** Index of the row. This is required if the rows are sortable. */
+    index?: number;
+    /** Callback when remove button is clicked. */
+    onRequestRemove?: RowRequestRemoveHandler;
+    renderDragHandle?: () => React.ReactNode;
+    style?: React.CSSProperties;
+    /** The contents of Row */
+    value?: React.ReactNode;
+}
+declare const RowInternal: React.ForwardRefExoticComponent<RowInternalPropsBase & React.RefAttributes<HTMLDivElement>>;
+export default RowInternal;
+export type { RowInternalPropsBase, RowRequestRemoveHandler };

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

@@ -1,5 +1,11 @@
 import React from 'react';
-declare const SortableList: React.ComponentClass<{
+declare type SortEndHandler = ({ oldIndex, newIndex }: {
+    oldIndex: number;
+    newIndex: number;
+}) => void;
+declare const SortableList: ({ children, onSortEnd, }: {
     children?: React.ReactNode;
-} & import("react-sortable-hoc").SortableContainerProps, any>;
+    onSortEnd: SortEndHandler;
+}) => JSX.Element;
 export default SortableList;
+export { SortEndHandler };

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

@@ -0,0 +1,20 @@
+import React from 'react';
+declare type RowKeyDownHandler = (event: React.KeyboardEvent<HTMLDivElement>, data: {
+    index: number;
+}) => void;
+/** @public */
+declare type RowRequestRemoveHandler = (event: React.MouseEvent<HTMLButtonElement>, data: {
+    index: number;
+}) => void;
+interface RowPropsBase {
+    children?: React.ReactNode;
+    /** Index of the row. */
+    index?: number;
+    /** Callback when remove button is clicked. */
+    onRequestRemove?: RowRequestRemoveHandler;
+    /** The contents of Row */
+    value?: React.ReactNode;
+}
+declare const Row: React.ForwardRefExoticComponent<RowPropsBase & React.RefAttributes<HTMLDivElement>>;
+export default Row;
+export type { Row as RowWithoutSortable, RowKeyDownHandler, RowPropsBase, RowRequestRemoveHandler };

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

@@ -9,8 +9,12 @@ interface HeadingPropsBase {
      */
     elementRef?: React.Ref<HTMLHeadingElement>;
     /**
-     * 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`.
+     * Corresponds to the respective `<hX>` HTML tags and `typography(titleX)` `@splunk/themes` typography variant.
+     * Styles will be set corresponding to level if variant is not provided: e.g. `level=3` will default to using `title3` from `mixins`.
+     *
+     * @deprecatedValue 's' and 'ss'
+     * The `s` and `ss` values are deprecated and will be removed in a future major version.
+     * See the migration guide for how to maintain the same styling as `level="s"` and `level="ss"`.
      */
     level?: 1 | 2 | 3 | 4 | 's' | 'ss' | 5 | 6;
     /**
@@ -30,12 +34,13 @@ declare const levelToElement: {
     readonly '5': "h5";
     readonly '6': "h6";
 };
-declare function Heading({ level, children, variant, ...otherProps }: HeadingProps): JSX.Element;
+declare function Heading({ children, elementRef, level, variant, ...otherProps }: HeadingProps): JSX.Element;
 declare namespace Heading {
     var propTypes: {
         children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
         elementRef: PropTypes.Requireable<object>;
         level: PropTypes.Requireable<React.ReactText>;
+        variant: PropTypes.Requireable<string>;
     };
 }
 export default Heading;

package/types/src/JSONTree/JSONTree.d.ts

@@ -46,7 +46,8 @@ interface JSONTreePropsBase {
     onClickValue?: JSONTreeClickValueHandler;
     /**
      * Starts with all nodes expanded if set to `true`. The default is `false`, which expands only the first
-     * level of properties.
+     * level of properties. If set to `withShiftModifier`, using `SHIFT + CLICK” or `SHIFT + ENTER` will expand or collapse all
+     * levels of the tree at once.
      */
     expandChildren?: boolean | 'withShiftModifier';
     /**

package/types/src/Layer/Layer.d.ts

@@ -1,4 +1,5 @@
 import React, { Component } from 'react';
+import { LayerStackContext } from './LayerStack';
 /** @public */
 declare type LayerPossibleCloseReason = 'clickAway' | 'escapeKey';
 /** @public */
@@ -30,6 +31,7 @@ declare class Layer extends Component<LayerProps, {}> {
     static possibleCloseReasons: LayerPossibleCloseReason[];
     static propTypes: React.WeakValidationMap<LayerProps>;
     static defaultProps: Required<Pick<LayerPropsBase, "open" | "closeReasons">>;
+    context: React.ContextType<typeof LayerStackContext>;
     static contextType: React.Context<Layer[]>;
     constructor(props: Readonly<LayerProps>);
     componentDidMount(): void;

package/types/src/List/List.d.ts

@@ -10,10 +10,17 @@ interface ListPropsBase {
      * `HTMLUListElement` if type is 'disc', `HTMLOListElement` otherwise.
      */
     elementRef?: React.Ref<HTMLOListElement | HTMLUListElement>;
+    /** Sets the element as an `HTMLOListElement`  otherwise it defaults to `HTMLUListElement`. */
+    ordered?: boolean;
+    /**
+     * @deprecated
+     * This prop is deprecated and will be removed in a future major version. List will default to `HTMLUListElement`. Use `ordered` prop to set list to `HTMLOListElement`. Use CSS to style the `list-style-type` property.
+     */
     type?: 'disc' | 'decimal' | 'lower-alpha' | 'upper-alpha';
 }
 interface ListOrderedPropsBase extends ListPropsBase {
     elementRef?: React.Ref<HTMLOListElement>;
+    ordered?: boolean;
     type: 'decimal' | 'lower-alpha' | 'upper-alpha';
 }
 interface ListUnorderedPropsBase extends ListPropsBase {
@@ -23,11 +30,12 @@ interface ListUnorderedPropsBase extends ListPropsBase {
 declare type ListOrderedProps = ComponentProps<ListOrderedPropsBase, 'ol'>;
 declare type ListUnorderedProps = ComponentProps<ListUnorderedPropsBase, 'ul'>;
 declare type ListProps = ListOrderedProps | ListUnorderedProps;
-declare function List({ children, elementRef, type, ...otherProps }: ListProps): JSX.Element;
+declare function List({ children, elementRef, type, ordered, ...otherProps }: ListProps): JSX.Element;
 declare namespace List {
     var propTypes: {
         children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
         elementRef: PropTypes.Requireable<object>;
+        ordered: PropTypes.Requireable<boolean>;
         type: PropTypes.Requireable<string>;
     };
     var Item: typeof import("./Item").default;

package/types/src/List/docs/examples/CustomizedList.d.ts

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

package/types/src/List/docs/examples/OrderedList.d.ts

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

package/types/src/List/docs/examples/UnorderedList.d.ts

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

package/types/src/Markdown/Markdown.d.ts

@@ -57,6 +57,7 @@ declare type ListRenderer = (data: {
     start: number | null;
     tight: boolean;
     type: 'bullet' | 'ordered';
+    ordered: boolean;
 }) => React.ReactNode;
 /** @public */
 declare type ParagraphRenderer = (data: {

package/types/src/Markdown/renderers/MarkdownList.d.ts

@@ -6,9 +6,11 @@ interface MarkdownListPropsBase {
     start: number | null;
     tight: boolean;
     type: 'bullet' | 'ordered';
+    ordered: boolean;
 }
 interface MarkdownListOrderedPropsBase extends MarkdownListPropsBase {
     type: 'ordered';
+    ordered: boolean;
 }
 interface MarkdownListUnorderedPropsBase extends MarkdownListPropsBase {
     type: 'bullet';