Skip to content

Latest commit

 

History

History
26 lines (20 loc) · 1.14 KB

README.md

File metadata and controls

26 lines (20 loc) · 1.14 KB
Raw

VisibleOnAncestorMixin

The VisibleOnAncestorMixin adds a behavior to a component so that it is initially hidden, and becomes visible when user hovers or focuses within an ancestor marked with the d2l-visible-on-ancestor-target class. It includes styles that must be included with the component. If the device does not support hovering, the element will be visible regardless of whether the user is hovering or focusing within the target.

Usage

Apply the mixin and include the required visibleOnAncestorStyles.

import { VisibleOnAncestorMixin, visibleOnAncestorStyles } from '@brightspace-ui/core/mixins/visible-on-ancestor/visible-on-ancestor-mixin.js';
class MyComponent extends VisibleOnAncestorMixin(LitElement) {
  static get styles() {
    return [ visibleOnAncestorStyles, css`/* MyComponent styles */` ];
  }
}

The consumer turns on the behavior using the visible-on-ancestor attribute and adds the d2l-visible-on-ancestor-target to the element in which hovering/focusing should show the element.

<div class="d2l-visible-on-ancestor-target">
  ...
  <my-component visible-on-ancestor></my-component>
  ...
</div>