@deque/cauldron-react 3.0.1-canary.03388cec → 3.0.1-canary.41ff0487

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

@@ -0,0 +1,38 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+interface AddressProps extends React.HTMLAttributes<HTMLElement> {
+    children: React.ReactNode;
+}
+export declare const Address: {
+    ({ children, className, ...other }: AddressProps): JSX.Element;
+    displayName: string;
+    propTypes: {
+        children: PropTypes.Validator<string | number | boolean | {} | PropTypes.ReactElementLike | PropTypes.ReactNodeArray>;
+        className: PropTypes.Requireable<string>;
+    };
+};
+declare type AddressLineProps = React.HTMLAttributes<HTMLElement>;
+export declare const AddressLine: {
+    ({ children, className, ...other }: AddressLineProps): JSX.Element | null;
+    displayName: string;
+    propTypes: {
+        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        className: PropTypes.Requireable<string>;
+    };
+};
+interface AddressCityStateZipProps extends React.HTMLAttributes<HTMLElement> {
+    city: React.ReactNode;
+    state: React.ReactNode;
+    zip: React.ReactNode;
+}
+export declare const AddressCityStateZip: {
+    ({ city, state, zip, className, ...other }: AddressCityStateZipProps): JSX.Element | null;
+    displayName: string;
+    propTypes: {
+        city: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        state: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        zip: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        className: PropTypes.Requireable<string>;
+    };
+};
+export {};

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

@@ -1,7 +1,7 @@
-import React from 'react';
+import * as Polymorphic from '../../utils/polymorphic-type';
 import { IconType } from '../Icon';
 import { TooltipProps } from '../Tooltip';
-export interface IconButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
+export interface IconButtonOwnProps {
     icon: IconType;
     label: string;
     tooltipPlacement?: TooltipProps['placement'];
@@ -9,5 +9,12 @@ export interface IconButtonProps extends React.ButtonHTMLAttributes<HTMLButtonEl
     tooltipPortal?: TooltipProps['portal'];
     variant?: 'primary' | 'secondary' | 'error';
 }
-declare const IconButton: React.ForwardRefExoticComponent<IconButtonProps & React.RefAttributes<HTMLButtonElement>>;
+declare type PolymorphicIconButton = Polymorphic.ForwardRefComponent<'button', IconButtonOwnProps>;
+/**
+ * Unfortunately, eslint does not recognize that this Polymorphic component has a displayName set
+ *
+ * We might be able to remove this if we upgrade eslint and associated plugins
+ * See: https://github.com/dequelabs/cauldron/issues/451
+ */
+declare const IconButton: PolymorphicIconButton;
 export default IconButton;

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

@@ -5,7 +5,7 @@ declare const Panel: {
     ({ className, title, actions, children }: {
         className?: string | undefined;
         title?: string | undefined;
-        actions?: React.ForwardRefExoticComponent<import("../IconButton").IconButtonProps & React.RefAttributes<HTMLButtonElement>>[] | undefined;
+        actions?: import("../../utils/polymorphic-type").ForwardRefComponent<"button", import("../IconButton").IconButtonOwnProps>[] | undefined;
         children: React.ReactNode;
     }): JSX.Element;
     displayName: string;

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

@@ -9,6 +9,7 @@ interface StepWithChildren extends BaseStepProps {
 }
 interface StepWithTooltip extends BaseStepProps {
     tooltip: React.ReactNode;
+    tooltipText: string;
 }
 declare type StepProps = StepWithChildren | StepWithTooltip;
 export declare const Step: {
@@ -17,6 +18,7 @@ export declare const Step: {
     propTypes: {
         children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
         tooltip: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        tooltipText: PropTypes.Requireable<string>;
         className: PropTypes.Requireable<string>;
     };
 };

package/lib/components/Table/TableCell.d.ts

@@ -1,6 +1,6 @@
-import React from 'react';
+import React, { TdHTMLAttributes } from 'react';
 import PropTypes from 'prop-types';
-interface TableCellProps {
+interface TableCellProps extends TdHTMLAttributes<HTMLTableCellElement> {
     children: React.ReactNode;
     className?: string;
 }

package/lib/components/Table/TableHeader.d.ts

@@ -1,6 +1,6 @@
-import React from 'react';
+import React, { ThHTMLAttributes } from 'react';
 import PropTypes from 'prop-types';
-interface TableHeaderProps {
+interface TableHeaderProps extends ThHTMLAttributes<HTMLTableCellElement> {
     children: React.ReactNode;
     className?: string;
 }

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

@@ -11,7 +11,7 @@ export interface TooltipProps extends React.HTMLAttributes<HTMLDivElement> {
     portal?: React.RefObject<HTMLElement> | HTMLElement;
     hideElementOnHidden?: boolean;
 }
-declare function Tooltip({ id: propId, placement: initialPlacement, children, portal, target, association, variant, show: showProp, hideElementOnHidden, ...props }: TooltipProps): React.ReactPortal | null;
+declare function Tooltip({ id: propId, placement: initialPlacement, children, portal, target, association, variant, show: showProp, hideElementOnHidden, className, ...props }: TooltipProps): React.ReactPortal | null;
 declare namespace Tooltip {
     var displayName: string;
     var propTypes: {

package/lib/index.d.ts

@@ -43,6 +43,7 @@ export { DescriptionList, DescriptionListItem, DescriptionTerm, DescriptionDetai
 export { default as Stepper, Step } from './components/Stepper';
 export { default as Panel } from './components/Panel';
 export { default as ProgressBar } from './components/ProgressBar';
+export { Address, AddressLine, AddressCityStateZip } from './components/Address';
 /**
  * Helpers / Utils
  */

package/lib/index.js

@@ -1467,7 +1467,7 @@ var fireCustomEvent = function (show, button) {
 };
 function Tooltip(_a) {
     var _this = this;
-    var propId = _a.id, _b = _a.placement, initialPlacement = _b === void 0 ? 'auto' : _b, children = _a.children, portal = _a.portal, target = _a.target, _c = _a.association, association = _c === void 0 ? 'aria-describedby' : _c, _d = _a.variant, variant = _d === void 0 ? 'text' : _d, _e = _a.show, showProp = _e === void 0 ? false : _e, _f = _a.hideElementOnHidden, hideElementOnHidden = _f === void 0 ? false : _f, props = tslib.__rest(_a, ["id", "placement", "children", "portal", "target", "association", "variant", "show", "hideElementOnHidden"]);
+    var propId = _a.id, _b = _a.placement, initialPlacement = _b === void 0 ? 'auto' : _b, children = _a.children, portal = _a.portal, target = _a.target, _c = _a.association, association = _c === void 0 ? 'aria-describedby' : _c, _d = _a.variant, variant = _d === void 0 ? 'text' : _d, _e = _a.show, showProp = _e === void 0 ? false : _e, _f = _a.hideElementOnHidden, hideElementOnHidden = _f === void 0 ? false : _f, className = _a.className, props = tslib.__rest(_a, ["id", "placement", "children", "portal", "target", "association", "variant", "show", "hideElementOnHidden", "className"]);
     var id = (propId ? [propId] : nextId.useId(1, 'tooltip'))[0];
     var hovering = React.useRef(false);
     var _g = React.useState(initialPlacement), placement = _g[0], setPlacement = _g[1];
@@ -1588,7 +1588,7 @@ function Tooltip(_a) {
         }
     }, [targetElement, id]);
     return showTooltip || hideElementOnHidden
-        ? reactDom.createPortal(React__default.createElement("div", tslib.__assign({ id: id, className: classNames('Tooltip', "Tooltip--" + placement, {
+        ? reactDom.createPortal(React__default.createElement("div", tslib.__assign({ id: id, className: classNames('Tooltip', "Tooltip--" + placement, className, {
                 TooltipInfo: variant === 'info',
                 'Tooltip--hidden': !showTooltip && hideElementOnHidden,
                 'Tooltip--big': variant === 'big'
@@ -1617,21 +1617,45 @@ var TooltipContent = function (_a) {
     return (React__default.createElement("div", tslib.__assign({ className: classNames('TooltipContent', className) }, other)));
 };
 
+/**
+ * Unfortunately, eslint does not recognize that this Polymorphic component has a displayName set
+ *
+ * We might be able to remove this if we upgrade eslint and associated plugins
+ * See: https://github.com/dequelabs/cauldron/issues/451
+ */
+// eslint-disable-next-line react/display-name
 var IconButton = React.forwardRef(function (_a, ref) {
-    var icon = _a.icon, label = _a.label, _b = _a.tooltipPlacement, tooltipPlacement = _b === void 0 ? 'auto' : _b, tooltipVariant = _a.tooltipVariant, tooltipPortal = _a.tooltipPortal, className = _a.className, _c = _a.variant, variant = _c === void 0 ? 'secondary' : _c, disabled = _a.disabled, other = tslib.__rest(_a, ["icon", "label", "tooltipPlacement", "tooltipVariant", "tooltipPortal", "className", "variant", "disabled"]);
-    var buttonRef = React.useRef();
-    React.useImperativeHandle(ref, function () { return buttonRef.current; });
+    var _b = _a.as, Component = _b === void 0 ? 'button' : _b, icon = _a.icon, label = _a.label, _c = _a.tooltipPlacement, tooltipPlacement = _c === void 0 ? 'auto' : _c, tooltipVariant = _a.tooltipVariant, tooltipPortal = _a.tooltipPortal, className = _a.className, _d = _a.variant, variant = _d === void 0 ? 'secondary' : _d, disabled = _a.disabled, _e = _a.tabIndex, tabIndex = _e === void 0 ? 0 : _e, other = tslib.__rest(_a, ["as", "icon", "label", "tooltipPlacement", "tooltipVariant", "tooltipPortal", "className", "variant", "disabled", "tabIndex"]);
+    var internalRef = React.useRef();
+    React.useImperativeHandle(ref, function () { return internalRef.current; });
+    // Configure additional properties based on the type of the Component
+    // for accessibility
+    var accessibilityProps = {};
+    if (Component === 'button') {
+        accessibilityProps.type = 'button';
+    }
+    else {
+        // We don't need to set an anchor's role, since it would be redundant
+        if (Component !== 'a') {
+            accessibilityProps.role = other.href || other.to ? 'link' : 'button';
+        }
+        if (disabled) {
+            accessibilityProps['aria-disabled'] = disabled;
+        }
+    }
     return (React__default.createElement(React__default.Fragment, null,
-        React__default.createElement("button", tslib.__assign({ type: 'button', className: classNames(className, {
+        React__default.createElement(Component, tslib.__assign({ className: classNames(className, {
                 IconButton: true,
                 'IconButton--primary': variant === 'primary',
                 'IconButton--secondary': variant === 'secondary',
                 'IconButton--error': variant === 'error'
-            }), ref: buttonRef, disabled: disabled }, other),
+            }), ref: internalRef, disabled: disabled, tabIndex: disabled ? -1 : tabIndex }, accessibilityProps, other),
             React__default.createElement(Icon, { type: icon })),
-        !disabled && (React__default.createElement(Tooltip, { target: buttonRef, placement: tooltipPlacement, variant: tooltipVariant, portal: tooltipPortal, association: "aria-labelledby", hideElementOnHidden: true }, label))));
+        !disabled && (React__default.createElement(Tooltip, { target: internalRef, placement: tooltipPlacement, variant: tooltipVariant, portal: tooltipPortal, association: "aria-labelledby", hideElementOnHidden: true }, label))));
 });
 IconButton.propTypes = {
+    // @ts-expect-error
+    as: PropTypes.elementType,
     // @ts-expect-error
     icon: PropTypes.string.isRequired,
     label: PropTypes.string.isRequired,
@@ -2249,7 +2273,7 @@ var Select = React__default.forwardRef(function (_a, ref) {
             })
                 : children),
             React__default.createElement("div", { className: "arrow-down" })),
-        React__default.createElement("div", { className: "Error", id: errorId }, error)));
+        error && (React__default.createElement("div", { id: errorId, className: "Error" }, error))));
     /* eslint-disable jsx-a11y/no-onchange */
 });
 Select.displayName = 'Select';
@@ -2296,13 +2320,13 @@ var RadioGroup = function (_a) {
                     handleChange(radioValue);
                     onChange(radio, (_a = inputs.current) === null || _a === void 0 ? void 0 : _a[index]);
                 }, disabled: disabled, checked: isChecked }, other)),
+            React__default.createElement("label", { htmlFor: id, className: classNames('Field__label', {
+                    'Field__label--disabled': disabled
+                }) }, label),
             React__default.createElement(Icon, { className: classNames('Radio__overlay', {
                     'Radio__overlay--focused': isFocused,
                     'Radio__overlay--disabled': disabled
-                }), type: isChecked ? 'radio-checked' : 'radio-unchecked', "aria-hidden": "true", onClick: function () { return onRadioClick(index); } }),
-            React__default.createElement("label", { htmlFor: id, className: classNames('Field__label', {
-                    'Field__label--disabled': disabled
-                }) }, label)));
+                }), type: isChecked ? 'radio-checked' : 'radio-unchecked', "aria-hidden": "true", onClick: function () { return onRadioClick(index); } })));
     });
     // reset the input refs array
     // refs get clobbered every re-render anyway and this supports "dynamic" radios
@@ -2352,6 +2376,9 @@ var Checkbox = React.forwardRef(function (_a, ref) {
                         onChange(e);
                     }
                 } }, other)),
+            React__default.createElement("label", { className: classNames('Field__label', {
+                    'Field__label--disabled': disabled
+                }), htmlFor: id }, label),
             React__default.createElement(Icon, { className: classNames('Checkbox__overlay', {
                     'Checkbox__overlay--disabled': disabled,
                     'Checkbox__overlay--focused': focused,
@@ -2364,11 +2391,8 @@ var Checkbox = React.forwardRef(function (_a, ref) {
                     else {
                         (_b = checkRef.current) === null || _b === void 0 ? void 0 : _b.click();
                     }
-                } }),
-            React__default.createElement("label", { className: classNames('Field__label', {
-                    'Field__label--disabled': disabled
-                }), htmlFor: id }, label)),
-        React__default.createElement("div", { id: errorId, className: "Error" }, error)));
+                } })),
+        error && (React__default.createElement("div", { id: errorId, className: "Error" }, error))));
 });
 Checkbox.displayName = 'Checkbox';
 
@@ -2475,7 +2499,7 @@ var TextField = /** @class */ (function (_super) {
                     _this.input = input;
                     setRef(fieldRef, input);
                 } }, other, inputProps)),
-            React__default.createElement("div", { className: "Error", id: this.errorId }, error)));
+            error && (React__default.createElement("div", { className: "Error", id: this.errorId }, error))));
     };
     TextField.prototype.onChange = function (e) {
         var _a, _b;
@@ -8162,7 +8186,7 @@ var Step = function (props) {
             // list items, therefore it is safe to clobber
             // it with the contents of the tooltip in the
             // tab stop's accessible name.
-            association: "aria-labelledby" },
+            association: "aria-labelledby", "aria-label": isTooltip(props) ? props.tooltipText : undefined },
             React__default.createElement("div", { className: "Stepper__step-indicator" }))) : (React__default.createElement(React__default.Fragment, null,
             React__default.createElement("div", { className: "Stepper__step-indicator" }),
             'children' in props && (React__default.createElement("div", { className: "Stepper__step-label" }, props.children)))))));
@@ -8171,6 +8195,7 @@ Step.displayName = 'Step';
 Step.propTypes = {
     children: PropTypes.node,
     tooltip: PropTypes.node,
+    tooltipText: PropTypes.string,
     className: PropTypes.string
 };
 var Stepper = function (_a) {
@@ -8205,6 +8230,38 @@ var ProgressBar = React.forwardRef(function (_a, ref) {
 });
 ProgressBar.displayName = 'ProgressBar';
 
+var Address = function (_a) {
+    var children = _a.children, className = _a.className, other = tslib.__rest(_a, ["children", "className"]);
+    return (React__default.createElement("address", tslib.__assign({ className: classNames('Address', className) }, other), children));
+};
+Address.displayName = 'Address';
+Address.propTypes = {
+    children: PropTypes.node.isRequired,
+    className: PropTypes.string
+};
+var AddressLine = function (_a) {
+    var children = _a.children, className = _a.className, other = tslib.__rest(_a, ["children", "className"]);
+    return children ? (React__default.createElement("div", tslib.__assign({ className: classNames('Address__line', className) }, other), children)) : null;
+};
+AddressLine.displayName = 'AddressLine';
+AddressLine.propTypes = {
+    children: PropTypes.node,
+    className: PropTypes.string
+};
+var AddressCityStateZip = function (_a) {
+    var city = _a.city, state = _a.state, zip = _a.zip, className = _a.className, other = tslib.__rest(_a, ["city", "state", "zip", "className"]);
+    return city || state || zip ? (React__default.createElement("div", tslib.__assign({ className: classNames('Address__city-state-zip', className) }, other), [[city, state].filter(Boolean).join(', '), zip]
+        .filter(Boolean)
+        .join(' '))) : null;
+};
+AddressCityStateZip.displayName = 'AddressCityStateZip';
+AddressCityStateZip.propTypes = {
+    city: PropTypes.node,
+    state: PropTypes.node,
+    zip: PropTypes.node,
+    className: PropTypes.string
+};
+
 /**
  * Hook to be used similarly to the React.Component#componentDidMount.
  * Executes the provided `effect` when `dependencies` change but does not
@@ -8273,6 +8330,9 @@ ThemeProvider.propTypes = {
     initialTheme: PropTypes.string
 };
 
+exports.Address = Address;
+exports.AddressCityStateZip = AddressCityStateZip;
+exports.AddressLine = AddressLine;
 exports.Alert = Alert;
 exports.AlertActions = AlertActions;
 exports.AlertContent = AlertContent;

package/lib/utils/polymorphic-type/index.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Based on @radix-ui/polymorphic:
+ * https://github.com/radix-ui/primitives/blob/main/packages/react/polymorphic/src/polymorphic.ts
+ */
+import * as React from 'react';
+declare type Merge<P1 = {}, P2 = {}> = Omit<P1, keyof P2> & P2;
+/**
+ * Infers the OwnProps if E is a ForwardRefExoticComponentWithAs
+ */
+declare type OwnProps<E> = E extends ForwardRefComponent<any, infer P> ? P : {};
+/**
+ * Infers the JSX.IntrinsicElement if E is a ForwardRefExoticComponentWithAs
+ */
+declare type IntrinsicElement<E> = E extends ForwardRefComponent<infer I, any> ? I : never;
+declare type ForwardRefExoticComponent<E, OwnProps> = React.ForwardRefExoticComponent<Merge<E extends React.ElementType ? React.ComponentPropsWithRef<E> : never, OwnProps & {
+    as?: E;
+}>>;
+interface ForwardRefComponent<IntrinsicElementString, OwnProps = {}
+/**
+ * Extends original type to ensure built in React types play nice
+ * with polymorphic components still e.g. `React.ElementRef` etc.
+ */
+> extends ForwardRefExoticComponent<IntrinsicElementString, OwnProps> {
+    /**
+     * When `as` prop is passed, use this overload.
+     * Merges original own props (without DOM props) and the inferred props
+     * from `as` element with the own props taking precendence.
+     *
+     * We explicitly avoid `React.ElementType` and manually narrow the prop types
+     * so that events are typed when using JSX.IntrinsicElements.
+     */
+    <As = IntrinsicElementString>(props: As extends '' ? {
+        as: keyof JSX.IntrinsicElements;
+    } : As extends React.ComponentType<infer P> ? Merge<P, OwnProps & {
+        as: As;
+    }> : As extends keyof JSX.IntrinsicElements ? Merge<JSX.IntrinsicElements[As], OwnProps & {
+        as: As;
+    }> : never): React.ReactElement | null;
+}
+export { ForwardRefComponent, OwnProps, IntrinsicElement, Merge };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deque/cauldron-react",
-  "version": "3.0.1-canary.03388cec",
+  "version": "3.0.1-canary.41ff0487",
   "description": "Fully accessible react components library for Deque Cauldron",
   "publishConfig": {
     "access": "public"