feat(tooltip): Expose hide and isShown methods in the MDCTooltip component. This allows MDC clients to create their own class to enforce only one tooltip being shown at a time.

PiperOrigin-RevId: 350395701

Author: sayris

packages/mdc-tooltip/README.md

@@ -166,7 +166,9 @@ Mixin | Description
 Method Signature | Description
 --- | ---
 `setTooltipPosition(position: {xPos?: XPosition, yPos?: YPosition}) => void` | Specify how the tooltip should be aligned with the anchor element. See [tooltip positioning](#tooltip-positioning) section for more information.
-`setAnchorBoundaryType(type: AnchorBoundaryType) => void` | Specify whether the anchor element is `bounded` (element has an identifiable boundary such as a button) or `unbounded` (element does not have a visually declared boundary such as a text link). Tooltips are placed closer to bounded anchor elements compared to unbounded anchor elements. If no type is specified, defaults to `bounded`
+`setAnchorBoundaryType(type: AnchorBoundaryType) => void` | Specify whether the anchor element is `bounded` (element has an identifiable boundary such as a button) or `unbounded` (element does not have a visually declared boundary such as a text link). Tooltips are placed closer to bounded anchor elements compared to unbounded anchor elements. If no type is specified, defaults to `bounded`.
+`hide() => void` | Proxies to the foundation's `hide` method, immediately hides the tooltip if it is shown.
+`isShown() => boolean` | Returns whether or not the tooltip is shown.
 
 ### Usage Within Frameworks
 

packages/mdc-tooltip/component.ts

@@ -127,6 +127,14 @@ export class MDCTooltip extends MDCComponent<MDCTooltipFoundation> {
     this.foundation.setAnchorBoundaryType(type);
   }
 
+  hide() {
+    this.foundation.hide();
+  }
+
+  isShown() {
+    this.foundation.getIsShown();
+  }
+
   getDefaultFoundation() {
     const adapter: MDCTooltipAdapter = {
       getAttribute: (attr) => this.root.getAttribute(attr),

packages/mdc-tooltip/foundation.ts

@@ -145,6 +145,10 @@ export class MDCTooltipFoundation extends MDCFoundation<MDCTooltipAdapter> {
         this.adapter.getAnchorAttribute(attributes.ARIA_HASPOPUP) === 'true';
   }
 
+  getIsShown() {
+    return this.isShown;
+  }
+
   getIsRich() {
     return this.isRich;
   }

packages/mdc-tooltip/test/component.test.ts

@@ -192,6 +192,20 @@ describe('MDCTooltip', () => {
          component.destroy();
        });
 
+    it('#hide forwards to MDCFoundation#hide', () => {
+      const {mockFoundation, component} = setupTestWithMockFoundation(fixture);
+      component.hide();
+      expect(mockFoundation.hide).toHaveBeenCalled();
+      component.destroy();
+    });
+
+    it('#isShown forwards to MDCFoundation#getIsShown', () => {
+      const {mockFoundation, component} = setupTestWithMockFoundation(fixture);
+      component.isShown();
+      expect(mockFoundation.getIsShown).toHaveBeenCalled();
+      component.destroy();
+    });
+
     it('sets aria-hidden to false when showing tooltip on an anchor annotated with `aria-describedby`',
        () => {
          const tooltipElem = fixture.querySelector<HTMLElement>('#tt0')!;

packages/mdc-tooltip/test/foundation.test.ts

@@ -172,6 +172,21 @@ describe('MDCTooltipFoundation', () => {
     expect(foundation.getIsPersistent()).toBeTrue();
   });
 
+  it('#getIsShown returns true if the tooltip is currently shown', () => {
+    const {foundation} = setUpFoundationTest(MDCTooltipFoundation);
+    foundation.show();
+
+    expect(foundation.getIsShown()).toBeTrue();
+  });
+
+  it('#getIsShown returns false if the tooltip is currently hidden', () => {
+    const {foundation} = setUpFoundationTest(MDCTooltipFoundation);
+    foundation.show();
+    foundation.hide();
+
+    expect(foundation.getIsShown()).toBeFalse();
+  });
+
   it('#show modifies tooltip element so it is shown', () => {
     const {foundation, mockAdapter} = setUpFoundationTest(MDCTooltipFoundation);
     foundation.show();