Popover – Code

Implementation
Popover Props
Popover.Button Props
Popover.Content Props
Popover.Trigger Props

Common Examples

import { Popover } from "@servicetitan/anvil2";

const ExampleComponent = () => {
  return (
    <Popover>
      <Popover.Button>Click me!</Popover.Button>
      <Popover.Content>This is the popover content.</Popover.Content>
    </Popover>
  );
};

To build a popover, three components are required:

Popover: the configurable parent component
A way to control the open state of the popover. One of:
- Popover.Button: an Anvil2 Button
- Popover.Trigger: used to render a custom trigger component
Popover.Content: the content rendered within the popover

<Popover>
  <Popover.Button>Trigger Button</Popover.Button>
  <Popover.Content>Popover content. Accepts a ReactNode.</Popover.Content>
</Popover>

Use the placement prop on the Popover to change the default positioning. The popover will reposition itself if there is not enough space in the default placement.

<Popover placement="top">...</Popover>

Controlling popovers

Popovers can be controlled or uncontrolled (default). Control the popover using the open prop.

Uncontrolled (default)

Controlled

Using a custom trigger

To use something other than an Anvil2 Button to trigger the popover, use the Popover.Trigger component. The Popover.Trigger passes a set of props to the children that should be passed to an interactive HTML element, such as a button or input.

<Popover>
  <Popover.Trigger>
    {(props) => <button {...props}>Open Popover</button>}
  </Popover.Trigger>
  <Popover.Content>Content</Popover.Content>
</Popover>

The Popover.Close button can be used to close the popover from within the popover content.On controlled popovers, the onClick prop should be used to update the open state:

<Popover.Close onClick={() => setIsOpenState(false)} icon={Close} />

Disabling default closing behavior

By default, an uncontrolled popover closes if either the user clicks outside of the popover, or the user presses the “Escape” key. Both of these behaviors can be disabled with props:

Disable close on outside click

Disable close on “Escape” press

Enabling trapped focus

By default, the popover content does not trap focus so that users can navigate the content with a keyboard without naturally. To enable this behavior, set the modal prop of the Popover to true.

Default without trapping

Trapped focus

Using with Anvil1

Popover from version 1.23.0 uses HTML popover API which utilizes top-layer. This feature puts what’s inside the top-layer to be on the top of entire the HTML. Because of this, there are cases where it does not work well with Anvil1’s portaled components.

While having the Popover open, if a portaled Anvil1 component is triggered to open from within, the Popover will be on top always. This is something we can potentially adjust in Anvil1 and we have a spike ticket internally for it. If you encounter this issue, please reach out to us.
While having the Popover open, if a Drawer or Dialog from Anvil1 is triggered to open, not within the Popover, the Popover will be on top of the Drawer or Dialog.

React Accessibility

Most of the accessibility considerations for managing aria props and keyboard focus are handled internally. There are some things to keep in mind while working with popovers:

Always test keyboard navigation for interactive elements within popovers. The user should be able to easily access the elements in a logical order.
If the popover includes a form, be sure to follow accessible best practices for form building.
When building a custom trigger using Popover.Trigger, be sure to pass the props to an interactive element, as certain aria props are included to properly connect the trigger to the content.

For more guidance on creating accessible components, see building accessible custom components best practices.

<Popover
  defaultOpen={false}
  disableAutoUpdate={false}
  disableCaret={false}
  disableCloseOnEscape={false}
  disableCloseOnClickOutside={false}
  modal={true}
  noPadding={false}
  open={false}
  openOnHover={false}
  placement="bottom"
  onClose={() => {}}
  onClickOutside={() => {}}
  onOpenAnimationStart={() => {}}
  onOpenAnimationComplete={() => {}}
  onCloseAnimationStart={() => {}}
  onCloseAnimationComplete={() => {}}
>
  <Popover.Button>Trigger</Popover.Button>
  <Popover.Content>Content</Popover.Content>
</Popover>

children

ReactNode

Should include Popover.Button or Popover.Trigger and Popover.Content.

defaultOpen

boolean

Controls the default open state on uncontrolled popovers.

disableAutoUpdate

boolean

Disables all focus management entirely. Useful to delay focus management until after a transition completes or some other conditional state.

disableCaret

boolean

Removes the caret between the trigger and content.

disableCloseOnEscape

boolean

See Disabling default closing behavior

disableCloseOnClickOutside

boolean

See Disabling default closing behavior

Traps focus within the popover content.

noPadding

boolean

Removes padding from popover content.

onClickOutside

() => void

Callback when clicking outside the popover.

onClose

() => void

Called when the popover is closed, except after mouse exits when openOnHover is true.

onCloseAnimationComplete

() => void

Callback when closing animation completes.

onCloseAnimationStart

() => void

Callback when closing animation starts.

onOpenAnimationComplete

() => void

Callback when opening animation completes.

onOpenAnimationStart

() => void

Callback when opening animation starts.

open

boolean

Use to control open state of the popover.

openOnHover

boolean

Opens the popover on hover over the trigger. In most cases, use a Tooltip instead.

placement

default:"bottom"

<Popover.Button appearance="primary" size="medium" onClick={() => {}}>
  Trigger Button
</Popover.Button>

The Popover.Button component accepts any valid Anvil2 Button component props, with one difference — the children prop is required in Popover.Button.

<Popover.Trigger>
  {(data) => (
    <button {...data} aria-expanded={data["aria-expanded"]} onClick={data.onClick}>
      Custom Trigger
    </button>
  )}
</Popover.Trigger>

`Popover.Trigger` Props

children

(data) => ReactElement

The data parameter includes "aria-expanded", a ref for the trigger component, and some additional accessibility fields.

Anvil2 Web

Resources

Popover – Code

Common Examples

Popover basics

Popover placement

Controlling popovers

Uncontrolled (default)

Controlled

Using a custom trigger

Popover close button

Disabling default closing behavior

Disable close on outside click

Disable close on “Escape” press

Enabling trapped focus

Default without trapping

Trapped focus

Using with Anvil1

React Accessibility

`Popover` Props

`Popover.Button` Props

`Popover.Content` Props

`Popover.Trigger` Props

Anvil2 Web

Resources

Documentation Index

​Common Examples

​Popover basics

​Popover placement

​Controlling popovers

​Uncontrolled (default)

​Controlled

​Using a custom trigger

​Popover close button

​Disabling default closing behavior

​Disable close on outside click

​Disable close on “Escape” press

​Enabling trapped focus

​Default without trapping

​Trapped focus

​Using with Anvil1

​React Accessibility

​Popover Props

​Popover.Button Props

​Popover.Content Props

​Popover.Trigger Props

Common Examples

Popover basics

Popover placement

Controlling popovers

Uncontrolled (default)

Controlled

Using a custom trigger

Popover close button

Disabling default closing behavior

Disable close on outside click

Disable close on “Escape” press

Enabling trapped focus

Default without trapping

Trapped focus

Using with Anvil1

React Accessibility

`Popover` Props

`Popover.Button` Props

`Popover.Content` Props

`Popover.Trigger` Props