@splunk/react-ui 4.20.0 → 4.21.1

package/stubs-splunkui.d.ts

@@ -87,6 +87,9 @@ declare module '@splunk/react-docs/DocExample' {
 }
 
 declare module '!!raw-loader!*' {
-    const contents: string;
+    const contents: {
+        default: string;
+    };
+
     export = contents;
 }

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

@@ -16,7 +16,7 @@ interface OptionPropsBase {
     description?: string;
     /**
      * The description text may appear to the right of the label or under the label.
-     * @themeNotes Themes that don't support 'right' fall back to 'bottom'.
+     * @themeNotes 'right' is only supported in enterprise themes. Unsupported values will fall back to ‘bottom’.
      */
     descriptionPosition?: 'right' | 'bottom';
     /**

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

@@ -20,6 +20,10 @@ interface ConcertinaState {
     scrollEl: Element | null;
     targetTop?: number;
 }
+/**
+ * @deprecated
+ * Concertina has been deprecated and will be removed in a future major version.
+ */
 declare class Concertina extends Component<ConcertinaProps, ConcertinaState> {
     private panelPositions;
     static propTypes: React.WeakValidationMap<ClassComponentProps<ConcertinaPropsBase, {}, "div", never>>;

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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export interface JSONTreeContext {
+    shift?: boolean | null;
+    updateShift?: (newShift: boolean) => void;
+}
+export declare const JSONTreeContext: import("react").Context<JSONTreeContext>;
+export default JSONTreeContext;

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

@@ -1,5 +1,6 @@
 import React, { Component } from 'react';
 import { JSONElement, JSONTreeClickValueHandler, JSONTreeClickKeyHandler } from './JSONTree';
+import JSONTreeContext from './JSONTreeContext';
 import { ClassComponentProps } from '../utils/types';
 interface JSONTreeNodePropsBase {
     path?: (string | number)[];
@@ -11,6 +12,7 @@ interface JSONTreeNodePropsBase {
     onClickKey?: JSONTreeClickKeyHandler;
     onClickValue?: JSONTreeClickValueHandler;
     overflow?: 'wrap' | 'scroll';
+    shift?: boolean;
 }
 declare const defaultProps: Required<Pick<JSONTreeNodePropsBase, 'path' | 'defaultOpen' | 'expandChildren' | 'indent' | 'indentLevel' | 'overflow'>>;
 declare type JSONTreeNodeProps = ClassComponentProps<JSONTreeNodePropsBase, typeof defaultProps, 'span'>;
@@ -23,6 +25,9 @@ interface JSONTreeNodeState {
 declare class JSONTreeNode extends Component<JSONTreeNodeProps, JSONTreeNodeState> {
     private regularIndent;
     private closingIndent;
+    private mutableShift;
+    context: React.ContextType<typeof JSONTreeContext>;
+    static contextType: React.Context<JSONTreeContext>;
     static propTypes: React.WeakValidationMap<ClassComponentProps<JSONTreeNodePropsBase, Required<Pick<JSONTreeNodePropsBase, "path" | "overflow" | "defaultOpen" | "expandChildren" | "indent" | "indentLevel">>, "span", never>>;
     static defaultProps: Required<Pick<JSONTreeNodePropsBase, "path" | "overflow" | "defaultOpen" | "expandChildren" | "indent" | "indentLevel">>;
     constructor(props: JSONTreeNodeProps);

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

@@ -17,10 +17,14 @@ interface LinkPropsBase {
      */
     elementRef?: React.Ref<HTMLButtonElement | HTMLAnchorElement>;
     /**
-     * To open the link in a new window, set `openInNewContext` to `true`. An icon is added
-     * indicating the behavior.
+     * Open the link in a new context. Usually this will open the location in a new tab,
+     * but may open in a new window depending on the user's browser and settings.
+     *
+     * An icon and a message is added to indicate this behavior to users.
+     * "(Opens new window)" is the default message. This can be customized by passing
+     * a string instead of boolean to `openInNewContext`.
      */
-    openInNewContext?: boolean;
+    openInNewContext?: boolean | string;
     /**
      * The URL or path to link to.
      */

package/types/src/Link/docs/examples/NewWindow.d.ts

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

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

@@ -120,7 +120,7 @@ declare type MarkdownProps = ComponentProps<MarkdownPropsBase, 'div'>;
  * 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, 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, ...otherProps }: MarkdownProps): JSX.Element;
 declare namespace Markdown {
     var propTypes: {
         blockquoteRenderer: PropTypes.Requireable<(...args: any[]) => any>;

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

@@ -2,7 +2,7 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import { ComponentProps } from '../../utils/types';
 interface MarkdownHeadingPropsBase {
-    children: React.ReactNode[];
+    children: React.ReactNode | React.ReactNode[];
     level: 1 | 2 | 3 | 4 | 5 | 6;
 }
 declare type MarkdownHeadingProps = ComponentProps<MarkdownHeadingPropsBase, 'h1'>;

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

@@ -19,7 +19,7 @@ interface ItemPropsBase {
     description?: string;
     /**
      * The description text might appear to the right of the label or under the label.
-     * @themeNotes Themes that don't support 'right' fall back to 'bottom'.
+     * @themeNotes 'right' is only supported in enterprise themes. Unsupported values will fall back to ‘bottom’.
      */
     descriptionPosition?: 'right' | 'bottom';
     /**

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

@@ -7,6 +7,7 @@ import { ClassComponentProps } from '../utils/types';
 interface MenuPropsBase {
     /**
      * Must be `Menu.Item`, `Menu.Heading`, or `Menu.Divider`.
+     * Interactive elements are not supported as children.
      */
     children?: React.ReactNode;
     /**

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

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

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

@@ -22,7 +22,7 @@ interface OptionPropsBase {
     description?: string;
     /**
      * The description text may appear to the right of the label or under the label.
-     * @themeNotes Themes that don't support 'right' fall back to 'bottom'.
+     * @themeNotes 'right' is only supported in enterprise themes. Unsupported values will fall back to ‘bottom’.
      */
     descriptionPosition?: 'right' | 'bottom';
     /**

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

@@ -18,7 +18,7 @@ interface OptionPropsBase {
     description?: string;
     /**
      * The description text may appear to the right of the label or under the label.
-     * @themeNotes Themes that don't support 'right' fall back to 'bottom'.
+     * @themeNotes 'right' is only supported in enterprise themes. Unsupported values will fall back to ‘bottom’.
      */
     descriptionPosition?: 'right' | 'bottom';
     /**

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

@@ -16,7 +16,7 @@ interface OptionPropsBase {
     description?: string;
     /**
      * The description text may appear to the right of the label or under the label.
-     * @themeNotes Themes that don't support 'right' fall back to 'bottom'.
+     * @themeNotes 'right' is only supported in enterprise themes. Unsupported values will fall back to ‘bottom’.
      */
     descriptionPosition?: 'right' | 'bottom';
     /**

package/types/src/Select/OptionBase.d.ts

@@ -20,7 +20,7 @@ interface OptionPropsBase {
     description?: string;
     /**
      * The description text may appear to the right of the label or under the label.
-     * @themeNotes Themes that don't support 'right' fall back to 'bottom'.
+     * @themeNotes 'right' is only supported in enterprise themes. Unsupported values will fall back to ‘bottom’.
      */
     descriptionPosition?: 'right' | 'bottom';
     /**

package/types/src/fixtures/FetchOptions.d.ts

@@ -59,17 +59,11 @@ export default class FetchOptions {
     /**
      * @return Option of given value;
      */
-    getOption: (value: number) => {
-        id: number;
-        title: string;
-    } | undefined;
+    getOption: (value: number) => Movie | undefined;
     /**
      * @return Options of given values;
      */
-    getSelectedOptions: (values: number[]) => {
-        id: number;
-        title: string;
-    }[];
+    getSelectedOptions: (values: number[]) => Movie[];
     /**
      * Get current length of indexes fetched.
      */

package/useForceUpdate.js

@@ -1,151 +1,117 @@
-module.exports =
-/******/ (function(modules) { // webpackBootstrap
-/******/ 	// The module cache
-/******/ 	var installedModules = {};
-/******/
-/******/ 	// The require function
-/******/ 	function __webpack_require__(moduleId) {
-/******/
-/******/ 		// Check if module is in cache
-/******/ 		if(installedModules[moduleId]) {
-/******/ 			return installedModules[moduleId].exports;
-/******/ 		}
-/******/ 		// Create a new module (and put it into the cache)
-/******/ 		var module = installedModules[moduleId] = {
-/******/ 			i: moduleId,
-/******/ 			l: false,
-/******/ 			exports: {}
-/******/ 		};
-/******/
-/******/ 		// Execute the module function
-/******/ 		modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
-/******/
-/******/ 		// Flag the module as loaded
-/******/ 		module.l = true;
-/******/
-/******/ 		// Return the exports of the module
-/******/ 		return module.exports;
-/******/ 	}
-/******/
-/******/
-/******/ 	// expose the modules object (__webpack_modules__)
-/******/ 	__webpack_require__.m = modules;
-/******/
-/******/ 	// expose the module cache
-/******/ 	__webpack_require__.c = installedModules;
-/******/
-/******/ 	// define getter function for harmony exports
-/******/ 	__webpack_require__.d = function(exports, name, getter) {
-/******/ 		if(!__webpack_require__.o(exports, name)) {
-/******/ 			Object.defineProperty(exports, name, { enumerable: true, get: getter });
-/******/ 		}
-/******/ 	};
-/******/
-/******/ 	// define __esModule on exports
-/******/ 	__webpack_require__.r = function(exports) {
-/******/ 		if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
-/******/ 			Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-/******/ 		}
-/******/ 		Object.defineProperty(exports, '__esModule', { value: true });
-/******/ 	};
-/******/
-/******/ 	// create a fake namespace object
-/******/ 	// mode & 1: value is a module id, require it
-/******/ 	// mode & 2: merge all properties of value into the ns
-/******/ 	// mode & 4: return value when already ns object
-/******/ 	// mode & 8|1: behave like require
-/******/ 	__webpack_require__.t = function(value, mode) {
-/******/ 		if(mode & 1) value = __webpack_require__(value);
-/******/ 		if(mode & 8) return value;
-/******/ 		if((mode & 4) && typeof value === 'object' && value && value.__esModule) return value;
-/******/ 		var ns = Object.create(null);
-/******/ 		__webpack_require__.r(ns);
-/******/ 		Object.defineProperty(ns, 'default', { enumerable: true, value: value });
-/******/ 		if(mode & 2 && typeof value != 'string') for(var key in value) __webpack_require__.d(ns, key, function(key) { return value[key]; }.bind(null, key));
-/******/ 		return ns;
-/******/ 	};
-/******/
-/******/ 	// getDefaultExport function for compatibility with non-harmony modules
-/******/ 	__webpack_require__.n = function(module) {
-/******/ 		var getter = module && module.__esModule ?
-/******/ 			function getDefault() { return module['default']; } :
-/******/ 			function getModuleExports() { return module; };
-/******/ 		__webpack_require__.d(getter, 'a', getter);
-/******/ 		return getter;
-/******/ 	};
-/******/
-/******/ 	// Object.prototype.hasOwnProperty.call
-/******/ 	__webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };
-/******/
-/******/ 	// __webpack_public_path__
-/******/ 	__webpack_require__.p = "";
-/******/
-/******/
-/******/ 	// Load entry module and return exports
-/******/ 	return __webpack_require__(__webpack_require__.s = 244);
-/******/ })
-/************************************************************************/
-/******/ ({
-
-/***/ 2:
-/***/ (function(module, exports) {
-
-module.exports = require("react");
-
-/***/ }),
-
-/***/ 244:
-/***/ (function(module, __webpack_exports__, __webpack_require__) {
-
-"use strict";
-// ESM COMPAT FLAG
-__webpack_require__.r(__webpack_exports__);
-
-// EXPORTS
-__webpack_require__.d(__webpack_exports__, "default", function() { return /* reexport */ useForceUpdate_useForceUpdate; });
-
-// EXTERNAL MODULE: external "react"
-var external_react_ = __webpack_require__(2);
-
-// CONCATENATED MODULE: ./src/useForceUpdate/useForceUpdate.tsx
-function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
-
-function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
-
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
-
-function _iterableToArrayLimit(arr, i) { if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return; var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
-
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-
-
-/**
+/******/ (() => {
+    // webpackBootstrap
+    /******/ "use strict";
+    /******/ // The require scope
+    /******/    var r = {};
+    /******/
+    /************************************************************************/
+    /******/ /* webpack/runtime/define property getters */
+    /******/    (() => {
+        /******/ // define getter functions for harmony exports
+        /******/ r.d = (e, t) => {
+            /******/ for (var n in t) {
+                /******/ if (r.o(t, n) && !r.o(e, n)) {
+                    /******/ Object.defineProperty(e, n, {
+                        enumerable: true,
+                        get: t[n]
+                    });
+                    /******/                }
+                /******/            }
+            /******/        };
+        /******/    })();
+    /******/
+    /******/ /* webpack/runtime/hasOwnProperty shorthand */
+    /******/    (() => {
+        /******/ r.o = (r, e) => Object.prototype.hasOwnProperty.call(r, e)
+        /******/;
+    })();
+    /******/
+    /******/ /* webpack/runtime/make namespace object */
+    /******/    (() => {
+        /******/ // define __esModule on exports
+        /******/ r.r = r => {
+            /******/ if (typeof Symbol !== "undefined" && Symbol.toStringTag) {
+                /******/ Object.defineProperty(r, Symbol.toStringTag, {
+                    value: "Module"
+                });
+                /******/            }
+            /******/            Object.defineProperty(r, "__esModule", {
+                value: true
+            });
+            /******/        };
+        /******/    })();
+    /******/
+    /************************************************************************/    var e = {};
+    // ESM COMPAT FLAG
+        r.r(e);
+    // EXPORTS
+        r.d(e, {
+        default: () => /* reexport */ c
+    });
+    // CONCATENATED MODULE: external "react"
+    const t = require("react");
+    // CONCATENATED MODULE: ./src/useForceUpdate/useForceUpdate.tsx
+    function n(r, e) {
+        return f(r) || i(r, e) || u(r, e) || o();
+    }
+    function o() {
+        throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+    }
+    function u(r, e) {
+        if (!r) return;
+        if (typeof r === "string") return a(r, e);
+        var t = Object.prototype.toString.call(r).slice(8, -1);
+        if (t === "Object" && r.constructor) t = r.constructor.name;
+        if (t === "Map" || t === "Set") return Array.from(r);
+        if (t === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t)) return a(r, e);
+    }
+    function a(r, e) {
+        if (e == null || e > r.length) e = r.length;
+        for (var t = 0, n = new Array(e); t < e; t++) {
+            n[t] = r[t];
+        }
+        return n;
+    }
+    function i(r, e) {
+        if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(r))) return;
+        var t = [];
+        var n = true;
+        var o = false;
+        var u = undefined;
+        try {
+            for (var a = r[Symbol.iterator](), i; !(n = (i = a.next()).done); n = true) {
+                t.push(i.value);
+                if (e && t.length === e) break;
+            }
+        } catch (r) {
+            o = true;
+            u = r;
+        } finally {
+            try {
+                if (!n && a["return"] != null) a["return"]();
+            } finally {
+                if (o) throw u;
+            }
+        }
+        return t;
+    }
+    function f(r) {
+        if (Array.isArray(r)) return r;
+    }
+    /**
  * This is a private component not intended for use outside @splunk/react-ui
  *
  * Triggers a rerender of a functional component. Useful as an escape hatch when a render is needed regardless of state.
  * See https://reactjs.org/docs/hooks-faq.html#is-there-something-like-forceupdate
  *
- */
-
-function useForceUpdate() {
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  var _useReducer = Object(external_react_["useReducer"])(function (x) {
-    return x + 1;
-  }, 0),
-      _useReducer2 = _slicedToArray(_useReducer, 2),
-      ignored = _useReducer2[0],
-      forceUpdate = _useReducer2[1];
-
-  return forceUpdate;
-}
-
-/* harmony default export */ var useForceUpdate_useForceUpdate = (useForceUpdate);
-// CONCATENATED MODULE: ./src/useForceUpdate/index.ts
-
-
-
-/***/ })
-
-/******/ });
+ */    function l() {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        var r = (0, t.useReducer)((function(r) {
+            return r + 1;
+        }), 0), e = n(r, 2), o = e[0], u = e[1];
+        return u;
+    }
+    /* harmony default export */    const c = l;
+    // CONCATENATED MODULE: ./src/useForceUpdate/index.ts
+    module.exports = e;
+    /******/})();