UNPKG

@patternfly/react-core

Version:

This library provides a set of common React components for use with the PatternFly reference implementation.

48 lines 2.19 kB
import * as React from 'react'; import { OUIAProps } from '../../../helpers'; export declare enum OptionsMenuPosition { right = "right", left = "left" } export declare enum OptionsMenuDirection { up = "up", down = "down" } export interface OptionsMenuProps extends React.HTMLProps<HTMLDivElement>, OUIAProps { /** Classes applied to root element of the options menu */ className?: string; /** Id of the root element of the options menu */ id: string; /** Array of OptionsMenuItem and/or OptionMenuGroup nodes that will be rendered in the options menu list */ menuItems: React.ReactNode[]; /** Either an OptionsMenuToggle or an OptionsMenuToggleWithText to use to toggle the options menu */ toggle: React.ReactElement; /** Flag to indicate the toggle has no border or background */ isPlain?: boolean; /** Flag to indicate if menu is open */ isOpen?: boolean; /** Flag to indicate if toggle is textual toggle */ isText?: boolean; /** Flag to indicate if menu is groupped */ isGrouped?: boolean; /** Indicates where menu will be aligned horizontally */ position?: 'right' | 'left'; /** Menu will open up or open down from the options menu toggle */ direction?: 'up' | 'down'; /** The container to append the menu to. Defaults to 'inline'. * If your menu is being cut off you can append it to an element higher up the DOM tree. * Some examples: * menuAppendTo="parent" * menuAppendTo={() => document.body} * menuAppendTo={document.getElementById('target')} */ menuAppendTo?: HTMLElement | (() => HTMLElement) | 'inline' | 'parent'; /** z-index of the options menu when menuAppendTo is not inline. */ zIndex?: number; /** Value to overwrite the randomly generated data-ouia-component-id.*/ ouiaId?: number | string; /** Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false. */ ouiaSafe?: boolean; } export declare const OptionsMenu: React.FunctionComponent<OptionsMenuProps>; //# sourceMappingURL=OptionsMenu.d.ts.map