UNPKG

@wordpress/components

Version:
101 lines • 3.6 kB
import type { ReactNode } from 'react'; import type { Icon } from '@wordpress/icons'; import type { ButtonAsButtonProps } from '../button/types'; import type { DropdownProps } from '../dropdown/types'; import type { WordPressComponentProps } from '../context'; export type CircularOptionPickerProps = { /** * An ID to apply to the component. */ id?: string; /** * A CSS class to apply to the wrapper element. */ className?: string; /** * The action(s) to be rendered after the options, * such as a 'clear' button as seen in `ColorPalette`. * Usually a `CircularOptionPicker.ButtonAction` or * `CircularOptionPicker.DropdownLinkAction` component. */ actions?: ReactNode; /** * The options to be rendered, such as color swatches. * Usually a `CircularOptionPicker.Option` component. */ options: ReactNode; /** * The child elements. */ children?: ReactNode; /** * How the swatches behave and are exposed to assistive technology. * * - `listbox` uses one tab stop and arrow-key navigation, and exposes * selection with `aria-selected`. * - `toggle-buttons` gives each swatch a tab stop and exposes selection with * `aria-pressed`. * - `command-buttons` gives each swatch a tab stop and exposes no selection * state. Use it when swatches run commands such as opening an editor. * * @default 'listbox' */ presentation?: 'listbox' | 'toggle-buttons' | 'command-buttons'; /** * Whether the control should present as toggle buttons. * * @deprecated Use `presentation="toggle-buttons"` instead. An explicit * `presentation` takes precedence. * @default false * @ignore */ asButtons?: boolean; /** * Prevents keyboard interaction from wrapping around. * Only used with the `listbox` presentation. * * @default true */ loop?: boolean; /** * The ID reference list of one or more elements that label the wrapper * element. */ 'aria-labelledby'?: string; /** * The label for the wrapper element. Defaults to 'Custom color picker'. Not * used if an 'aria-labelledby' is provided. */ 'aria-label'?: string; }; type WithBaseId = { baseId: string; }; export type ListboxCircularOptionPickerProps = WithBaseId & Omit<CircularOptionPickerProps, 'asButtons' | 'presentation'>; export type ButtonsCircularOptionPickerProps = WithBaseId & Omit<CircularOptionPickerProps, 'asButtons' | 'presentation' | 'loop'> & { presentation: Exclude<NonNullable<CircularOptionPickerProps['presentation']>, 'listbox'>; }; export type DropdownLinkActionProps = { buttonProps?: Omit<WordPressComponentProps<ButtonAsButtonProps, 'button', false>, 'children'>; linkText: string; dropdownProps: Omit<DropdownProps, 'className' | 'renderToggle'>; className?: string; }; export type OptionGroupProps = { className?: string; options: ReactNode; }; export type OptionProps = Omit<WordPressComponentProps<ButtonAsButtonProps, 'button', false>, 'isPressed' | 'className'> & { className?: string; tooltipText?: string; isSelected?: boolean; selectedIconProps?: Omit<React.ComponentProps<typeof Icon>, 'icon' | 'size'>; }; export type CircularOptionPickerContextProps = { baseId?: string; activeId?: string | null | undefined; setActiveId?: (newId: string | null | undefined) => void; presentation?: CircularOptionPickerProps['presentation']; }; export {}; //# sourceMappingURL=types.d.ts.map