|
| 1 | +## API Report File for "@fluentui/react-headless-components-preview" |
| 2 | + |
| 3 | +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). |
| 4 | +
|
| 5 | +```ts |
| 6 | + |
| 7 | +import type { ARIAButtonType } from '@fluentui/react-aria'; |
| 8 | +import type { ComponentProps } from '@fluentui/react-utilities'; |
| 9 | +import type { ComponentState } from '@fluentui/react-utilities'; |
| 10 | +import type { ContextSelector } from '@fluentui/react-context-selector'; |
| 11 | +import type { EventData } from '@fluentui/react-utilities'; |
| 12 | +import type { EventHandler } from '@fluentui/react-utilities'; |
| 13 | +import type { ForwardRefComponent } from '@fluentui/react-utilities'; |
| 14 | +import type { JSXElement } from '@fluentui/react-utilities'; |
| 15 | +import type { PopoverTriggerChildProps as PopoverTriggerChildProps_2 } from '@fluentui/react-popover'; |
| 16 | +import { PositioningShorthand } from '@fluentui/react-positioning'; |
| 17 | +import * as React_2 from 'react'; |
| 18 | +import type { Slot } from '@fluentui/react-utilities'; |
| 19 | +import type { TriggerProps } from '@fluentui/react-utilities'; |
| 20 | + |
| 21 | +// @public |
| 22 | +export type OnOpenChangeData = EventData<string, React_2.SyntheticEvent | Event> & { |
| 23 | + open: boolean; |
| 24 | +}; |
| 25 | + |
| 26 | +// @public |
| 27 | +export type OpenPopoverEvents = MouseEvent | TouchEvent | React_2.FocusEvent<HTMLElement> | React_2.KeyboardEvent<HTMLElement> | React_2.MouseEvent<HTMLElement>; |
| 28 | + |
| 29 | +// @public |
| 30 | +export const Popover: { |
| 31 | + (props: PopoverProps): JSXElement; |
| 32 | + displayName: string; |
| 33 | +}; |
| 34 | + |
| 35 | +// @public |
| 36 | +export type PopoverContextValue = Pick<PopoverState, 'open' | 'setOpen' | 'toggleOpen' | 'triggerRef' | 'contentRef' | 'arrowRef' | 'openOnHover' | 'openOnContext' | 'withArrow' | 'surfaceId'> & { |
| 37 | + positioning: { |
| 38 | + targetRef: React_2.RefCallback<HTMLElement>; |
| 39 | + containerRef: React_2.RefCallback<HTMLElement>; |
| 40 | + }; |
| 41 | +}; |
| 42 | + |
| 43 | +// @public |
| 44 | +export type PopoverProps = { |
| 45 | + children: [JSXElement, JSXElement] | JSXElement; |
| 46 | + open?: boolean; |
| 47 | + defaultOpen?: boolean; |
| 48 | + onOpenChange?: EventHandler<OnOpenChangeData>; |
| 49 | + openOnHover?: boolean; |
| 50 | + openOnContext?: boolean; |
| 51 | + mouseLeaveDelay?: number; |
| 52 | + positioning?: PositioningShorthand; |
| 53 | + withArrow?: boolean; |
| 54 | +}; |
| 55 | + |
| 56 | +// @public |
| 57 | +export type PopoverState = Required<Pick<PopoverProps, 'open'>> & Pick<PopoverProps, 'onOpenChange' | 'openOnContext' | 'openOnHover' | 'withArrow'> & { |
| 58 | + setOpen: (e: OpenPopoverEvents, open: boolean) => void; |
| 59 | + toggleOpen: (e: OpenPopoverEvents) => void; |
| 60 | + triggerRef: React_2.RefObject<HTMLElement | null>; |
| 61 | + contentRef: React_2.RefObject<HTMLElement | null>; |
| 62 | + arrowRef: React_2.RefObject<HTMLDivElement | null>; |
| 63 | + popoverTrigger: React_2.ReactElement | undefined; |
| 64 | + popoverSurface: React_2.ReactElement | undefined; |
| 65 | + contextTarget: { |
| 66 | + x: number; |
| 67 | + y: number; |
| 68 | + } | undefined; |
| 69 | + setContextTarget: (target: { |
| 70 | + x: number; |
| 71 | + y: number; |
| 72 | + } | undefined) => void; |
| 73 | + positioning: PositioningReturn; |
| 74 | + surfaceId: string; |
| 75 | +}; |
| 76 | + |
| 77 | +// @public |
| 78 | +export const PopoverSurface: ForwardRefComponent<PopoverSurfaceProps>; |
| 79 | + |
| 80 | +// @public (undocumented) |
| 81 | +export type PopoverSurfaceProps = ComponentProps<PopoverSurfaceSlots>; |
| 82 | + |
| 83 | +// @public |
| 84 | +export type PopoverSurfaceSlots = { |
| 85 | + root: Slot<'div'>; |
| 86 | +}; |
| 87 | + |
| 88 | +// @public (undocumented) |
| 89 | +export type PopoverSurfaceState = ComponentState<PopoverSurfaceSlots> & { |
| 90 | + withArrow: boolean | undefined; |
| 91 | + arrowRef: React_2.RefObject<HTMLDivElement | null>; |
| 92 | + 'data-open': string; |
| 93 | +}; |
| 94 | + |
| 95 | +// @public |
| 96 | +export const PopoverTrigger: React_2.FC<PopoverTriggerProps>; |
| 97 | + |
| 98 | +// @public |
| 99 | +export type PopoverTriggerProps = Omit<TriggerProps<PopoverTriggerChildProps>, 'children'> & { |
| 100 | + children: React_2.ReactElement; |
| 101 | + disableButtonEnhancement?: boolean; |
| 102 | +}; |
| 103 | + |
| 104 | +// @public |
| 105 | +export type PopoverTriggerState = { |
| 106 | + children: React_2.ReactElement | null; |
| 107 | +}; |
| 108 | + |
| 109 | +// @public |
| 110 | +export const renderPopover: (state: PopoverState, contextValues: { |
| 111 | + popover: PopoverContextValue; |
| 112 | +}) => React_2.ReactElement; |
| 113 | + |
| 114 | +// @public (undocumented) |
| 115 | +export const renderPopoverSurface: (state: PopoverSurfaceState) => JSXElement; |
| 116 | + |
| 117 | +// @public |
| 118 | +export const renderPopoverTrigger: (state: PopoverTriggerState) => JSXElement | null; |
| 119 | + |
| 120 | +// @public |
| 121 | +export const usePopover: (props: PopoverProps) => PopoverState; |
| 122 | + |
| 123 | +// @public |
| 124 | +export const usePopoverContext: <T>(selector: ContextSelector<PopoverContextValue, T>) => T; |
| 125 | + |
| 126 | +// @public (undocumented) |
| 127 | +export const usePopoverContextValues: (state: PopoverState) => { |
| 128 | + popover: PopoverContextValue; |
| 129 | +}; |
| 130 | + |
| 131 | +// @public |
| 132 | +export const usePopoverSurface: (props: PopoverSurfaceProps, ref: React_2.Ref<HTMLDivElement>) => PopoverSurfaceState; |
| 133 | + |
| 134 | +// @public |
| 135 | +export const usePopoverTrigger: (props: PopoverTriggerProps) => PopoverTriggerState; |
| 136 | + |
| 137 | +// (No @packageDocumentation comment for this package) |
| 138 | + |
| 139 | +``` |
0 commit comments