@blueprintjs/select
Version:
Components related to selecting items from a list
35 lines (34 loc) • 1.64 kB
TypeScript
import type { PopoverNextRef, PopoverProps } from "@blueprintjs/core";
/**
* Reusable collection of props for components in this package which render a `Popover`
* and need to provide some degree of customization for that popover.
*/
export interface SelectPopoverProps {
/**
* HTML attributes to spread to the popover content container element.
*/
popoverContentProps?: React.HTMLAttributes<HTMLDivElement>;
/**
* Props to spread to the popover.
*
* Note that `content` cannot be changed, but you may apply some props to the content wrapper element
* with `popoverContentProps`. Likewise, `targetProps` is no longer supported as it was in Blueprint v4, but you
* may use `popoverTargetProps` instead.
*
* N.B. `disabled` is supported here, as this can be distinct from disabling the entire select button / input
* control element. There are some cases where we only want to disable the popover interaction.
*/
popoverProps?: Partial<Omit<PopoverProps, "content" | "defaultIsOpen" | "fill" | "renderTarget">>;
/**
* Optional ref to the popover. `popoverRef.current?.reposition()` re-runs position
* calculation — useful when the target moves in a way the popover doesn't observe
* automatically (e.g. a parent layout change that doesn't trigger a resize).
*
* For a ref to the popover's floating DOM element, use `popoverProps.popoverRef`.
*/
popoverRef?: React.RefObject<PopoverNextRef>;
/**
* HTML attributes to add to the popover target element.
*/
popoverTargetProps?: React.HTMLAttributes<HTMLElement>;
}