Skip to main content
On this pageConstants

Ui/Popover/test

Constants

AnchorPopover

constsource
/**
 * The anchor-positioning Mount this Popover renders on its panel. Exposed so
 *  Scene tests can call `Scene.Mount.resolve(AnchorPopover, CompletedAnchorPopover())`
 *  to acknowledge the mount produced by the rendered panel.
 */
const AnchorPopover: LayeredMountDefinitionWithArgs<"Popover/AnchorPopover", {
  anchor: Struct<{
    gap: optional<Number>
    isPlacementLocked: optional<Boolean>
    offset: optional<Number>
    padding: optional<Union<readonly [
      Number,
      Struct<{
        bottom: optionalKey<unknown>
        left: optionalKey<unknown>
        right: optionalKey<unknown>
        top: optionalKey<unknown>
      }>
    ]>>
    placement: optional<Literals<readonly ["top", "right", "bottom", "left", "top-start", "top-end", "right-start", "right-end", "bottom-start", "bottom-end", "left-start", "left-end"]>>
    portal: optional<Boolean>
  }>
  arrowId: optional<String>
  arrowPadding: optional<Number>
  buttonId: String
  focusSelector: optional<String>
}, {
  _tag: "CompletedAnchorPopover"
}> & Readonly<{
  layer: Layer<Handler<"Popover/AnchorPopover", Readonly<{
    element: Element
    viewStateChanges: Stream<"Live" | "Paused">
  }> & {
    anchor: Anchor.AnchorConfig
    arrowId: string
    arrowPadding: number
    buttonId: string
    focusSelector: string
  }, {
    _tag: "CompletedAnchorPopover"
  }>, never, never>
}>

DetectPopoverMovementOrAnimationEnd

constsource
/** Detects whether the popover button moved or the leave animation ended. Whichever comes first; both outcomes signal the Animation block that leave is complete. */
const DetectPopoverMovementOrAnimationEnd: LayeredCommandDefinitionWithArgs<"Popover/DetectPopoverMovementOrAnimationEnd", {
  generation: Number
  id: String
}, {
  _tag: "CompletedDetectPopoverMovementOrAnimationEnd"
  generation: number
}> | DefinitionWithArgsNameKeyed<"Popover/DetectPopoverMovementOrAnimationEnd", {
  generation: Number
  id: String
}, Effect<{
  _tag: "CompletedDetectPopoverMovementOrAnimationEnd"
  generation: number
}, never, Handler<"Popover/DetectPopoverMovementOrAnimationEnd", {
  generation: number
  id: string
}, {
  _tag: "CompletedDetectPopoverMovementOrAnimationEnd"
  generation: number
}>>> | DefinitionWithArgs<"Popover/DetectPopoverMovementOrAnimationEnd", {
  generation: Number
  id: String
}, Pick<{
  generation: number
  id: string
}, "id" | "generation">, Effect<{
  _tag: "CompletedDetectPopoverMovementOrAnimationEnd"
  generation: number
}, never, Handler<"Popover/DetectPopoverMovementOrAnimationEnd", {
  generation: number
  id: string
}, {
  _tag: "CompletedDetectPopoverMovementOrAnimationEnd"
  generation: number
}>>> & Readonly<{
  layer: Layer<Handler<"Popover/DetectPopoverMovementOrAnimationEnd", {
    generation: number
    id: string
  }, {
    _tag: "CompletedDetectPopoverMovementOrAnimationEnd"
    generation: number
  }>, never, never>
}> & Readonly<{
  toLayer: ToLayer<"Popover/DetectPopoverMovementOrAnimationEnd", {
    generation: number
    id: string
  }, {
    _tag: "CompletedDetectPopoverMovementOrAnimationEnd"
    generation: number
  }>
}>

FocusPopoverButton

constsource
/** Moves focus back to the popover button after closing. */
const FocusPopoverButton: LayeredCommandDefinitionWithArgs<"Popover/FocusPopoverButton", {
  id: String
}, {
  _tag: "CompletedFocusPopoverButton"
}> | DefinitionWithArgsNameKeyed<"Popover/FocusPopoverButton", {
  id: String
}, Effect<{
  _tag: "CompletedFocusPopoverButton"
}, never, Handler<"Popover/FocusPopoverButton", {
  id: string
}, {
  _tag: "CompletedFocusPopoverButton"
}>>> | DefinitionWithArgs<"Popover/FocusPopoverButton", {
  id: String
}, Pick<{
  id: string
}, "id">, Effect<{
  _tag: "CompletedFocusPopoverButton"
}, never, Handler<"Popover/FocusPopoverButton", {
  id: string
}, {
  _tag: "CompletedFocusPopoverButton"
}>>> & Readonly<{
  layer: Layer<Handler<"Popover/FocusPopoverButton", {
    id: string
  }, {
    _tag: "CompletedFocusPopoverButton"
  }>, never, never>
}> & Readonly<{
  toLayer: ToLayer<"Popover/FocusPopoverButton", {
    id: string
  }, {
    _tag: "CompletedFocusPopoverButton"
  }>
}>

FocusPopoverPanel

constsource
/** Moves focus to the popover panel after opening. */
const FocusPopoverPanel: LayeredCommandDefinitionWithArgs<"Popover/FocusPopoverPanel", {
  id: String
}, {
  _tag: "CompletedFocusPopoverPanel"
}> | DefinitionWithArgsNameKeyed<"Popover/FocusPopoverPanel", {
  id: String
}, Effect<{
  _tag: "CompletedFocusPopoverPanel"
}, never, Handler<"Popover/FocusPopoverPanel", {
  id: string
}, {
  _tag: "CompletedFocusPopoverPanel"
}>>> | DefinitionWithArgs<"Popover/FocusPopoverPanel", {
  id: String
}, Pick<{
  id: string
}, "id">, Effect<{
  _tag: "CompletedFocusPopoverPanel"
}, never, Handler<"Popover/FocusPopoverPanel", {
  id: string
}, {
  _tag: "CompletedFocusPopoverPanel"
}>>> & Readonly<{
  layer: Layer<Handler<"Popover/FocusPopoverPanel", {
    id: string
  }, {
    _tag: "CompletedFocusPopoverPanel"
  }>, never, never>
}> & Readonly<{
  toLayer: ToLayer<"Popover/FocusPopoverPanel", {
    id: string
  }, {
    _tag: "CompletedFocusPopoverPanel"
  }>
}>

InertPopoverOthers

constsource
/** Marks all elements outside the popover as inert for modal behavior. */
const InertPopoverOthers: LayeredCommandDefinitionWithArgs<"Popover/InertPopoverOthers", {
  id: String
}, {
  _tag: "CompletedInertPopoverOthers"
}> | DefinitionWithArgsNameKeyed<"Popover/InertPopoverOthers", {
  id: String
}, Effect<{
  _tag: "CompletedInertPopoverOthers"
}, never, Handler<"Popover/InertPopoverOthers", {
  id: string
}, {
  _tag: "CompletedInertPopoverOthers"
}>>> | DefinitionWithArgs<"Popover/InertPopoverOthers", {
  id: String
}, Pick<{
  id: string
}, "id">, Effect<{
  _tag: "CompletedInertPopoverOthers"
}, never, Handler<"Popover/InertPopoverOthers", {
  id: string
}, {
  _tag: "CompletedInertPopoverOthers"
}>>> & Readonly<{
  layer: Layer<Handler<"Popover/InertPopoverOthers", {
    id: string
  }, {
    _tag: "CompletedInertPopoverOthers"
  }>, never, never>
}> & Readonly<{
  toLayer: ToLayer<"Popover/InertPopoverOthers", {
    id: string
  }, {
    _tag: "CompletedInertPopoverOthers"
  }>
}>

LockPopoverScroll

constsource
/** Prevents page scrolling while the popover is open in modal mode. */
const LockPopoverScroll: LayeredCommandDefinitionNoArgs<"Popover/LockPopoverScroll", {
  _tag: "CompletedLockPopoverScroll"
}> | DefinitionNoArgs<"Popover/LockPopoverScroll", Effect<{
  _tag: "CompletedLockPopoverScroll"
}, never, Handler<"Popover/LockPopoverScroll", void, {
  _tag: "CompletedLockPopoverScroll"
}>>> & Readonly<{
  toLayer: ToLayer<"Popover/LockPopoverScroll", void, {
    _tag: "CompletedLockPopoverScroll"
  }>
}> & Readonly<{
  layer: Layer<Handler<"Popover/LockPopoverScroll", void, {
    _tag: "CompletedLockPopoverScroll"
  }>, never, never>
}> & Readonly<{
  toLayer: ToLayer<"Popover/LockPopoverScroll", void, {
    _tag: "CompletedLockPopoverScroll"
  }>
}>

PortalPopoverBackdrop

constsource
/**
 * The backdrop-portaling Mount this Popover renders. Exposed so Scene tests can
 *  call `Scene.Mount.resolve(PortalPopoverBackdrop, CompletedPortalPopoverBackdrop())` to
 *  acknowledge the mount produced by the rendered backdrop.
 */
const PortalPopoverBackdrop: LayeredMountDefinitionNoArgs<"Popover/PortalPopoverBackdrop", {
  _tag: "CompletedPortalPopoverBackdrop"
}> & Readonly<{
  layer: Layer<Handler<"Popover/PortalPopoverBackdrop", Readonly<{
    element: Element
    viewStateChanges: Stream<"Live" | "Paused">
  }>, {
    _tag: "CompletedPortalPopoverBackdrop"
  }>, never, never>
}>

RestorePopoverInert

constsource
/** Removes the inert attribute from elements outside the Popover. */
const RestorePopoverInert: LayeredCommandDefinitionWithArgs<"Popover/RestorePopoverInert", {
  id: String
}, {
  _tag: "CompletedRestorePopoverInert"
}> | DefinitionWithArgsNameKeyed<"Popover/RestorePopoverInert", {
  id: String
}, Effect<{
  _tag: "CompletedRestorePopoverInert"
}, never, Handler<"Popover/RestorePopoverInert", {
  id: string
}, {
  _tag: "CompletedRestorePopoverInert"
}>>> | DefinitionWithArgs<"Popover/RestorePopoverInert", {
  id: String
}, Pick<{
  id: string
}, "id">, Effect<{
  _tag: "CompletedRestorePopoverInert"
}, never, Handler<"Popover/RestorePopoverInert", {
  id: string
}, {
  _tag: "CompletedRestorePopoverInert"
}>>> & Readonly<{
  layer: Layer<Handler<"Popover/RestorePopoverInert", {
    id: string
  }, {
    _tag: "CompletedRestorePopoverInert"
  }>, never, never>
}> & Readonly<{
  toLayer: ToLayer<"Popover/RestorePopoverInert", {
    id: string
  }, {
    _tag: "CompletedRestorePopoverInert"
  }>
}>

UnlockPopoverScroll

constsource
/** Re-enables page scrolling after the popover closes. */
const UnlockPopoverScroll: LayeredCommandDefinitionNoArgs<"Popover/UnlockPopoverScroll", {
  _tag: "CompletedUnlockPopoverScroll"
}> | DefinitionNoArgs<"Popover/UnlockPopoverScroll", Effect<{
  _tag: "CompletedUnlockPopoverScroll"
}, never, Handler<"Popover/UnlockPopoverScroll", void, {
  _tag: "CompletedUnlockPopoverScroll"
}>>> & Readonly<{
  toLayer: ToLayer<"Popover/UnlockPopoverScroll", void, {
    _tag: "CompletedUnlockPopoverScroll"
  }>
}> & Readonly<{
  layer: Layer<Handler<"Popover/UnlockPopoverScroll", void, {
    _tag: "CompletedUnlockPopoverScroll"
  }>, never, never>
}> & Readonly<{
  toLayer: ToLayer<"Popover/UnlockPopoverScroll", void, {
    _tag: "CompletedUnlockPopoverScroll"
  }>
}>