[popover2] feat: export PopperCustomModifier type (palantir#5712)

katesroad · Nov 4, 2022 · 652c834 · 652c834
1 parent 98e89b2
commit 652c834
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/packages/popover2/src/index.ts b/packages/popover2/src/index.ts
@@ -34,6 +34,7 @@ export {
  Popover2TargetProps,
  PopperBoundary,
  PopperModifierOverrides,
+ PopperCustomModifer,
  Placement,
  PlacementOptions,
  StrictModifierNames,

diff --git a/packages/popover2/src/popover2SharedProps.ts b/packages/popover2/src/popover2SharedProps.ts
@@ -33,6 +33,13 @@ export type PopperModifierOverrides = Partial<{
  [M in StrictModifierNames]: Partial<Omit<StrictModifier<M>, "name">>;
 }>;
 
+/**
+ * Custom popper.js v2 modifier for Popover2 and Tooltip2.
+ *
+ * @see https://popper.js.org/docs/v2/modifiers/#custom-modifiers
+ */
+export type PopperCustomModifer = Partial<Modifier<any, object>>;
+
 // eslint-disable-next-line deprecation/deprecation
 export type Popover2TargetProps = IPopover2TargetProps;
 /**
@@ -169,7 +176,7 @@ export interface IPopover2SharedProps<TProps> extends OverlayableProps, Props {
  *
  * @see https://popper.js.org/docs/v2/modifiers/#custom-modifiers
  */
- modifiersCustom?: ReadonlyArray<Partial<Modifier<any, object>>>;
+ modifiersCustom?: readonly PopperCustomModifer[];
 
  /**
  * Callback invoked in controlled mode when the popover open state *would*