@deque/cauldron-react 6.27.0-canary.7fd2f1e5 → 6.27.0-canary.90942368

package/lib/components/Dialog/DialogContext.d.ts

@@ -6,6 +6,7 @@ interface DialogContextValue {
     onClose: () => void;
     forceAction: boolean;
     closeButtonText: string;
+    scrollable: boolean;
 }
 declare const DialogContext: React.Context<DialogContextValue | null>;
 declare function useDialogContext(): DialogContextValue;

package/lib/components/Dialog/index.d.ts

@@ -12,6 +12,7 @@ export interface DialogProps extends React.HTMLAttributes<HTMLDivElement> {
     };
     closeButtonText?: string;
     portal?: React.RefObject<HTMLElement> | HTMLElement;
+    scrollable?: boolean;
 }
 declare const Dialog: React.ForwardRefExoticComponent<DialogProps & React.RefAttributes<HTMLDivElement>>;
 export default Dialog;

package/lib/components/Modal/index.d.ts

@@ -2,8 +2,9 @@ import React from 'react';
 import { DialogProps } from '../Dialog';
 interface ModalProps extends Omit<DialogProps, 'forceAction'> {
     variant?: 'info';
+    scrollable?: boolean;
 }
-declare const Modal: ({ children, className, variant, ...other }: ModalProps) => React.JSX.Element;
+declare const Modal: ({ children, className, variant, scrollable, ...other }: ModalProps) => React.JSX.Element;
 declare const ModalHeader: {
     ({ children, className, ...other }: import("../Dialog").DialogHeaderProps): React.JSX.Element;
     displayName: string;

package/lib/components/Toast/index.d.ts

@@ -1,39 +1,19 @@
 import React from 'react';
-import AriaIsolate from '../../utils/aria-isolate';
 export interface ToastProps extends React.HTMLAttributes<HTMLDivElement> {
     type: 'confirmation' | 'caution' | 'error' | 'action-needed' | 'info';
-    onDismiss: () => void;
+    onDismiss?: () => void;
     dismissText?: string;
-    toastRef: React.Ref<HTMLDivElement>;
+    toastRef?: React.Ref<HTMLDivElement>;
     focus?: boolean;
     show?: boolean;
     dismissible?: boolean;
     children: React.ReactNode;
 }
-interface ToastState {
-    animationClass: string;
-    isolator?: AriaIsolate;
-}
 /**
  * The cauldron toast notification component
  */
-export default class Toast extends React.Component<ToastProps, ToastState> {
-    static defaultProps: {
-        dismissText: string;
-        onDismiss: () => void;
-        toastRef: () => void;
-        focus: boolean;
-        show: boolean;
-        dismissible: boolean;
-    };
-    static displayName: string;
-    private el;
-    constructor(props: ToastProps);
-    componentDidMount(): void;
-    componentDidUpdate(prevProps: ToastProps): void;
-    componentWillUnmount(): void;
-    render(): React.JSX.Element;
-    dismissToast(): void;
-    showToast(): void;
-}
-export {};
+declare const Toast: {
+    ({ type, children, onDismiss, dismissText, toastRef, focus, show, dismissible, className, ...otherProps }: ToastProps): React.JSX.Element;
+    displayName: string;
+};
+export default Toast;

package/lib/index.js

@@ -1532,9 +1532,9 @@ var isEscape = function (event) {
     return event.key === 'Escape' || event.key === 'Esc' || event.keyCode === 27;
 };
 var Dialog = React.forwardRef(function (_a, ref) {
-    var dialogRefProp = _a.dialogRef, _b = _a.forceAction, forceAction = _b === void 0 ? false : _b, className = _a.className, children = _a.children, _c = _a.closeButtonText, closeButtonText = _c === void 0 ? 'Close' : _c, heading = _a.heading, _d = _a.show, show = _d === void 0 ? false : _d, portal = _a.portal, _e = _a.onClose, onClose = _e === void 0 ? function () { return null; } : _e, other = tslib.__rest(_a, ["dialogRef", "forceAction", "className", "children", "closeButtonText", "heading", "show", "portal", "onClose"]);
+    var dialogRefProp = _a.dialogRef, _b = _a.forceAction, forceAction = _b === void 0 ? false : _b, className = _a.className, children = _a.children, _c = _a.closeButtonText, closeButtonText = _c === void 0 ? 'Close' : _c, heading = _a.heading, _d = _a.show, show = _d === void 0 ? false : _d, portal = _a.portal, _e = _a.scrollable, scrollable = _e === void 0 ? false : _e, _f = _a.onClose, onClose = _f === void 0 ? function () { return null; } : _f, other = tslib.__rest(_a, ["dialogRef", "forceAction", "className", "children", "closeButtonText", "heading", "show", "portal", "scrollable", "onClose"]);
     var dialogRef = useSharedRef(dialogRefProp || ref);
-    var _f = tslib.__read(nextId.useId(1, 'dialog-title-'), 1), headingId = _f[0];
+    var _g = tslib.__read(nextId.useId(1, 'dialog-title-'), 1), headingId = _g[0];
     var headingRef = React.useRef(null);
     var isolatorRef = React.useRef();
     var headingLevel = typeof heading === 'object' && 'level' in heading && heading.level
@@ -1605,14 +1605,16 @@ var Dialog = React.forwardRef(function (_a, ref) {
         headingLevel: headingLevel,
         onClose: handleClose,
         forceAction: forceAction,
-        closeButtonText: closeButtonText
+        closeButtonText: closeButtonText,
+        scrollable: scrollable
     }); }, [
         headingId,
         headingRef,
         headingLevel,
         handleClose,
         forceAction,
-        closeButtonText
+        closeButtonText,
+        scrollable
     ]);
     if (!show || !isBrowser()) {
         return null;
@@ -1642,11 +1644,12 @@ var Dialog = React.forwardRef(function (_a, ref) {
 Dialog.displayName = 'Dialog';
 var DialogContent = function (_a) {
     var children = _a.children, className = _a.className, align = _a.align, other = tslib.__rest(_a, ["children", "className", "align"]);
+    var context = React.useContext(DialogContext);
     return (React__default["default"].createElement("div", tslib.__assign({ className: classNames__default["default"]('Dialog__content', className, {
             'text--align-left': align === 'left',
             'text--align-center': align === 'center',
             'text--align-right': align === 'right'
-        }) }, other), children));
+        }), tabIndex: (context === null || context === void 0 ? void 0 : context.scrollable) ? -1 : undefined }, other), children));
 };
 DialogContent.displayName = 'DialogContent';
 var DialogFooter = function (_a) {
@@ -1700,10 +1703,11 @@ var AlertContent = DialogContent;
 var AlertActions = DialogFooter;
 
 var Modal = function (_a) {
-    var children = _a.children, className = _a.className, variant = _a.variant, other = tslib.__rest(_a, ["children", "className", "variant"]);
+    var children = _a.children, className = _a.className, variant = _a.variant, scrollable = _a.scrollable, other = tslib.__rest(_a, ["children", "className", "variant", "scrollable"]);
     return (React__default["default"].createElement(Dialog, tslib.__assign({ className: classNames__default["default"]('Modal', className, {
-            'Modal--info': variant === 'info'
-        }) }, other, { forceAction: false }), children));
+            'Modal--info': variant === 'info',
+            'Modal--scrollable': scrollable
+        }) }, other, { scrollable: scrollable, forceAction: false }), children));
 };
 var ModalHeader = DialogHeader;
 var ModalHeading = DialogHeading;
@@ -2209,126 +2213,110 @@ var tabIndexHandler = function (reset, toast) {
 };
 
 /**
- * The cauldron toast notification component
+ * Hook to be used similarly to the React.Component#componentDidMount.
+ * Executes the provided `effect` when `dependencies` change but does not
+ * execute the effect initially (on mount) - only on update.
+ *
+ * @param effect {Function} function to be executed when dependencies update
+ * @param dependencies {Any} any valid dependency argument to React.useEffect
  */
-var Toast = /** @class */ (function (_super) {
-    tslib.__extends(Toast, _super);
-    function Toast(props) {
-        var _this = _super.call(this, props) || this;
-        _this.state = {
-            animationClass: props.show ? 'FadeIn--flex' : 'is--hidden'
-        };
-        _this.dismissToast = _this.dismissToast.bind(_this);
-        _this.showToast = _this.showToast.bind(_this);
-        return _this;
-    }
-    Toast.prototype.componentDidMount = function () {
-        var show = this.props.show;
-        if (show) {
-            // Timeout because CSS display: none/block and opacity:
-            // 0/1 properties cannot be toggled in the same tick
-            // see: https://codepen.io/isnerms/pen/eyQaLP
-            setTimeout(this.showToast);
+var useDidUpdate = function (effect, dependencies) {
+    var mounted = React__default["default"].useRef(false);
+    React__default["default"].useEffect(function () {
+        if (!mounted.current) {
+            mounted.current = true;
+            return;
         }
+        effect();
+    }, dependencies);
+};
+
+/**
+ * The cauldron toast notification component
+ */
+var Toast = function (_a) {
+    var type = _a.type, children = _a.children, _b = _a.onDismiss, onDismiss = _b === void 0 ? function () {
+        // noop
+    } : _b, _c = _a.dismissText, dismissText = _c === void 0 ? 'Dismiss' : _c, toastRef = _a.toastRef, _d = _a.focus, focus = _d === void 0 ? true : _d, _e = _a.show, show = _e === void 0 ? false : _e, _f = _a.dismissible, dismissible = _f === void 0 ? true : _f, className = _a.className, otherProps = tslib.__rest(_a, ["type", "children", "onDismiss", "dismissText", "toastRef", "focus", "show", "dismissible", "className"]);
+    var elRef = useSharedRef(toastRef !== null && toastRef !== void 0 ? toastRef : null);
+    var isolatorRef = React.useRef(null);
+    var timeoutsRef = React.useRef(new Set());
+    var _g = tslib.__read(React.useState(show ? 'FadeIn--flex' : 'is--hidden'), 2), animationClass = _g[0], setAnimationClass = _g[1];
+    // Timeout because CSS display: none/block and opacity:
+    // 0/1 properties cannot be toggled in the same tick
+    // see: https://codepen.io/isnerms/pen/eyQaLP
+    var scheduleNextTick = function (fn) {
+        var id = setTimeout(function () {
+            timeoutsRef.current.delete(id);
+            fn();
+        });
+        timeoutsRef.current.add(id);
     };
-    Toast.prototype.componentDidUpdate = function (prevProps) {
-        var _this = this;
-        var show = this.props.show;
-        if (prevProps.show !== show) {
-            if (show) {
-                this.setState({ animationClass: 'FadeIn--flex' }, function () {
-                    setTimeout(_this.showToast);
-                });
-            }
-            else {
-                this.dismissToast();
-            }
+    var showToast = React.useCallback(function () {
+        setAnimationClass('FadeIn--flex FadeIn');
+        if (type === 'action-needed' && elRef.current) {
+            var isolator = new AriaIsolate(elRef.current);
+            tabIndexHandler(false, elRef.current);
+            isolatorRef.current = isolator;
+            isolator.activate();
         }
-    };
-    Toast.prototype.componentWillUnmount = function () {
-        var isolator = this.state.isolator;
-        isolator === null || isolator === void 0 ? void 0 : isolator.deactivate();
-    };
-    Toast.prototype.render = function () {
-        var _this = this;
-        var animationClass = this.state.animationClass;
-        var _a = this.props, type = _a.type, children = _a.children; 
-        // prevent `onDismiss` from being passed-through to DOM
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        _a.onDismiss; var dismissText = _a.dismissText, toastRef = _a.toastRef, focus = _a.focus, show = _a.show, dismissible = _a.dismissible, className = _a.className, otherProps = tslib.__rest(_a, ["type", "children", "onDismiss", "dismissText", "toastRef", "focus", "show", "dismissible", "className"]);
-        var scrim = type === 'action-needed' && show ? (React__default["default"].createElement("div", { className: "Scrim--light Scrim--show Scrim--fade-in" })) : null;
-        var defaultProps = {
-            tabIndex: -1,
-            className: classNames__default["default"]('Toast', "Toast--".concat(typeMap[type].className), animationClass, { 'Toast--non-dismissible': !dismissible }, className)
-        };
-        if (!focus) {
-            defaultProps.role = 'alert';
+        if (elRef.current && !!focus) {
+            elRef.current.focus();
         }
-        return (React__default["default"].createElement(React__default["default"].Fragment, null,
-            React__default["default"].createElement("div", tslib.__assign({ ref: function (el) {
-                    _this.el = el;
-                    setRef(toastRef, el);
-                } }, defaultProps, otherProps),
-                React__default["default"].createElement("div", { className: "Toast__message" },
-                    React__default["default"].createElement(Icon, { type: typeMap[type].icon }),
-                    React__default["default"].createElement("div", { className: "Toast__message-content" }, children)),
-                type !== 'action-needed' && dismissible && (React__default["default"].createElement("button", { type: "button", className: 'Toast__dismiss', "aria-label": dismissText, onClick: this.dismissToast },
-                    React__default["default"].createElement(Icon, { type: "close" })))),
-            scrim));
-    };
-    Toast.prototype.dismissToast = function () {
-        var _this = this;
-        if (!this.el) {
+    }, [type, focus]);
+    var dismissToast = React.useCallback(function () {
+        if (!elRef.current) {
             return;
         }
-        var _a = this.props, onDismiss = _a.onDismiss, type = _a.type;
-        var isolator = this.state.isolator;
-        this.setState({
-            animationClass: 'FadeIn--flex'
-        }, function () {
-            // Timeout because CSS display: none/block and opacity:
-            // 0/1 properties cannot be toggled in the same tick
-            // see: https://codepen.io/isnerms/pen/eyQaLP
-            setTimeout(function () {
-                if (type === 'action-needed') {
-                    tabIndexHandler(true, _this.el);
-                    isolator === null || isolator === void 0 ? void 0 : isolator.deactivate();
-                }
-                _this.setState({ animationClass: 'is--hidden' }, onDismiss);
-            });
-        });
-    };
-    Toast.prototype.showToast = function () {
-        var _this = this;
-        var _a = this.props, type = _a.type, focus = _a.focus;
-        this.setState({
-            animationClass: 'FadeIn--flex FadeIn'
-        }, function () {
+        setAnimationClass('FadeIn--flex');
+        scheduleNextTick(function () {
+            var _a;
             if (type === 'action-needed') {
-                var isolator = new AriaIsolate(_this.el);
-                tabIndexHandler(false, _this.el);
-                _this.setState({ isolator: isolator });
-                isolator.activate();
-            }
-            if (_this.el && !!focus) {
-                // focus the toast
-                _this.el.focus();
+                tabIndexHandler(true, elRef.current);
+                (_a = isolatorRef.current) === null || _a === void 0 ? void 0 : _a.deactivate();
             }
+            setAnimationClass('is--hidden');
+            onDismiss();
         });
+    }, [type, onDismiss]);
+    React.useEffect(function () {
+        if (show) {
+            scheduleNextTick(showToast);
+        }
+        return function () {
+            var _a;
+            timeoutsRef.current.forEach(clearTimeout);
+            timeoutsRef.current.clear();
+            (_a = isolatorRef.current) === null || _a === void 0 ? void 0 : _a.deactivate();
+        };
+    }, []);
+    useDidUpdate(function () {
+        if (show) {
+            setAnimationClass('FadeIn--flex');
+            scheduleNextTick(showToast);
+        }
+        else {
+            dismissToast();
+        }
+    }, [show]);
+    var scrim = type === 'action-needed' && show ? (React__default["default"].createElement("div", { className: "Scrim--light Scrim--show Scrim--fade-in" })) : null;
+    var defaultProps = {
+        tabIndex: -1,
+        className: classNames__default["default"]('Toast', "Toast--".concat(typeMap[type].className), animationClass, { 'Toast--non-dismissible': !dismissible }, className)
     };
-    Toast.defaultProps = {
-        dismissText: 'Dismiss',
-        // eslint-disable-next-line @typescript-eslint/no-empty-function
-        onDismiss: function () { },
-        // eslint-disable-next-line @typescript-eslint/no-empty-function
-        toastRef: function () { },
-        focus: true,
-        show: false,
-        dismissible: true
-    };
-    Toast.displayName = 'Toast';
-    return Toast;
-}(React__default["default"].Component));
+    if (!focus) {
+        defaultProps.role = 'alert';
+    }
+    return (React__default["default"].createElement(React__default["default"].Fragment, null,
+        React__default["default"].createElement("div", tslib.__assign({ ref: elRef }, defaultProps, otherProps),
+            React__default["default"].createElement("div", { className: "Toast__message" },
+                React__default["default"].createElement(Icon, { type: typeMap[type].icon }),
+                React__default["default"].createElement("div", { className: "Toast__message-content" }, children)),
+            type !== 'action-needed' && dismissible && (React__default["default"].createElement("button", { type: "button", className: "Toast__dismiss", "aria-label": dismissText, onClick: dismissToast },
+                React__default["default"].createElement(Icon, { type: "close" })))),
+        scrim));
+};
+Toast.displayName = 'Toast';
 
 var Link = React.forwardRef(function (_a, ref) {
     var children = _a.children, linkRef = _a.linkRef, className = _a.className, variant = _a.variant, thin = _a.thin, other = tslib.__rest(_a, ["children", "linkRef", "className", "variant", "thin"]);
@@ -3227,25 +3215,6 @@ var Tab = React__default["default"].forwardRef(function (_a, ref) {
 });
 Tab.displayName = 'Tab';
 
-/**
- * Hook to be used similarly to the React.Component#componentDidMount.
- * Executes the provided `effect` when `dependencies` change but does not
- * execute the effect initially (on mount) - only on update.
- *
- * @param effect {Function} function to be executed when dependencies update
- * @param dependencies {Any} any valid dependency argument to React.useEffect
- */
-var useDidUpdate = function (effect, dependencies) {
-    var mounted = React__default["default"].useRef(false);
-    React__default["default"].useEffect(function () {
-        if (!mounted.current) {
-            mounted.current = true;
-            return;
-        }
-        effect();
-    }, dependencies);
-};
-
 var Tabs = function (_a) {
     var children = _a.children, thin = _a.thin, _b = _a.orientation, orientation = _b === void 0 ? 'horizontal' : _b, _c = _a.initialActiveIndex, initialActiveIndex = _c === void 0 ? 0 : _c, className = _a.className, onChange = _a.onChange, labelProp = tslib.__rest(_a, ["children", "thin", "orientation", "initialActiveIndex", "className", "onChange"]);
     var _d = tslib.__read(React.useState(initialActiveIndex), 2), activeIndex = _d[0], setActiveIndex = _d[1];
@@ -4602,16 +4571,6 @@ var Combobox = React.forwardRef(function (_a, ref) {
                 : ComboboxNoResults;
     }, [renderNoResults]);
     var noMatchingOptions = !!inputValue && !matchingOptions.size && (React__default["default"].createElement(NoMatchingOptions, null));
-    var comboboxListbox = (
-    // eslint-disable-next-line
-    // @ts-expect-error
-    // multiselect & value props are passed to Listbox, but TS is unable to infer that
-    // it's a correct mapping from Combobox's multiselect & value props
-    React__default["default"].createElement(Listbox, { className: classNames__default["default"]('Combobox__listbox', {
-            'Combobox__listbox--open': open
-        }), role: noMatchingOptions ? 'presentation' : 'listbox', "aria-labelledby": noMatchingOptions ? undefined : "".concat(id, "-label"), id: "".concat(id, "-listbox"), value: multiselect ? selectedValues : selectedValues[0], onMouseDown: handleComboboxOptionMouseDown, onClick: handleComboboxOptionClick, onSelectionChange: handleSelectionChange, onActiveChange: handleActiveChange, ref: listboxRef, tabIndex: noMatchingOptions ? undefined : -1, "aria-activedescendant": undefined, multiselect: multiselect, disabled: disabled },
-        comboboxOptions,
-        noMatchingOptions));
     var errorId = "".concat(id, "-error");
     var descriptionId = "".concat(id, "-description");
     var describedby = ariaDescribedby;
@@ -4622,6 +4581,16 @@ var Combobox = React.forwardRef(function (_a, ref) {
         describedby = addIdRef(describedby, errorId);
     }
     var inputProps = tslib.__assign(tslib.__assign({}, props), { 'aria-describedby': describedby });
+    var comboboxListbox = (
+    // eslint-disable-next-line
+    // @ts-expect-error
+    // multiselect & value props are passed to Listbox, but TS is unable to infer that
+    // it's a correct mapping from Combobox's multiselect & value props
+    React__default["default"].createElement(Listbox, { className: classNames__default["default"]('Combobox__listbox', {
+            'Combobox__listbox--open': open
+        }), role: noMatchingOptions ? 'presentation' : 'listbox', "aria-labelledby": noMatchingOptions ? undefined : "".concat(id, "-label"), "aria-describedby": describedby, id: "".concat(id, "-listbox"), value: multiselect ? selectedValues : selectedValues[0], onMouseDown: handleComboboxOptionMouseDown, onClick: handleComboboxOptionClick, onSelectionChange: handleSelectionChange, onActiveChange: handleActiveChange, ref: listboxRef, tabIndex: noMatchingOptions ? undefined : -1, "aria-activedescendant": undefined, multiselect: multiselect, disabled: disabled },
+        comboboxOptions,
+        noMatchingOptions));
     return (React__default["default"].createElement("div", { id: id, className: classNames__default["default"]('Combobox', { 'Combobox--multiselect': multiselect }, className), ref: comboboxRef },
         name &&
             formValues.map(function (formValue, index) { return (React__default["default"].createElement("input", { type: "hidden", key: index, name: name, value: formValue })); }),
@@ -4654,7 +4623,7 @@ var Combobox = React.forwardRef(function (_a, ref) {
                     };
                     return (React__default["default"].createElement(ComboboxPill, { ref: refCallback, key: value, value: value, removeOptionLabel: removeOptionLabels[index], disabled: disabled, onClick: handleClick, onKeyDown: handlePillKeyDown }));
                 }),
-            React__default["default"].createElement("input", tslib.__assign({ type: "text", id: "".concat(id, "-input"), ref: inputRef, value: inputValue, role: "combobox", disabled: disabled, "aria-autocomplete": !isAutoComplete ? 'none' : 'list', "aria-controls": "".concat(id, "-listbox"), "aria-expanded": open, "aria-haspopup": "listbox", "aria-activedescendant": open && activeDescendant ? activeDescendant.element.id : undefined }, inputProps, { onChange: handleChange, onKeyDown: handleKeyDown, onFocus: handleFocus, onBlur: handleBlur })),
+            React__default["default"].createElement("input", tslib.__assign({ type: "text", id: "".concat(id, "-input"), ref: inputRef, value: inputValue, role: "combobox", disabled: disabled, "aria-invalid": error ? true : undefined, "aria-autocomplete": !isAutoComplete ? 'none' : 'list', "aria-controls": "".concat(id, "-listbox"), "aria-expanded": open, "aria-haspopup": "listbox", "aria-activedescendant": open && activeDescendant ? activeDescendant.element.id : undefined }, inputProps, { onChange: handleChange, onKeyDown: handleKeyDown, onFocus: handleFocus, onBlur: handleBlur })),
             React__default["default"].createElement("span", { className: "Combobox__arrow" })),
         React__default["default"].createElement(ComboboxProvider, { autocomplete: autocomplete, inputValue: inputValue, formValues: formValues, selectedValues: selectedValues, removeOptionLabels: removeOptionLabels, setRemoveOptionLabels: setRemoveOptionLabels, matches: !isAutoComplete || defaultAutoCompleteMatches, matchingOptions: matchingOptions, setMatchingOptions: setMatchingOptions, setFormValues: setFormValues }, portal && typeof document !== 'undefined'
             ? reactDom.createPortal(comboboxListbox, 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deque/cauldron-react",
-  "version": "6.27.0-canary.7fd2f1e5",
+  "version": "6.27.0-canary.90942368",
   "license": "MPL-2.0",
   "description": "Fully accessible react components library for Deque Cauldron",
   "homepage": "https://cauldron.dequelabs.com/",