@ui5/webcomponents-react
Version:
React Wrapper for UI5 Web Components and additional components
54 lines (53 loc) • 2.41 kB
TypeScript
import '@ui5/webcomponents/dist/ColorPalette.js';
import type { ColorPaletteItemClickEventDetail } from '@ui5/webcomponents/dist/ColorPalette.js';
import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '@ui5/webcomponents-react-base';
import type { ReactNode } from 'react';
interface ColorPaletteAttributes {
/**
* Defines the accessible name of the component.
*
* **Note:** Available since [v2.20.0](https://github.com/UI5/webcomponents/releases/tag/v2.20.0) of **@ui5/webcomponents**.
* @default undefined
*/
accessibleName?: string | undefined;
/**
* Receives id(or many ids) of the elements that label the component.
*
* **Note:** Available since [v2.20.0](https://github.com/UI5/webcomponents/releases/tag/v2.20.0) of **@ui5/webcomponents**.
* @default undefined
*/
accessibleNameRef?: string | undefined;
}
interface ColorPaletteDomRef extends Required<ColorPaletteAttributes>, Ui5DomRef {
}
interface ColorPalettePropTypes extends ColorPaletteAttributes, Omit<CommonProps, keyof ColorPaletteAttributes | 'children' | 'onItemClick'> {
/**
* Defines the `ColorPaletteItem` elements.
*
* __Supported Node Type/s:__ `Array<ColorPaletteItem>`
*/
children?: ReactNode | ReactNode[];
/**
* Fired when the user selects a color.
*
* | cancelable | bubbles |
* | :--------: | :-----: |
* | ❌|❌|
*/
onItemClick?: (event: Ui5CustomEvent<ColorPaletteDomRef, ColorPaletteItemClickEventDetail>) => void;
}
/**
* The `ColorPalette` provides the users with a range of predefined colors. The colors are fixed and do not change with the theme.
*
* ### Usage
*
* The `ColorPalette` is meant for users that need to select a color from a predefined set.
* To define the colors, use the `ColorPaletteItem` component inside the default slot of the `ColorPalette`.
*
*
*
* __Note:__ This is a UI5 Web Component! [ColorPalette UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ColorPalette) | [Repository](https://github.com/UI5/webcomponents)
*/
declare const ColorPalette: import("react").ForwardRefExoticComponent<ColorPalettePropTypes & import("@ui5/webcomponents-react-base").WithWebComponentPropTypes & import("react").RefAttributes<ColorPaletteDomRef>>;
export { ColorPalette };
export type { ColorPaletteDomRef, ColorPalettePropTypes };