@splunk/react-ui 4.28.2 → 4.30.0

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

@@ -2,17 +2,17 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import { ComponentProps } from '../utils/types';
 /** @public */
-declare type JSONElement = string | {
+type JSONElement = string | {
     [x: string]: JSONElement;
 } | number | boolean | null | JSONElement[];
 /** @public */
-declare type JSONTreeClickValueHandler = (event: React.MouseEvent<HTMLButtonElement>, data: {
+type JSONTreeClickValueHandler = (event: React.MouseEvent<HTMLButtonElement>, data: {
     key: string;
     keyPath: (string | number)[];
     value: string;
 }) => void;
 /** @public */
-declare type JSONTreeClickKeyHandler = (event: React.MouseEvent<HTMLButtonElement>, data: {
+type JSONTreeClickKeyHandler = (event: React.MouseEvent<HTMLButtonElement>, data: {
     key: string;
     keyPath: (string | number)[];
 }) => void;
@@ -64,7 +64,7 @@ interface JSONTreePropsBase {
      */
     expandChildrenOnShiftKey?: boolean;
 }
-declare type JSONTreeProps = ComponentProps<JSONTreePropsBase, 'code'>;
+type JSONTreeProps = ComponentProps<JSONTreePropsBase, 'code'>;
 /**
  * Used to visualize a JSON string.
  */
@@ -72,9 +72,9 @@ declare function JSONTree({ elementRef, expandChildren, indent, json, onClickKey
 declare namespace JSONTree {
     var propTypes: {
         elementRef: PropTypes.Requireable<object>;
-        expandChildren: PropTypes.Requireable<string | boolean>;
+        expandChildren: PropTypes.Requireable<NonNullable<string | boolean | null | undefined>>;
         indent: PropTypes.Requireable<number>;
-        json: PropTypes.Validator<string | number | boolean | object>;
+        json: PropTypes.Validator<NonNullable<NonNullable<string | number | boolean | object | null | undefined>>>;
         onClickKey: PropTypes.Requireable<(...args: any[]) => any>;
         onClickValue: PropTypes.Requireable<(...args: any[]) => any>;
         overflow: PropTypes.Requireable<string>;

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

@@ -3,7 +3,7 @@ import PropTypes from 'prop-types';
 import { JSONElement } from './JSONTree';
 import { TreeItemPropsBase } from '../Tree';
 import { ComponentProps } from '../utils/types';
-declare type ExpandLinkHandler = (data: {
+type ExpandLinkHandler = (data: {
     open: boolean;
     withTooltip: boolean;
 }) => {
@@ -24,7 +24,7 @@ interface JSONTreeItemPropsBase extends TreeItemPropsBase {
     representation?: JSX.Element | JSX.Element[];
     value?: JSONElement;
 }
-declare type JSONTreeItemProps = ComponentProps<JSONTreeItemPropsBase, 'li'>;
+type JSONTreeItemProps = ComponentProps<JSONTreeItemPropsBase, 'li'>;
 export declare function JSONTreeItem({ clickableKeyRef, clickableValRef, hasChildren, indentArray, index, initialOpenState, onFocus, properties, propertyDataPath, propertyElement, renderExpandLink, representation, value, ...otherProps }: JSONTreeItemProps): JSX.Element;
 export declare namespace JSONTreeItem {
     var propTypes: {
@@ -39,7 +39,7 @@ export declare namespace JSONTreeItem {
         propertyElement: PropTypes.Requireable<PropTypes.ReactNodeLike>;
         renderExpandLink: PropTypes.Requireable<(...args: any[]) => any>;
         representation: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        value: PropTypes.Requireable<string | number | boolean | object>;
+        value: PropTypes.Requireable<NonNullable<string | number | boolean | object | null | undefined>>;
     };
 }
 export {};

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

@@ -1,5 +1,5 @@
 import { JSONElement, JSONTreeClickKeyHandler, JSONTreeClickValueHandler } from './JSONTree';
-declare type renderTreeItemsProps = {
+type renderTreeItemsProps = {
     defaultOpen?: boolean;
     expandChildren?: boolean | 'withShiftModifier';
     expandChildrenOnShiftKey?: boolean;

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

@@ -1,9 +1,9 @@
 import React, { Component } from 'react';
 import { LayerStackContext } from './LayerStack';
 /** @public */
-declare type LayerPossibleCloseReason = 'clickAway' | 'escapeKey';
+type LayerPossibleCloseReason = 'clickAway' | 'escapeKey';
 /** @public */
-declare type LayerRequestCloseHandler = (data: {
+type LayerRequestCloseHandler = (data: {
     event: MouseEvent | KeyboardEvent | TouchEvent;
     reason: LayerPossibleCloseReason;
 }) => void;
@@ -24,7 +24,7 @@ interface LayerPropsBase {
     open?: boolean;
 }
 declare const defaultProps: Required<Pick<LayerPropsBase, 'closeReasons' | 'open'>>;
-declare type LayerProps = LayerPropsBase & typeof defaultProps;
+type LayerProps = LayerPropsBase & typeof defaultProps;
 declare class Layer extends Component<LayerProps, {}> {
     private layerClickEvent;
     private static layerContainer;

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

@@ -31,16 +31,16 @@ interface LinkPropsBase {
     to?: string;
 }
 declare const defaultProps: Required<Pick<LinkPropsBase, 'disabled' | 'openInNewContext'>>;
-declare type LinkLinkProps = ClassComponentProps<LinkPropsBase, typeof defaultProps, 'a', 'href'>;
-declare type LinkButtonProps = ClassComponentProps<LinkPropsBase, typeof defaultProps, 'button'>;
-declare type LinkProps = LinkLinkProps | LinkButtonProps;
+type LinkLinkProps = ClassComponentProps<LinkPropsBase, typeof defaultProps, 'a', 'href'>;
+type LinkButtonProps = ClassComponentProps<LinkPropsBase, typeof defaultProps, 'button'>;
+type LinkProps = LinkLinkProps | LinkButtonProps;
 /**
  * `Link` is a simple method for configuring `Button` for inline links. For more complex behaviors,
  * see the `Button` documentation.
  */
 declare class Link extends Component<LinkProps> {
     private component;
-    static propTypes: React.WeakValidationMap<ClassComponentProps<LinkPropsBase, Required<Pick<LinkPropsBase, "disabled" | "openInNewContext">>, "a", "href">> | React.WeakValidationMap<ClassComponentProps<LinkPropsBase, Required<Pick<LinkPropsBase, "disabled" | "openInNewContext">>, "button", never>>;
+    static propTypes: React.WeakValidationMap<LinkProps>;
     static defaultProps: Required<Pick<LinkPropsBase, "disabled" | "openInNewContext">>;
     static [legacyRefMode]: boolean;
     private handleMount;

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

@@ -8,7 +8,7 @@ interface ItemPropsBase {
      */
     elementRef?: React.Ref<HTMLLIElement>;
 }
-declare type ItemProps = ComponentProps<ItemPropsBase, 'li'>;
+type ItemProps = ComponentProps<ItemPropsBase, 'li'>;
 /**
  * A container for items of a `List`.
  */

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

@@ -33,9 +33,9 @@ interface ListUnorderedPropsBase extends ListPropsBase {
     elementRef?: React.Ref<HTMLUListElement>;
     type?: 'disc';
 }
-declare type ListOrderedProps = ComponentProps<ListOrderedPropsBase | ListOrderedTypePropsBase, 'ol'> & typeof defaultProps;
-declare type ListUnorderedProps = ComponentProps<ListUnorderedPropsBase, 'ul'> & typeof defaultProps;
-declare type ListProps = ListOrderedProps | ListUnorderedProps;
+type ListOrderedProps = ComponentProps<ListOrderedPropsBase | ListOrderedTypePropsBase, 'ol'> & typeof defaultProps;
+type ListUnorderedProps = ComponentProps<ListUnorderedPropsBase, 'ul'> & typeof defaultProps;
+type ListProps = ListOrderedProps | ListUnorderedProps;
 declare function List({ children, elementRef, type, ordered, ...otherProps }: ListProps): JSX.Element;
 declare namespace List {
     var propTypes: {

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

@@ -3,55 +3,55 @@ import PropTypes from 'prop-types';
 import { ComponentProps } from '../utils/types';
 import { MarkdownBlockquote, MarkdownCodeBlock, MarkdownCode, MarkdownHeading, MarkdownAnchorHeading, MarkdownImage, MarkdownItem, MarkdownLink, MarkdownList, MarkdownParagraph } from './renderers';
 /** @public */
-declare type AnchorHeadingRenderer = (data: {
+type AnchorHeadingRenderer = (data: {
     children: React.ReactNode[];
     level: 1 | 2 | 3 | 4 | 5 | 6;
     nodeKey: string;
 }) => React.ReactNode;
 /** @public */
-declare type BlockquoteRenderer = (data: {
+type BlockquoteRenderer = (data: {
     children: React.ReactNode[];
     nodeKey: string;
 }) => React.ReactNode;
 /** @public */
-declare type CodeRenderer = (data: {
+type CodeRenderer = (data: {
     inline: true;
     literal: string;
     nodeKey: string;
 }) => React.ReactNode;
 /** @public */
-declare type CodeBlockRenderer = (data: {
+type CodeBlockRenderer = (data: {
     language?: string;
     literal: string;
     nodeKey: string;
 }) => React.ReactNode;
 /** @public */
-declare type HeadingRenderer = (data: {
+type HeadingRenderer = (data: {
     children: React.ReactNode[];
     level: 1 | 2 | 3 | 4 | 5 | 6;
     nodeKey: string;
 }) => React.ReactNode;
 /** @public */
-declare type ImageRenderer = (data: {
+type ImageRenderer = (data: {
     alt: string;
     nodeKey: string;
     src: string;
     title?: string;
 }) => React.ReactNode;
 /** @public */
-declare type ItemRenderer = (data: {
+type ItemRenderer = (data: {
     children: React.ReactNode[];
     nodeKey: string;
 }) => React.ReactNode;
 /** @public */
-declare type LinkRenderer = (data: {
+type LinkRenderer = (data: {
     children: React.ReactNode[];
     href: string;
     nodeKey: string;
     title?: string;
 }) => React.ReactNode;
 /** @public */
-declare type ListRenderer = (data: {
+type ListRenderer = (data: {
     children: React.ReactNode[];
     nodeKey: string;
     start: number | null;
@@ -60,7 +60,7 @@ declare type ListRenderer = (data: {
     ordered: boolean;
 }) => React.ReactNode;
 /** @public */
-declare type ParagraphRenderer = (data: {
+type ParagraphRenderer = (data: {
     children: React.ReactNode[];
     nodeKey: string;
 }) => React.ReactNode;
@@ -76,7 +76,7 @@ interface MarkdownPropsBase {
     codeRenderer?: CodeRenderer;
     /**
      * A custom code block renderer. The function is passed an object containing `language`,
-     * `literal`, and `nodeKey`.
+     * `literal`, and `nodeKey`. It supports the same languages as used in the `Code` component.
      */
     codeBlockRenderer?: CodeBlockRenderer;
     /**
@@ -113,14 +113,19 @@ interface MarkdownPropsBase {
     paragraphRenderer?: ParagraphRenderer;
     /** The content to be parsed and rendered. */
     text: string;
+    /**
+     * @private
+     * Object of type RendererOptions that can use used to override the props for ReactCommonmarkRenderer.
+     */
+    rendererOptions?: object;
 }
-declare type MarkdownProps = ComponentProps<MarkdownPropsBase, 'div'>;
+type MarkdownProps = ComponentProps<MarkdownPropsBase, 'div'>;
 /**
  * The `Markdown` component renders the given Markdown text as a React component.
  * The component prefers @splunk/react-ui components over plain HTML components. For example
  * links are rendered as the `@splunk/react-ui/Link` component instead of plain `<a>` tag.
  */
-declare function Markdown({ blockquoteRenderer, codeBlockRenderer, codeRenderer, elementRef, headingRenderer, imageRenderer, itemRenderer, linkRenderer, listRenderer, paragraphRenderer, text, ...otherProps }: MarkdownProps): JSX.Element;
+declare function Markdown({ blockquoteRenderer, codeBlockRenderer, codeRenderer, elementRef, headingRenderer, imageRenderer, itemRenderer, linkRenderer, listRenderer, paragraphRenderer, text, rendererOptions: rendererOptionsOverride, ...otherProps }: MarkdownProps): JSX.Element;
 declare namespace Markdown {
     var propTypes: {
         blockquoteRenderer: PropTypes.Requireable<(...args: any[]) => any>;
@@ -134,6 +139,7 @@ declare namespace Markdown {
         listRenderer: PropTypes.Requireable<(...args: any[]) => any>;
         paragraphRenderer: PropTypes.Requireable<(...args: any[]) => any>;
         text: PropTypes.Validator<string>;
+        rendererOptions: PropTypes.Requireable<object>;
     };
 }
 export default Markdown;

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

@@ -5,7 +5,7 @@ interface MarkdownAnchorHeadingPropsBase {
     children: React.ReactNode[];
     level: 1 | 2 | 3 | 4 | 5 | 6;
 }
-declare type MarkdownAnchorHeadingProps = ComponentProps<MarkdownAnchorHeadingPropsBase, 'h1'>;
+type MarkdownAnchorHeadingProps = ComponentProps<MarkdownAnchorHeadingPropsBase, 'h1'>;
 declare function MarkdownAnchorHeading({ level, children, ...otherProps }: MarkdownAnchorHeadingProps): JSX.Element;
 declare namespace MarkdownAnchorHeading {
     var propTypes: {

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

@@ -4,7 +4,7 @@ import { ComponentProps } from '../../utils/types';
 interface MarkdownBlockquotePropsBase {
     children: React.ReactNode[];
 }
-declare type MarkdownBlockquoteProps = ComponentProps<MarkdownBlockquotePropsBase, 'blockquote'>;
+type MarkdownBlockquoteProps = ComponentProps<MarkdownBlockquotePropsBase, 'blockquote'>;
 declare function MarkdownBlockquote({ children, ...otherProps }: MarkdownBlockquoteProps): JSX.Element;
 declare namespace MarkdownBlockquote {
     var propTypes: {

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

@@ -4,7 +4,7 @@ interface MarkdownCodePropsBase {
     inline: true;
     literal: string;
 }
-declare type MarkdownCodeProps = ComponentProps<MarkdownCodePropsBase, 'code'>;
+type MarkdownCodeProps = ComponentProps<MarkdownCodePropsBase, 'code'>;
 declare function MarkdownCode({ literal, ...otherProps }: MarkdownCodeProps): JSX.Element;
 declare namespace MarkdownCode {
     var propTypes: {

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

@@ -4,7 +4,7 @@ interface MarkdownCodeBlockPropsBase {
     language?: string;
     literal: string;
 }
-declare type MarkdownCodeBlockProps = ComponentProps<MarkdownCodeBlockPropsBase, 'div'>;
+type MarkdownCodeBlockProps = ComponentProps<MarkdownCodeBlockPropsBase, 'div'>;
 declare function MarkdownCodeBlock({ literal, language, ...otherProps }: MarkdownCodeBlockProps): JSX.Element;
 declare namespace MarkdownCodeBlock {
     var propTypes: {

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

@@ -5,7 +5,7 @@ interface MarkdownHeadingPropsBase {
     children: React.ReactNode | React.ReactNode[];
     level: 1 | 2 | 3 | 4 | 5 | 6;
 }
-declare type MarkdownHeadingProps = ComponentProps<MarkdownHeadingPropsBase, 'h1'>;
+type MarkdownHeadingProps = ComponentProps<MarkdownHeadingPropsBase, 'h1'>;
 declare function MarkdownHeading({ level, children, ...otherProps }: MarkdownHeadingProps): JSX.Element;
 declare namespace MarkdownHeading {
     var propTypes: {

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

@@ -5,7 +5,7 @@ interface MarkdownImagePropsBase {
     src: string;
     title?: string;
 }
-declare type MarkdownImageProps = ComponentProps<MarkdownImagePropsBase, 'img'>;
+type MarkdownImageProps = ComponentProps<MarkdownImagePropsBase, 'img'>;
 declare function MarkdownImage({ src, title, alt, ...otherProps }: MarkdownImageProps): JSX.Element;
 declare namespace MarkdownImage {
     var propTypes: {

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

@@ -4,7 +4,7 @@ import { ComponentProps } from '../../utils/types';
 interface MarkdownItemPropsBase {
     children: React.ReactNode[];
 }
-declare type MarkdownItemProps = ComponentProps<MarkdownItemPropsBase, 'li'>;
+type MarkdownItemProps = ComponentProps<MarkdownItemPropsBase, 'li'>;
 declare function MarkdownItem({ children, ...otherProps }: MarkdownItemProps): JSX.Element;
 declare namespace MarkdownItem {
     var propTypes: {

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

@@ -6,7 +6,7 @@ interface MarkdownLinkPropsBase {
     href: string;
     title?: string;
 }
-declare type MarkdownLinkProps = ComponentProps<MarkdownLinkPropsBase, 'a'>;
+type MarkdownLinkProps = ComponentProps<MarkdownLinkPropsBase, 'a'>;
 declare function MarkdownLink({ children, href, ...otherProps }: MarkdownLinkProps): JSX.Element;
 declare namespace MarkdownLink {
     var propTypes: {

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

@@ -15,9 +15,9 @@ interface MarkdownListOrderedPropsBase extends MarkdownListPropsBase {
 interface MarkdownListUnorderedPropsBase extends MarkdownListPropsBase {
     type: 'bullet';
 }
-declare type MarkdownListOrderedProps = ComponentProps<MarkdownListOrderedPropsBase, 'ol'>;
-declare type MarkdownListUnorderedProps = ComponentProps<MarkdownListUnorderedPropsBase, 'ul'>;
-declare type MarkdownListProps = MarkdownListOrderedProps | MarkdownListUnorderedProps;
+type MarkdownListOrderedProps = ComponentProps<MarkdownListOrderedPropsBase, 'ol'>;
+type MarkdownListUnorderedProps = ComponentProps<MarkdownListUnorderedPropsBase, 'ul'>;
+type MarkdownListProps = MarkdownListOrderedProps | MarkdownListUnorderedProps;
 declare function MarkdownList({ children, type, ...otherProps }: MarkdownListProps): JSX.Element;
 declare namespace MarkdownList {
     var propTypes: {

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

@@ -4,7 +4,7 @@ import { ComponentProps } from '../../utils/types';
 interface MarkdownParagraphPropsBase {
     children: React.ReactNode[];
 }
-declare type MarkdownParagraphProps = ComponentProps<MarkdownParagraphPropsBase, 'p'>;
+type MarkdownParagraphProps = ComponentProps<MarkdownParagraphPropsBase, 'p'>;
 declare function MarkdownParagraph({ children, ...otherProps }: MarkdownParagraphProps): JSX.Element;
 declare namespace MarkdownParagraph {
     var propTypes: {

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

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

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

@@ -10,7 +10,7 @@ interface HeadingPropsBase {
     title?: boolean;
     outerStyle?: React.CSSProperties;
 }
-declare type HeadingProps = ComponentProps<HeadingPropsBase, 'div'>;
+type HeadingProps = ComponentProps<HeadingPropsBase, 'div'>;
 /**
  * A non-interactive `Menu` item used to separate and label groups of `Menu` items.
  */