@salesforce-ux/c360-popover v0.1.3

@salesforce-ux/c360-popover

About

Popovers hide or show content as a result of user interaction, such as clicking, hovering, or focusing. When opened, the content remains connected to the element that triggered it.

Getting Started

Let's start by installing c360-popover as a dependency of your project with npm.

npm i @salesforce-ux/c360-popover

Distributable

After installation, all the distributables for the c360-popover are found under @salesforce-ux/c360-popover/dist/ folder.

c360-popover Integration

For the sake of understanding, we will categorize the development environment into LWC and Non LWC application.
This Guide will cover the integration approach for these two types of application.

For Lightning Web Component(LWC) Application

Dependency Inclusion

c360-styling-hooks is a styling dependency for c360-popover. Hence, this needs to be embedded into your web app in order to make the c360-popover render properly.

/* myComponent.css */
@import '@salesforce-ux/c360-styling-hooks/dist/hooks.custom-props.css';

There are also other ways c360-styling-hooks can be embedded. Please checkout the c360-styling-hooks Integration Guide to learn more.

Component CSS Import

/* myComponent.css */
@import '@salesforce-ux/c360-styling-hooks/dist/hooks.custom-props.css';
@import '@salesforce-ux/c360-popover/dist/popover.css';

HTML Decoration

After that,the HTML of your LWC component template needs to be decorated to have all the named part attributes as per the component's specification. Below is a reference to the component's structure.

<c360-popover placement="below-center" depth="2">
  <div part="source" aria-haspopup="true">
    <!-- This is the placeholder to configure popover trigger element -->
  </div>
  <div part="popup" exportparts="backdrop, frame" role="dialog" aria-label="popup" closed>
    <div part="frame" role="none">
      <c360-button id="dismissible" variant="tertiary" size="default"
        ><c360-icon slot="end" symbol="close"></c360-icon
      ></c360-button>
      <div part="popup-container">
        <!-- This is the placeholder to configure popover container -->
      </div>
    </div>
  </div>
</c360-popover>

For Non LWC Application

Dependency Inclusion Read the section above

Component Import

/* myComponent.js */
import C360Popover from '@salesforce-ux/c360-popover/dist/popover';

Component Registration

/* myComponent.js */
customElements.define('c360-popover', C360Popover);

Example

Below is one approach to integrate your c360-popover component.

Script

/* myComponent.js */
import '@salesforce-ux/c360-styling-hooks/dist/hooks.custom-props.css';
import C360Popover from '@salesforce-ux/c360-popover/dist/popover';
window.customElements.define('c360-popover', C360Popover);

HTML

<c360-popover>
  <c360-button slot="source">Click Me</c360-button>
  <div>This is the place where the content of the popover is configured</div>
</c360-popover>

Interactive Demo

To see more examples with interactive demo, please visit c360 Subsytem's Storybook Environment

Issues

Below are some of the current issues with the Popover and will be releasing the fixes for these in the next versions.

• Hitting Escape key makes popover close but not returning the focus to the triggered element.
• First Inyeractive element inside the popover is not focussed when popover is opened.