@zohodesk/components 1.6.31 → 1.6.34

package/es/Textarea/Textarea.module.css

@@ -138,7 +138,7 @@
   --textarea_height: var(--zd_size184);
 }
 .default {
-  font-weight: var(--zd-fw-normal);
+  composes: d-font-normal from global;
   --textarea_text_color: var(--zdt_textarea_black_text);
 }
 .primary {

package/es/Tooltip/Tooltip.module.css

@@ -11,12 +11,11 @@
 }
 
 .tooltipcont {
-  composes: d-overflow-hidden d-border-transparent d-border-solid from global;
+  composes: d-overflow-hidden d-border-transparent d-border-solid d-font-semibold from global;
   color: var(--zdt_tooltip_default_text);
   padding-block:0 ;
   padding-inline: var(--zd_size10) ;
   font-size: var(--zd_font_size13) ;
-  font-weight: var(--zd-fw-semibold);
   word-break: break-word;
   max-width: var(--zd_size420) ;
   line-height: 1.5385;

package/es/Tooltip/__tests__/Tooltip.spec.js

@@ -0,0 +1,590 @@
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+
+import React from 'react';
+import { render, cleanup, act, fireEvent } from '@testing-library/react';
+import Tooltip from "../Tooltip"; // Tooltip renders nothing until handleOver is called with a hovered element, so cases drive it through its ref.
+// jsdom reports every size as 0, which collapses all placement branches, so sizes are stubbed to fixed values.
+
+const containerSize = {
+  width: 1000,
+  height: 800
+};
+const tooltipSize = {
+  width: 100,
+  height: 40
+};
+const defaultRect = {
+  top: 300,
+  left: 400,
+  width: 50,
+  height: 20
+};
+const originalOffsetDescriptors = {
+  offsetWidth: Object.getOwnPropertyDescriptor(HTMLElement.prototype, 'offsetWidth'),
+  offsetHeight: Object.getOwnPropertyDescriptor(HTMLElement.prototype, 'offsetHeight')
+};
+
+const restoreDescriptor = name => {
+  if (originalOffsetDescriptors[name]) {
+    Object.defineProperty(HTMLElement.prototype, name, originalOffsetDescriptors[name]);
+  } else {
+    delete HTMLElement.prototype[name];
+  }
+}; // only the tooltip element is sized through the prototype; the hovered element and container are stubbed per instance
+
+
+const isTooltipElement = element => element.classList.contains('tooltiptext');
+
+const hoverTooltip = (attributes, {
+  rect = defaultRect,
+  tooltipProps,
+  element = {}
+} = {}) => {
+  const target = document.createElement(element.tagName || 'div');
+  Object.entries(attributes).forEach(([name, value]) => target.setAttribute(name, value));
+
+  target.getBoundingClientRect = () => ({ ...rect,
+    right: rect.left + rect.width,
+    bottom: rect.top + rect.height
+  });
+
+  if (element.innerText !== undefined) {
+    target.innerText = element.innerText;
+  }
+
+  if (element.isOverflowing) {
+    Object.defineProperty(target, 'scrollWidth', {
+      value: 200
+    });
+    Object.defineProperty(target, 'offsetWidth', {
+      value: 100
+    });
+  }
+
+  const ref = /*#__PURE__*/React.createRef();
+  const utils = render( /*#__PURE__*/React.createElement(Tooltip, _extends({
+    ref: ref
+  }, tooltipProps)));
+  act(() => {
+    ref.current.observeElement();
+  });
+  act(() => {
+    ref.current.handleOver({
+      target
+    });
+  });
+  return { ...utils,
+    ref,
+    target
+  };
+};
+
+describe('Tooltip', () => {
+  beforeAll(() => {
+    Object.defineProperty(HTMLElement.prototype, 'offsetWidth', {
+      configurable: true,
+
+      get() {
+        return isTooltipElement(this) ? tooltipSize.width : 0;
+      }
+
+    });
+    Object.defineProperty(HTMLElement.prototype, 'offsetHeight', {
+      configurable: true,
+
+      get() {
+        return isTooltipElement(this) ? tooltipSize.height : 0;
+      }
+
+    });
+  });
+  afterAll(() => {
+    restoreDescriptor('offsetWidth');
+    restoreDescriptor('offsetHeight');
+  });
+  beforeEach(() => {
+    Object.defineProperty(document.body, 'offsetWidth', {
+      configurable: true,
+      value: containerSize.width
+    });
+    Object.defineProperty(document.body, 'offsetHeight', {
+      configurable: true,
+      value: containerSize.height
+    });
+
+    document.body.getBoundingClientRect = () => ({
+      left: 0,
+      top: 0,
+      ...containerSize
+    });
+  });
+  afterEach(() => {
+    cleanup();
+    delete document.body.offsetWidth;
+    delete document.body.offsetHeight;
+    delete document.body.getBoundingClientRect;
+    document.documentElement.removeAttribute('dir');
+  });
+  test('Render with default props', () => {
+    const {
+      asFragment
+    } = render( /*#__PURE__*/React.createElement(Tooltip, null));
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with dataId', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text'
+    }, {
+      tooltipProps: {
+        dataId: 'tooltip-dataId'
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with customClass', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text'
+    }, {
+      tooltipProps: {
+        customClass: 'custom-tooltip'
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  }); // the title attribute is moved to data-title so the browser's own tooltip does not also appear
+
+  test('Render with title attribute only', () => {
+    const {
+      asFragment,
+      target
+    } = hoverTooltip({
+      title: 'Tooltip text'
+    });
+    expect(target.getAttribute('data-title')).toBe('Tooltip text');
+    expect(target.hasAttribute('title')).toBe(false);
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-title', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text'
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-title taking precedence over title', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Data title',
+      title: 'Plain title'
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-ishtml as true', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': '<b>Bold</b> text',
+      'data-ishtml': 'true'
+    });
+    expect(asFragment()).toMatchSnapshot();
+  }); // any non-empty data-ishtml value counts as html, including the string false
+
+  test('Render with data-ishtml as false', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': '<b>Bold</b> text',
+      'data-ishtml': 'false'
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-tooltip-noarrow as true', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': 'top',
+      'data-tooltip-noarrow': 'true'
+    });
+    expect(asFragment()).toMatchSnapshot();
+  }); // only the exact value true removes the arrow
+
+  test('Render with data-tooltip-noarrow as false', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': 'top',
+      'data-tooltip-noarrow': 'false'
+    });
+    expect(asFragment()).toMatchSnapshot();
+  }); // pre is shown as pre-wrap and nowrap as normal, so those two render like pre-wrap and the default
+
+  const wraps = ['pre', 'pre-wrap', 'pre-line', 'nowrap', 'break-spaces'];
+  test.each(wraps)('Render with data-title-wrap as %s', wrap => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-wrap': wrap
+    });
+    expect(asFragment()).toMatchSnapshot();
+  }); // bottom matches the default placement, including the flip above near the bottom edge
+
+  test('Render with no position below the target', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text'
+    }, {
+      rect: defaultRect
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with no position near the bottom edge flipping above', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text'
+    }, {
+      rect: { ...defaultRect,
+        top: 770
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with no position at the left screen edge', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text'
+    }, {
+      rect: {
+        top: 300,
+        left: 5,
+        width: 20,
+        height: 20
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with no position at the right screen edge', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text'
+    }, {
+      rect: {
+        top: 300,
+        left: 960,
+        width: 30,
+        height: 20
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-title-position as top with space above', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': 'top'
+    }, {
+      rect: defaultRect
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-title-position as top without space above', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': 'top'
+    }, {
+      rect: { ...defaultRect,
+        top: 10
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-title-position as top at the left screen edge', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': 'top'
+    }, {
+      rect: {
+        top: 300,
+        left: 5,
+        width: 20,
+        height: 20
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-title-position as top at the right screen edge', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': 'top'
+    }, {
+      rect: {
+        top: 300,
+        left: 960,
+        width: 30,
+        height: 20
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-title-position as bottom with space below', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': 'bottom'
+    }, {
+      rect: defaultRect
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-title-position as bottom without space below', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': 'bottom'
+    }, {
+      rect: { ...defaultRect,
+        top: 770
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-title-position as left with space on the left', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': 'left'
+    }, {
+      rect: defaultRect
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-title-position as left without space on the left', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': 'left'
+    }, {
+      rect: { ...defaultRect,
+        left: 20
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-title-position as left at the top screen edge', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': 'left'
+    }, {
+      rect: { ...defaultRect,
+        top: 0
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-title-position as left at the bottom screen edge', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': 'left'
+    }, {
+      rect: { ...defaultRect,
+        top: 790
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-title-position as right with space on the right', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': 'right'
+    }, {
+      rect: defaultRect
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-title-position as right without space on the right', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': 'right'
+    }, {
+      rect: { ...defaultRect,
+        left: 930
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  }); // in rtl the left and right positions are swapped
+
+  test.each(['left', 'right'])('Render with data-title-position as %s in rtl', position => {
+    document.documentElement.setAttribute('dir', 'rtl');
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-title-position': position
+    });
+    expect(asFragment()).toMatchSnapshot();
+  }); // the tooltip is skipped when the hovered text already shows the title, unless the text is cut off
+  // this first case stays hidden on purpose; the others each bypass that check
+
+  test('Render with title matching the element text', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Save'
+    }, {
+      element: {
+        innerText: 'Save'
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with title matching the element text and data-istitle', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Save',
+      'data-istitle': 'true'
+    }, {
+      element: {
+        innerText: 'Save'
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with title matching an overflowing element text', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Save'
+    }, {
+      element: {
+        innerText: 'Save',
+        isOverflowing: true
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with data-dottedTitle and an overflowing element text', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Save',
+      'data-dottedTitle': 'Full saved title'
+    }, {
+      element: {
+        innerText: 'Save',
+        isOverflowing: true
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  }); // data-dottedTitle is ignored while the text is not cut off
+
+  test('Render with data-dottedTitle and a title different from the element text', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      'data-title': 'Tooltip text',
+      'data-dottedTitle': 'Full saved title'
+    }, {
+      element: {
+        innerText: 'Other'
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with title matching the text of an icon element', () => {
+    const {
+      asFragment
+    } = hoverTooltip({
+      title: 'Save'
+    }, {
+      element: {
+        tagName: 'i',
+        innerText: 'Save'
+      }
+    });
+    expect(asFragment()).toMatchSnapshot();
+  }); // the tooltip hides when the pointer leaves, a click or release happens, or an untitled element is hovered
+
+  test.each(['click', 'mouseup', 'mouseleave'])('Render with %s event on the hovered element', eventName => {
+    const {
+      asFragment,
+      container,
+      target
+    } = hoverTooltip({
+      'data-title': 'Tooltip text'
+    });
+    expect(container.textContent).toBe('Tooltip text');
+    fireEvent(target, new MouseEvent(eventName));
+    expect(container.textContent).toBe('');
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with a following hover on an element without a title', () => {
+    const {
+      asFragment,
+      container,
+      ref
+    } = hoverTooltip({
+      'data-title': 'Tooltip text'
+    });
+    expect(container.textContent).toBe('Tooltip text');
+    act(() => {
+      ref.current.handleOver({
+        target: document.createElement('div')
+      });
+    });
+    expect(container.textContent).toBe('');
+    expect(asFragment()).toMatchSnapshot();
+  });
+  test('Render with a following hover on another titled element', () => {
+    const {
+      asFragment,
+      ref
+    } = hoverTooltip({
+      'data-title': 'Tooltip text'
+    });
+    const next = document.createElement('div');
+    next.setAttribute('data-title', 'Next tooltip text');
+
+    next.getBoundingClientRect = () => ({ ...defaultRect,
+      right: 450,
+      bottom: 320
+    });
+
+    act(() => {
+      ref.current.handleOver({
+        target: next
+      });
+    });
+    expect(asFragment()).toMatchSnapshot();
+  });
+});