@deque/cauldron-react 6.2.1-canary.fca8b9e6 → 6.3.0-canary.2fa4aa02

package/lib/components/Breadcrumb/BreadcrumbLink.d.ts

@@ -1,6 +1,5 @@
 import React from 'react';
-interface BreadcrumbLinkProps extends Omit<React.LinkHTMLAttributes<HTMLLinkElement>, 'as'> {
-    as?: React.ElementType;
-}
-declare const BreadcrumbLink: React.ForwardRefExoticComponent<BreadcrumbLinkProps & React.RefAttributes<HTMLElement>>;
+import type { PolymorphicProps, PolymorphicComponent } from '../../utils/polymorphicComponent';
+type BreadcrumbLinkProps = PolymorphicProps<React.LinkHTMLAttributes<HTMLLinkElement>>;
+declare const BreadcrumbLink: PolymorphicComponent<BreadcrumbLinkProps>;
 export default BreadcrumbLink;

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

@@ -1,7 +1,7 @@
 import React from 'react';
-interface Props extends React.HTMLAttributes<HTMLElement> {
+import type { PolymorphicComponent, PolymorphicProps } from '../../utils/polymorphicComponent';
+interface FieldWrapProps extends PolymorphicProps<React.HTMLAttributes<HTMLElement>> {
     children: React.ReactNode;
-    as?: React.ElementType | string;
 }
-declare const FieldWrap: React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLElement>>;
+declare const FieldWrap: PolymorphicComponent<FieldWrapProps>;
 export default FieldWrap;

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

@@ -1,14 +1,8 @@
-/**
- * Unfortunately, eslint does not recognize the Polymorphic component has propTypes set
- *
- * We might be able to remove this if we upgrade eslint and associated plugins
- * See: https://github.com/dequelabs/cauldron/issues/451
- */
 import React from 'react';
-import * as Polymorphic from '../../utils/polymorphic-type';
 import { IconType } from '../Icon';
 import { TooltipProps } from '../Tooltip';
-export interface IconButtonOwnProps {
+import { PolymorphicProps, PolymorphicComponent } from '../../utils/polymorphicComponent';
+export interface IconButtonProps extends PolymorphicProps<React.HTMLAttributes<HTMLButtonElement>, 'button'> {
     icon: IconType;
     label: React.ReactNode;
     tooltipPlacement?: TooltipProps['placement'];
@@ -17,12 +11,5 @@ export interface IconButtonOwnProps {
     variant?: 'primary' | 'secondary' | 'error';
     large?: boolean;
 }
-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;
+declare const IconButton: PolymorphicComponent<IconButtonProps, "button">;
 export default IconButton;

package/lib/components/Listbox/Listbox.d.ts

@@ -1,8 +1,8 @@
 import React from 'react';
 import type { ListboxOption } from './ListboxContext';
 import type { ListboxValue } from './ListboxOption';
-interface ListboxProps extends Omit<React.HTMLAttributes<HTMLElement>, 'onSelect'> {
-    as?: React.ElementType | string;
+import type { PolymorphicProps, PolymorphicComponent } from '../../utils/polymorphicComponent';
+interface ListboxProps extends PolymorphicProps<Omit<React.HTMLAttributes<HTMLElement>, 'onSelect'>> {
     value?: ListboxValue;
     navigation?: 'cycle' | 'bound';
     onSelectionChange?: <T extends HTMLElement = HTMLElement>({ value }: {
@@ -12,5 +12,5 @@ interface ListboxProps extends Omit<React.HTMLAttributes<HTMLElement>, 'onSelect
     }) => void;
     onActiveChange?: (option: ListboxOption) => void;
 }
-declare const Listbox: React.ForwardRefExoticComponent<ListboxProps & React.RefAttributes<HTMLElement>>;
+declare const Listbox: PolymorphicComponent<ListboxProps>;
 export default Listbox;

package/lib/components/Listbox/ListboxGroup.d.ts

@@ -1,9 +1,9 @@
 import { ContentNode } from '../../types';
 import React from 'react';
-interface ListboxGroupProps extends React.HTMLAttributes<HTMLElement> {
-    as?: React.ElementType | string;
+import type { PolymorphicProps, PolymorphicComponent } from '../../utils/polymorphicComponent';
+interface ListboxGroupProps extends PolymorphicProps<React.HTMLAttributes<HTMLElement>> {
     groupLabelProps?: React.HTMLAttributes<HTMLLIElement>;
     label: ContentNode;
 }
-declare const ListboxGroup: React.ForwardRefExoticComponent<ListboxGroupProps & React.RefAttributes<HTMLElement>>;
+declare const ListboxGroup: PolymorphicComponent<ListboxGroupProps>;
 export default ListboxGroup;

package/lib/components/Listbox/ListboxOption.d.ts

@@ -1,10 +1,10 @@
 import React from 'react';
+import type { PolymorphicProps, PolymorphicComponent } from '../../utils/polymorphicComponent';
 export type ListboxValue = Readonly<string | number | undefined>;
-interface ListboxOptionsProps extends React.HTMLAttributes<HTMLElement> {
-    as?: React.ElementType | string;
+interface ListboxOptionProps extends PolymorphicProps<React.HTMLAttributes<HTMLElement>> {
     value?: ListboxValue;
     disabled?: boolean;
     activeClass?: string;
 }
-declare const ListboxOption: React.ForwardRefExoticComponent<ListboxOptionsProps & React.RefAttributes<HTMLElement>>;
+declare const ListboxOption: PolymorphicComponent<ListboxOptionProps>;
 export default ListboxOption;

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

@@ -0,0 +1,11 @@
+import React from 'react';
+import { type TooltipProps } from '../Tooltip';
+import type { PolymorphicProps, PolymorphicComponent } from '../../utils/polymorphicComponent';
+interface TextEllipsisProps extends PolymorphicProps<React.HTMLAttributes<HTMLElement>> {
+    children: string;
+    maxLines?: number;
+    refProp?: string;
+    tooltipProps?: Omit<TooltipProps, 'target' | 'association'>;
+}
+declare const TextEllipsis: PolymorphicComponent<TextEllipsisProps>;
+export default TextEllipsis;

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

@@ -5,7 +5,7 @@ export interface TooltipProps extends React.HTMLAttributes<HTMLDivElement> {
     className?: string;
     target: React.RefObject<HTMLElement> | HTMLElement;
     variant?: 'text' | 'info' | 'big';
-    association?: 'aria-labelledby' | 'aria-describedby';
+    association?: 'aria-labelledby' | 'aria-describedby' | 'none';
     show?: boolean | undefined;
     placement?: Placement;
     portal?: React.RefObject<HTMLElement> | HTMLElement;

package/lib/index.d.ts

@@ -55,6 +55,7 @@ export { default as Listbox, ListboxOption, ListboxGroup } from './components/Li
 export { default as Combobox, ComboboxOption, ComboboxGroup } from './components/Combobox';
 export { default as Popover } from './components/Popover';
 export { default as Timeline, TimelineItem } from './components/Timeline';
+export { default as TextEllipsis } from './components/TextEllipsis';
 /**
  * Helpers / Utils
  */

package/lib/index.js

@@ -1659,6 +1659,7 @@ function Tooltip(_a) {
     var _j = tslib.__read(React.useState(null), 2), targetElement = _j[0], setTargetElement = _j[1];
     var _k = tslib.__read(React.useState(null), 2), tooltipElement = _k[0], setTooltipElement = _k[1];
     var _l = tslib.__read(React.useState(null), 2), arrowElement = _l[0], setArrowElement = _l[1];
+    var hasAriaAssociation = association !== 'none';
     var _m = reactPopper.usePopper(targetElement, tooltipElement, {
         placement: initialPlacement,
         modifiers: [
@@ -1760,14 +1761,16 @@ function Tooltip(_a) {
     }, [tooltipElement, show, hide]);
     // Keep the target's id in sync
     React.useEffect(function () {
-        var idRefs = targetElement === null || targetElement === void 0 ? void 0 : targetElement.getAttribute(association);
-        if (!hasIdRef(idRefs, id)) {
-            targetElement === null || targetElement === void 0 ? void 0 : targetElement.setAttribute(association, addIdRef(idRefs, id));
+        if (hasAriaAssociation) {
+            var idRefs = targetElement === null || targetElement === void 0 ? void 0 : targetElement.getAttribute(association);
+            if (!hasIdRef(idRefs, id)) {
+                targetElement === null || targetElement === void 0 ? void 0 : targetElement.setAttribute(association, addIdRef(idRefs, id));
+            }
         }
         return function () {
-            if (targetElement) {
-                var idRefs_1 = targetElement.getAttribute(association);
-                targetElement.setAttribute(association, removeIdRef(idRefs_1, id));
+            if (targetElement && hasAriaAssociation) {
+                var idRefs = targetElement.getAttribute(association);
+                targetElement.setAttribute(association, removeIdRef(idRefs, id));
             }
         };
     }, [targetElement, id, association]);
@@ -1794,13 +1797,6 @@ var TooltipContent = function (_a) {
     return (React__default["default"].createElement("div", tslib.__assign({ className: classNames__default["default"]('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 _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, large = _a.large, other = tslib.__rest(_a, ["as", "icon", "label", "tooltipPlacement", "tooltipVariant", "tooltipPortal", "className", "variant", "disabled", "tabIndex", "large"]);
     var internalRef = React.useRef();
@@ -3557,7 +3553,9 @@ var ComboboxOption = React.forwardRef(function (_a, ref) {
     }
     return (React__default["default"].createElement(ListboxOption, tslib.__assign({ as: "li", className: classNames__default["default"]('ComboboxOption', className, {
             'ComboboxOption--disabled': disabled
-        }), activeClass: "ComboboxOption--active", ref: comboboxOptionRef, disabled: disabled, id: id, value: propValue }, props),
+        }), activeClass: "ComboboxOption--active", 
+        // @ts-expect-error use HTMLElement even though the underlying element is an li element
+        ref: comboboxOptionRef, disabled: disabled, id: id, value: propValue }, props),
         React__default["default"].createElement("span", null,
             React__default["default"].createElement(ComboboxMatch, null, children),
             description && (React__default["default"].createElement("div", { className: "ComboboxOption__description" }, description))),
@@ -3959,6 +3957,51 @@ function TimelineItem(_a) {
         React__default["default"].createElement("div", { className: "TimelineItem__details" }, children)));
 }
 
+var TextEllipsis = React__default["default"].forwardRef(function (_a, ref) {
+    var className = _a.className, children = _a.children, maxLines = _a.maxLines, as = _a.as, tooltipProps = _a.tooltipProps, props = tslib.__rest(_a, ["className", "children", "maxLines", "as", "tooltipProps"]);
+    var Element = 'div';
+    var sharedRef = useSharedRef(ref);
+    var _b = tslib.__read(React.useState(false), 2), showTooltip = _b[0], setShowTooltip = _b[1];
+    if (as) {
+        Element = as;
+    }
+    else if (showTooltip) {
+        props = Object.assign({
+            role: 'button',
+            'aria-disabled': true,
+            tabIndex: 0
+        }, props);
+    }
+    if (typeof maxLines === 'number') {
+        props.style = tslib.__assign({ WebkitLineClamp: maxLines || 2 }, props.style);
+    }
+    React.useEffect(function () {
+        var listener = function () {
+            requestAnimationFrame(function () {
+                var overflowElement = sharedRef.current;
+                if (!overflowElement) {
+                    return;
+                }
+                var hasOverflow = typeof maxLines === 'number'
+                    ? overflowElement.clientHeight < overflowElement.scrollHeight
+                    : overflowElement.clientWidth < overflowElement.scrollWidth;
+                setShowTooltip(hasOverflow);
+            });
+        };
+        var observer = new ResizeObserver(listener);
+        observer.observe(sharedRef.current);
+        return function () {
+            observer === null || observer === void 0 ? void 0 : observer.disconnect();
+        };
+    }, []);
+    return (React__default["default"].createElement(React__default["default"].Fragment, null,
+        React__default["default"].createElement(Element, tslib.__assign({ className: classNames__default["default"]('TextEllipsis', className, {
+                'TextEllipsis--multiline': !!maxLines
+            }), ref: sharedRef }, props), children),
+        showTooltip && (React__default["default"].createElement(Tooltip, tslib.__assign({ target: sharedRef, association: "none" }, tooltipProps), children))));
+});
+TextEllipsis.displayName = 'TextEllipsis';
+
 var LIGHT_THEME_CLASS = 'cauldron--theme-light';
 var DARK_THEME_CLASS = 'cauldron--theme-dark';
 var ThemeContext = React.createContext({
@@ -4116,6 +4159,7 @@ exports.Tabs = Tabs;
 exports.Tag = Tag;
 exports.TagButton = TagButton;
 exports.TagLabel = TagLabel;
+exports.TextEllipsis = TextEllipsis;
 exports.TextField = TextField;
 exports.ThemeContext = ThemeContext;
 exports.ThemeProvider = ThemeProvider;

package/lib/utils/polymorphicComponent.d.ts

@@ -0,0 +1,10 @@
+import type * as React from 'react';
+type Merge<P1 = {}, P2 = {}> = Omit<P1, keyof P2> & P2;
+export type PolymorphicProps<Props = {}, ElementType extends React.ElementType = React.ElementType> = Props & {
+    as?: ElementType;
+};
+export type PolymorphicComponentProps<Props = {}, ElementType extends React.ElementType = React.ElementType> = Merge<ElementType extends keyof JSX.IntrinsicElements ? React.PropsWithRef<JSX.IntrinsicElements[ElementType]> : ElementType extends React.ElementType ? React.ComponentPropsWithRef<ElementType> : never, PolymorphicProps<Props, ElementType>>;
+export type PolymorphicComponent<Props = {}, ElementType extends React.ElementType = React.ElementType> = Merge<React.ForwardRefExoticComponent<Props>, {
+    <T extends React.ElementType = ElementType>(props: PolymorphicComponentProps<Props, T>): React.ReactElement | null;
+}>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deque/cauldron-react",
-  "version": "6.2.1-canary.fca8b9e6",
+  "version": "6.3.0-canary.2fa4aa02",
   "license": "MPL-2.0",
   "description": "Fully accessible react components library for Deque Cauldron",
   "homepage": "https://cauldron.dequelabs.com/",

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

@@ -1,40 +0,0 @@
-/**
- * Based on @radix-ui/polymorphic:
- * https://github.com/radix-ui/primitives/blob/main/packages/react/polymorphic/src/polymorphic.ts
- */
-import * as React from 'react';
-type Merge<P1 = {}, P2 = {}> = Omit<P1, keyof P2> & P2;
-/**
- * Infers the OwnProps if E is a ForwardRefExoticComponentWithAs
- */
-type OwnProps<E> = E extends ForwardRefComponent<any, infer P> ? P : {};
-/**
- * Infers the JSX.IntrinsicElement if E is a ForwardRefExoticComponentWithAs
- */
-type IntrinsicElement<E> = E extends ForwardRefComponent<infer I, any> ? I : never;
-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 };