@wordpress/components
Version:
UI components for WordPress.
151 lines • 5.33 kB
TypeScript
import type { HeadingSize } from '../heading/types';
import type { CircularOptionPickerProps } from '../circular-option-picker/types';
export type GradientObject = {
gradient: string;
name: string;
slug: string;
};
export type OriginObject = {
name: string;
gradients: GradientObject[];
};
export type GradientsProp = GradientObject[] | OriginObject[];
type GradientPickerBaseProps = {
/**
* The class name added to the wrapper.
*/
className?: string;
/**
* The function called when a new gradient has been defined. It is passed
* the `currentGradient` as an argument. When a predefined gradient is
* selected, the second argument is its index (or, for multiple-origin
* gradients, the origin index) and the third argument is its slug.
*/
onChange: (currentGradient: string | undefined, index?: number, slug?: string) => void;
/**
* The current value of the gradient. Pass a css gradient string (See default value for example).
* Optionally pass in a `null` value to specify no gradient is currently selected.
*
* @default 'linear-gradient(135deg,rgba(6,147,227,1) 0%,rgb(155,81,224) 100%)'
*/
value?: GradientObject['gradient'] | null;
/**
* The slug of the currently selected predefined gradient.
*
* When set to a non-empty string, selection is determined by slug rather
* than by gradient value, which correctly handles palettes where two
* entries share the same gradient. Entries whose slug does not match will
* not appear selected in this mode, even if their gradient value matches
* `value`.
*
* An empty string is treated the same as `undefined`: selection falls
* back to matching by gradient value.
*/
selectedSlug?: string;
/**
* Whether the palette should have a clearing button or not.
*
* @default true
*/
clearable?: boolean;
/**
* The heading level. Only applies in cases where gradients are provided
* from multiple origins (i.e. when the array passed as the `gradients` prop
* contains two or more items).
*
* @default 2
*/
headingLevel?: HeadingSize;
/**
* How predefined gradient 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. `value` and `selectedSlug` do not mark predefined swatches as
* selected, and activating a swatch always calls `onChange` with that
* swatch. `value` still controls the custom gradient picker.
*
* @default 'listbox'
*/
presentation?: CircularOptionPickerProps['presentation'];
/**
* 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;
/**
* Whether to enable alpha transparency options in the picker.
*
* @default true
*/
enableAlpha?: boolean;
} & ({
/**
* A label to identify the purpose of the control.
*/
'aria-label'?: string;
'aria-labelledby'?: never;
} | {
/**
* An ID of an element to provide a label for the control.
*/
'aria-labelledby'?: string;
'aria-label'?: never;
});
export type GradientPickerComponentProps = GradientPickerBaseProps & {
/**
* An array of objects as predefined gradients displayed above the gradient
* selector. Alternatively, if there are multiple sets (or 'origins') of
* gradients, you can pass an array of objects each with a `name` and a
* `gradients` array which will in turn contain the predefined gradient objects.
*
* @default []
*/
gradients?: GradientsProp;
/**
* Start opting in to the new margin-free styles that will become the default
* in a future version, currently scheduled to be WordPress 6.4. (The prop
* can be safely removed once this happens.)
*
* @default false
* @deprecated Default behavior since WP 6.5. Prop can be safely removed.
* @ignore
*/
__nextHasNoMargin?: boolean;
/**
* If true, the gradient picker will not be displayed and only defined
* gradients from `gradients` will be shown.
*
* @default false
*/
disableCustomGradients?: boolean;
/**
* Whether this is rendered in the sidebar.
*
* @default false
*/
__experimentalIsRenderedInSidebar?: boolean;
};
export type PickerProps<TOriginType extends GradientObject | OriginObject> = GradientPickerBaseProps & {
clearGradient: () => void;
onChange: (currentGradient: string | undefined, index: number, slug?: string) => void;
actions?: React.ReactNode;
gradients: TOriginType[];
};
export {};
//# sourceMappingURL=types.d.ts.map