@aurodesignsystem/auro-popover
v6.0.1
Published
auro-popover HTML custom element
Readme
Popover
The <auro-popover> element attaches to another element and displays on hover. It uses the Popper.js library to position itself relative to the trigger element and supports placement options such as top and bottom.
Use Cases
The auro-popover element should be used in situations where users may:
- interact with an element to get clarification on content offering
- provide definition to iconic imagery
- when helper text is required
Install
$ npm i @aurodesignsystem/auro-popoverDefine Dependency in Project
Defining the dependency within each project that is using the <auro-popover> component.
import "@aurodesignsystem/auro-popover";Use CDN
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.
<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-popover@latest/+esm"></script>Basic Example
<auro-popover>
Top popover content!
<auro-button slot="trigger">Popover Test</auro-button>
</auro-popover>Custom Component Registration for Version Management
There are two key parts to every Auro component: the class and the custom element definition. The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.
When you install the component as described on the Install page, the class is imported automatically, and the component is registered globally for you.
However, if you need to load multiple versions of the same component on a single page (for example, when two projects depend on different versions), you can manually register the class under a custom element name to avoid conflicts.
You can do this by importing only the component class and using the register(name) method with a unique name:
// Import the class only
import { AuroPopover } from '@aurodesignsystem/auro-popover/class';
// Register with a custom name if desired
AuroPopover.register('custom-popover');This will create a new custom element <custom-popover> that behaves exactly like <auro-popover>, allowing both to coexist on the same page without interfering with each other.
<!-- The slot=trigger attribute is bound directly to the auro-button element -->
<custom-popover>
Top popover content!
<auro-button slot="trigger">Popover Test</auro-button>
</custom-popover>
<!-- Using the placement=bottom attribute -->
<custom-popover placement="bottom">
Popover content!
<auro-button slot="trigger">Popover Test</auro-button>
</custom-popover>