auro-popover
<auro-popover>
is a HTML custom element for hovering/blurring over an element to display a tooltip-style popover with any content populated in a slot.
UI development browser support
For the most up to date information on UI development browser support
Install
$ npm i @alaskaairux/auro-popover
Installing as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this stack overflow answer.
Design Token CSS Custom Property dependency
The use of any Auro custom element has a dependency on the Auro Design Tokens.
For additional details in regards to using Auro Design Tokens with components, please see TECH_DETAILS.md
CSS Custom Property fallbacks
CSS custom properties are not supported in older browsers. For this, fallback properties are pre-generated and included with the npm.
Any update to the Auro Design Tokens will be immediately reflected with browsers that support CSS custom properties, legacy browsers will require updated components with pre-generated fallback properties.
Define dependency in project component
Defining the component dependency within each component that is using the <auro-popover>
component.
import "@alaskaairux/auro-popover";
Reference component in HTML
The popover component has a requirement on the placement of a designated element that will trigger the popover. The following is a default configuration with a trigger that is OUTSIDE the shadow DOM.
<auro-popover for="example1">Hello World</auro-popover>
<p id="example1">Hover over me</p>
The following is an example of a popover with the trigger from within the scope of the shadow DOM using slot
elements. This format will also work with nested shadow DOMs, from the implementor of <auro-popover>
to the trigger component.
<auro-popover for="example2">
Hello World!
<p slot="trigger" id="example2">Hover over me</p>
</auro-popover>
Install bundled assets from CDN
In cases where the project is not able to process JS assets, there are pre-processed assets available for use.
NOTE: Be sure to replace :version
in the URL with the version of the asset you want.
<link rel="stylesheet" href="https://unpkg.com/@alaskaairux/orion-design-tokens@:version/dist/tokens/CSSTokenProperties.css" />
<link rel="stylesheet" href="https://unpkg.com/@alaskaairux/orion-web-core-style-sheets@:version/dist/bundled/baseline.css" />
<script src="https://unpkg.com/@alaskaairux/auro-popover@:version/dist/polyfills.js"></script>
<script src="https://unpkg.com/@alaskaairux/auro-popover@:version/dist/auro-popover__bundled.js"></script>
polyfills.js
The polyfills.js
is packaged with this component, but IT IS NOT NEEDED to load a polyfill per component. The polyfills.js
will work for all additional components added to the project.
auro-popover use cases
The <auro-popover>
element should be used in situations where users may:
- Hover/blur over an element to display a popover-style graphic
Development
In order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request.
Please be sure to review the contribution guidelines for this project. Please make sure to pay special attention to the conventional commits section of the document.
Start development environment
Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open three different shell sessions. One is for the Gulp tasks, the second is for a series of npm tasks and the last is to run the Polymer server.
Peer dependency: Please make sure Polymer is installed globally in order to run the Polymer server. See Auro Component Development Details for more information.
// shell terminal one
$ npm run dev
// shell terminal two
$ npm run serve
Open localhost:3001
Testing
Automated tests are required for every Auro component. See .\test\auro-popover.test.js
for the tests for this component. Run npm test
to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See the testing documentation for more details.