@splunk/react-ui 4.23.0 → 4.25.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splunk/react-ui",
-  "version": "4.23.0",
+  "version": "4.25.0",
   "description": "Library of React components that implement the Splunk design language",
   "license": "Apache-2.0",
   "author": "Splunk Inc.",
@@ -29,7 +29,8 @@
     "test:watch": "jest --watch",
     "test:cypress": "yarn cypress open --component",
     "test:cypress:ci": "yarn cypress run --component",
-    "types:build": "tsc --emitDeclarationOnly --declaration --declarationDir ./types && node ./scripts/pruneTypes.js",
+    "types:build": "yarn types:build:cypress && tsc --emitDeclarationOnly --declaration --declarationDir ./types && node ./scripts/pruneTypes.js",
+    "types:build:cypress": "tsc --p cypress/tsconfig.cypress.json",
     "types:start": "yarn types:build --watch"
   },
   "peerDependencies": {
@@ -44,13 +45,6 @@
     "@splunk/react-icons": "^4.2.0",
     "@splunk/themes": "^0.16.4",
     "@splunk/ui-utils": "^1.6.0",
-    "@types/commonmark": "^0.27.6",
-    "@types/lodash": "^4.14.156",
-    "@types/react": "^16.9.38",
-    "@types/react-dom": "^16.9.8",
-    "@types/react-resize-detector": "^3.1.1",
-    "@types/styled-components": "^5.1.0",
-    "@types/tinycolor2": "^1.4.2",
     "commonmark": "^0.30.0",
     "commonmark-react-renderer": "^4.3.2",
     "decimal.js-light": "^2.2.3",
@@ -86,11 +80,17 @@
     "@testing-library/react": "^12.1.2",
     "@testing-library/react-hooks": "^7.0.2",
     "@testing-library/user-event": "^14.4.3",
+    "@types/commonmark": "^0.27.6",
     "@types/jest": "^26.0.0",
-    "@types/mocha": "^7.0.2",
+    "@types/lodash": "^4.14.156",
     "@types/node": "^10.17.26",
-    "@types/prismjs": "^1.16.1",
+    "@types/prismjs": "^1.26.3",
+    "@types/react": "^16.9.38",
+    "@types/react-dom": "^16.9.8",
+    "@types/react-resize-detector": "^3.1.1",
     "@types/sinon": "^4.3.3",
+    "@types/styled-components": "^5.1.0",
+    "@types/tinycolor2": "^1.4.2",
     "@types/webdriverio": "^5.0.0",
     "@types/webpack-env": "^1.15.2",
     "@typescript-eslint/eslint-plugin": "^4.8.2",
@@ -126,7 +126,7 @@
     "jest-stare": "^2.4.1",
     "mkdirp": "^0.5.1",
     "playwright": "^1.23.3",
-    "prismjs": "^1.25.0",
+    "prismjs": "^1.29.0",
     "prompt": "^1.0.0",
     "raw-loader": "^4.0.2",
     "react": "^16.12.0",

package/types/src/Breadcrumbs/Breadcrumbs.d.ts

@@ -11,14 +11,20 @@ interface BreadcrumbsPropsBase {
      * A React ref which is set to the DOM element when the component mounts and null when it unmounts.
      */
     elementRef?: React.Ref<HTMLElement>;
+    /**
+     * By default, the current page is a dimmed link. This prop changes this behavior by enabling the current page link.
+     */
+    enableCurrentPage?: boolean;
 }
 declare type BreadcrumbsProps = ComponentProps<BreadcrumbsPropsBase, 'nav'>;
-declare function Breadcrumbs({ children, elementRef, ...otherProps }: BreadcrumbsProps): JSX.Element;
+declare function Breadcrumbs({ children, elementRef, enableCurrentPage, ...otherProps }: BreadcrumbsProps): JSX.Element;
 declare namespace Breadcrumbs {
     var propTypes: {
         children: PropTypes.Validator<string | number | boolean | {} | PropTypes.ReactElementLike | PropTypes.ReactNodeArray>;
         elementRef: PropTypes.Requireable<object>;
+        enableCurrentPage: PropTypes.Requireable<boolean>;
     };
+    var defaultProps: Required<Pick<BreadcrumbsPropsBase, "enableCurrentPage">>;
     var Item: typeof import("./Item").default;
 }
 export default Breadcrumbs;

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

@@ -6,12 +6,16 @@ interface ItemPropsBase {
      * A React ref which is set to the DOM element when the component mounts and null when it unmounts.
      */
     elementRef?: React.Ref<HTMLAnchorElement>;
+    /**
+     * @private. Passed by Breadcrumbs.
+     */
+    enableCurrentPage?: boolean;
     /**
      * Adornment at the end of the label.
      */
     endAdornment?: React.ReactNode;
     /**
-     * @private
+     * @private. Passed by Breadcrumbs.
      */
     isCurrent?: boolean;
     /**
@@ -28,15 +32,17 @@ interface ItemPropsBase {
     to: string;
 }
 declare type ItemProps = ComponentProps<ItemPropsBase, 'a'>;
-declare function Item({ endAdornment, isCurrent, label, startAdornment, to, ...otherProps }: ItemProps): JSX.Element;
+declare function Item({ enableCurrentPage, endAdornment, isCurrent, label, startAdornment, to, ...otherProps }: ItemProps): JSX.Element;
 declare namespace Item {
     var propTypes: {
         elementRef: PropTypes.Requireable<object>;
+        enableCurrentPage: PropTypes.Requireable<boolean>;
         endAdornment: PropTypes.Requireable<PropTypes.ReactNodeLike>;
         isCurrent: PropTypes.Requireable<boolean>;
         label: PropTypes.Validator<string>;
         startAdornment: PropTypes.Requireable<PropTypes.ReactNodeLike>;
         to: PropTypes.Validator<string>;
     };
+    var defaultProps: Required<Pick<ItemPropsBase, "enableCurrentPage" | "isCurrent">>;
 }
 export default Item;

package/types/src/Button/Button.d.ts

@@ -21,8 +21,10 @@ interface ButtonPropsBase {
     children?: React.ReactNode;
     /** @private An additional className to add to the button. */
     classNamePrivate?: string;
-    /** Prevents user from clicking the button. */
-    disabled?: boolean;
+    /** Prevents user from clicking the button. If set to `dimmed`, the button
+     * does not respond to mouse events but can still receive focus, and
+     * `aria-disabled` is set to `true`. */
+    disabled?: boolean | 'dimmed';
     /**
      * A React ref which is set to the DOM element when the component mounts and null when it unmounts.
      */

package/types/src/Button/docs/examples/Block.d.ts

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

package/types/src/Button/docs/examples/Dimmed.d.ts

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

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

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

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

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

package/types/src/Button/docs/examples/Menus.d.ts

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

package/types/src/Button/docs/examples/To.d.ts

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

package/types/src/Button/docs/examples/Truncated.d.ts

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

package/types/src/Button/docs/examples/prisma/Basic.d.ts

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

package/types/src/Button/docs/examples/prisma/Block.d.ts

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

package/types/src/Button/docs/examples/prisma/Dimmed.d.ts

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

package/types/src/Button/docs/examples/prisma/Disabled.d.ts

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

package/types/src/Button/docs/examples/prisma/Menus.d.ts

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

package/types/src/Button/docs/examples/prisma/To.d.ts

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

package/types/src/Button/docs/examples/prisma/Truncated.d.ts

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

package/types/src/ButtonSimple/ButtonSimple.d.ts

@@ -14,8 +14,10 @@ interface ButtonSimplePropsBase {
      * append things to it. */
     append?: boolean;
     children?: React.ReactNode;
-    /** Add a disabled attribute and prevent clicking. */
-    disabled?: boolean;
+    /** Add a disabled attribute and prevent clicking. If set to `dimmed`,
+     * the button does not respond to mouse events but can still receive
+     * focus, and `aria-disabled` is set to `true`. */
+    disabled?: boolean | 'dimmed';
     /**
      * Adds error styling to the button and applies `aria-invalid`.
      */