@deque/cauldron-react 6.15.0-canary.d8a9b670 → 6.15.0-canary.e71ae167

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

@@ -1,11 +1,23 @@
 import React from 'react';
 import { type TooltipProps } from '../Tooltip';
 import type { PolymorphicProps, PolymorphicComponent } from '../../utils/polymorphicComponent';
-interface TextEllipsisProps extends PolymorphicProps<React.HTMLAttributes<HTMLElement>> {
+interface TextEllipsisBaseProps extends PolymorphicProps<React.HTMLAttributes<HTMLElement>> {
     children: string;
     maxLines?: number;
     refProp?: string;
-    tooltipProps?: Omit<TooltipProps, 'target' | 'association'>;
+    /**
+     * Using this prop may introduce accessibility issues by hiding content from the user.
+     * Only use this prop if you have an alternative way to make the full text accessible.
+     */
+    hideTooltip?: boolean;
 }
-declare const TextEllipsis: PolymorphicComponent<TextEllipsisProps>;
+interface TextEllipsisWithTooltipProps extends TextEllipsisBaseProps {
+    tooltipProps?: Omit<TooltipProps, 'target' | 'association' | 'children'>;
+}
+interface TextEllipsisWithoutTooltipProps extends TextEllipsisBaseProps {
+    tooltipProps: never;
+    /** Prevent TextEllipsis from showing a tooltip when the text is ellipsized. */
+    hideTooltip: true;
+}
+declare const TextEllipsis: PolymorphicComponent<TextEllipsisWithTooltipProps | TextEllipsisWithoutTooltipProps>;
 export default TextEllipsis;

package/lib/index.js

@@ -4628,10 +4628,11 @@ function TimelineItem(_a) {
 }
 
 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 className = _a.className, children = _a.children, maxLines = _a.maxLines, as = _a.as, tooltipProps = _a.tooltipProps, hideTooltip = _a.hideTooltip, props = tslib.__rest(_a, ["className", "children", "maxLines", "as", "tooltipProps", "hideTooltip"]);
     var Element = 'div';
     var sharedRef = useSharedRef(ref);
-    var _b = tslib.__read(React.useState(false), 2), showTooltip = _b[0], setShowTooltip = _b[1];
+    var _b = tslib.__read(React.useState(false), 2), hasOverflow = _b[0], setHasOverflow = _b[1];
+    var showTooltip = hasOverflow && !hideTooltip;
     if (as) {
         Element = as;
     }
@@ -4646,16 +4647,18 @@ var TextEllipsis = React__default["default"].forwardRef(function (_a, ref) {
         props.style = tslib.__assign({ WebkitLineClamp: maxLines || 2 }, props.style);
     }
     React.useEffect(function () {
+        if (hideTooltip) {
+            return;
+        }
         var listener = function () {
             requestAnimationFrame(function () {
                 var overflowElement = sharedRef.current;
                 if (!overflowElement) {
                     return;
                 }
-                var hasOverflow = typeof maxLines === 'number'
+                setHasOverflow(typeof maxLines === 'number'
                     ? overflowElement.clientHeight < overflowElement.scrollHeight
-                    : overflowElement.clientWidth < overflowElement.scrollWidth;
-                setShowTooltip(hasOverflow);
+                    : overflowElement.clientWidth < overflowElement.scrollWidth);
             });
         };
         var observer = new ResizeObserver(listener);
@@ -4663,7 +4666,7 @@ var TextEllipsis = React__default["default"].forwardRef(function (_a, ref) {
         return function () {
             observer === null || observer === void 0 ? void 0 : observer.disconnect();
         };
-    }, []);
+    }, [hideTooltip]);
     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

package/package.json

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