@workday/canvas-kit-react
Version:
The parent module that contains all Workday Canvas Kit React components
41 lines • 1.85 kB
TypeScript
import * as React from 'react';
import { Placement, PopperOptions, PopperProps } from './Popper';
export interface PopupPopperProps extends PopperProps {
/**
* The placement of the `Popper` contents relative to the `anchorElement`. Accepts `auto`, `top`,
* `right`, `bottom`, or `left`. Each placement can also be modified using any of the following
* variations: `-start` or `-end`.
* @default bottom
*/
placement?: Placement;
/**
* Define fallback placements by providing a list of {@link Placement} in array (in order of preference).
* The default preference is following the order of `top`, `right`, `bottom`, and `left`. Once the initial
* and opposite placements are not available, the fallback placements will be in use. Use an empty array to
* disable the fallback placements.
*/
fallbackPlacements?: Placement[];
/**
* The additional options passed to the Popper's `popper.js` instance.
*/
popperOptions?: Partial<PopperOptions>;
}
export declare const PopupPopper: import("@workday/canvas-kit-react/common").ElementComponentM<"div", PopupPopperProps, {
state: {
stackRef: React.RefObject<HTMLDivElement>;
targetRef: React.RefObject<HTMLButtonElement>;
initialFocusRef: React.RefObject<any> | undefined;
returnFocusRef: React.RefObject<any> | undefined;
placement: import("@popperjs/core").Placement;
id: string;
visibility: "hidden" | "visible";
};
events: {
updatePlacement(data: {
placement: import("@popperjs/core").Placement;
}): void;
show(event?: Event | React.SyntheticEvent<Element, Event> | undefined): void;
hide(event?: Event | React.SyntheticEvent<Element, Event> | undefined): void;
};
}>;
//# sourceMappingURL=PopupPopper.d.ts.map