| Name | Type | Default | Description |
|---|
| Editable | bool | false | This property allows editting of colors via the input inside the element's action section. Accepts values in all supported types. This property works when 'valueDisplayMode' is set to default or colorCode. |
| AutoCloseDelay | int | 100 | Determines the delay before the opened drop down closes when dropDownOpenMode is set to 'auto'. |
| ApplyValueMode | ColorApplyValueMode | ColorApplyValueMode.Instantly | Specifies how the user applies the selected value. In 'instantly' mode the value is applied immediately when color is selected. In 'useButtons' mode are shown 'Ok' and 'Cancel' buttons at the botom of the colorpicker's drop down. Only click on 'OK' button applies the value. |
| ColumnCount | int | 8 | Defines the number of columns for the colors in displayModes 'grid', 'hexagonal' and 'spectrumGrid'. |
| DisplayMode | ColorDisplayMode | ColorDisplayMode.Default | Determines the colors that will be displayed and their layout. |
| Disabled | bool | false | Enables or disables the element. |
| DisableUndo | bool | false | By default clicking on color panel's preview container returns the color value to it's previous state. 'disableUndo' prevents this functionality. |
| DropDownAppendTo | string | "body" | Sets the parent container of the dropDown (the popup). The expected value is CSS Selector, ID or 'body'. Used when a CSS property of unknowned parent is interfering with the visibility of the dropDown. Example: 'body'. |
| DropDownOpenMode | DropDownOpenMode | DropDownOpenMode.Default | Determines how the drop down is going to open. |
| DropDownButtonPosition | DropDownButtonPosition | DropDownButtonPosition.Right | Determines the position of the drop down button. |
| DropDownPosition | DropDownPosition | DropDownPosition.Auto | Determines the vertical position of the dropDown. 'Auto' means its automatically determined depending on the viewport size. |
| DropDownHeight | string | "auto" | Sets the height of the drop down. Default value of null means that CSS variables are used. This property should be used when the browser doesn not support CSS variables. |
| DropDownOverlay | bool | false | If this property is enabled, when the element's dropdown is opened, a transparent overlay is positioned between the dropdown and the rest of the document. |
| DropDownWidth | string | "auto" | Sets the width of the drop down. Default value of null means that CSS variables are used. This property should be used when the browser doesn't support CSS variables. |
| EditAlphaChannel | bool | false | Allows to edit the alpha(transparency) of the colors via an editor/slider in the following displayModes: 'palette', 'radial', 'hexagonal' |
| EnableCustomColors | bool | false | Allows to select a custom color via an editor popup. Custom color selection is available in modes that don't have this option by default, like: 'grid', 'default, 'spectrum grid'. |
| GridThemeColors | string[] | new string[]{} | Defines an Array of colors that will be used as the Theme Colors in the corresponding section of displayMode: 'grid' and 'default'. |
| GridShadeColors | string[] | new string[]{} | Defines an Array of colors that will be used as the Shade Colors in the corresponding section of displayMode: 'grid' and 'default'. |
| GridStandardColors | string[] | new string[]{} | Defines an Array of colors that will be used as the Standart Colors in the corresponding section of displayMode: 'grid' and 'default'. |
| HideAlphaEditor | bool | false | Hides the alpha editor. Alpha editor is an input containing the value of the current color opacity. The input is available in the following modes: 'radial', 'palette', 'hexagonal'. The input is only visible if there's enough space. This editor is visible by default. |
| HideContentToFit | string[] | new string[]{} | Determines which color editors will be hidden first when there's not enough space for all of them to be visible. By default the editors are only visible in 'palette', 'radial' and 'hexagonal' display modes. This property allows to prioritize the visibility of the editors. |
| HideHEXEditor | bool | false | HEX editor is an input containing the hexadecimal representation of a color. This editor is visible by default. Setting 'hideRGBeditor' to true hides it. |
| HidePreviewContainer | bool | false | Hides the preview container. Preview container is used to show the currently selected value in 'palette', 'radial' and 'hexagonal' display modes. |
| HideRGBEditor | bool | false | Hides the RGB editor. This editor is a group of three separate inputs for the Red, Green and Blue values of the color. |
| Hint | string | "" | Sets additional helper text below the element that is only visible when the element is focused. |
| Inverted | bool | false | Inverts the colors in 'spectrumGrid', 'hexagonal', 'radial' modes. |
| Label | string | "" | Sets a label above the element. |
| Locale | string | "en" | Sets or gets the language. Used in conjunction with the property messages. |
| Messages | object | N/A | Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale. |
| Name | string | "" | Sets or gets the name attribute for the element. Name is used when submiting HTML forms. |
| IsOpened | bool | false | Determines whether the popup is opened or closed |
| Palette | ColorPalette | ColorPalette.Default | Determines what colors will be displayed in 'spectrumGrid', 'grid' and 'hexagonal' displayModes. |
| PaletteColors | IEnumerable<object> | N/A | Defines an array of colors that form a custom palette. This palette can be used in displayModes 'grid' and 'spectrum grid' if the palette property is set to custom. The value of the property can be an array of strings or objects that contain valid colors ( HEX, RGBA, etc). |
| PaletteCustomColors | string[] | new string[]{} | Defines an array of colors that represent a predefined list of custom colors. This palette can be used in displayModes 'grid', 'default' and 'spectrum grid'. Custom colors are displayed at the bottom of the color grid below the button for custom color selection. They are only visible if enableCustomColor property is true. |
| Placeholder | string | "" | The placeholder is shown when the value is not set yet or is set to null. |
| Readonly | bool | false | Disables user interaction with the element. |
| ResizeIndicator | bool | false | Determines whether the resize indicator in the bottom right corner of the drop down is visible or not. This property is used in conjunction with resizeMode. |
| ResizeMode | ResizeMode | ResizeMode.Null | Determines whether the dropDown can be resized or not. When resizing is enabled, a resize bar appears on the top/bottom side of the drop down. |
| RightToLeft | bool | false | Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts. |
| Theme | string | "" | Determines the theme. Theme defines the look of the element |
| TooltipDisplayMode | ColorTooltipDisplayMode | ColorTooltipDisplayMode.Hex | Determines how the tooltip displays the value of the color that is being hovered. |
| Unfocusable | bool | false | If is set to true, the element cannot be focused. |
| Value | string | "null" | Represents the value of the selected color as the value of the element. |
| ValueFormat | ColorValueFormat | ColorValueFormat.Default | Determines the format of the color. Whether it's in HEX, RGB or RGBA. By default it shows the color depending on the displayMode. |
| ValueDisplayMode | ColorValueDisplayMode | ColorValueDisplayMode.Default | Determines which elements will be displayed in color picker's action section. |
| Name | Type | Description | Event Detail |
|---|
| OnActionButtonClick | EventCallback<Event> | This event is triggered when user clicks on the action button. 'Ok' button is visible only when "applyValueMode" is set to "useButtons". | N/A |
| ActionButtonClicked | event ColorPickerActionButtonClickedEventHandler | This event is triggered when user clicks on the action button. 'Ok' button is visible only when "applyValueMode" is set to "useButtons". | ColorPickerActionButtonClickedEventArgs |
| OnCancelButtonClick | EventCallback<Event> | This event is triggered when the cancel button is clicked. 'Cancel' button is visible only when "applyValueMode" is set to "useButtons". | N/A |
| CancelButtonClicked | event ColorPickerCancelButtonClickedEventHandler | This event is triggered when the cancel button is clicked. 'Cancel' button is visible only when "applyValueMode" is set to "useButtons". | ColorPickerCancelButtonClickedEventArgs |
| OnChange | EventCallback<Event> | This event is triggered when the color value is changed. | dynamic oldValue- The previously selected color., dynamic value- The new selected color. |
| Changed | event ColorPickerChangedEventHandler | This event is triggered when the color value is changed. | ColorPickerChangedEventArgs |
| OnClose | EventCallback<Event> | This event is triggered when the drop down is closed. | N/A |
| Closed | event ColorPickerClosedEventHandler | This event is triggered when the drop down is closed. | ColorPickerClosedEventArgs |
| OnClosing | EventCallback<Event> | This event is triggered when the drop down is about to be closed. This event allows to cancel the closing operation calling event.preventDefault() in the event handler function. | N/A |
| Closing | event ColorPickerClosingEventHandler | This event is triggered when the drop down is about to be closed. This event allows to cancel the closing operation calling event.preventDefault() in the event handler function. | ColorPickerClosingEventArgs |
| OnCustomColorSelection | EventCallback<Event> | This event is triggered when the custom color selection view is opened/closed. Custom color selection view is available when "enableCustomColors" property is true. | dynamic value- A boolean that indicates whether the custom color view is shown or not. |
| CustomColorSelectioned | event ColorPickerCustomColorSelectionedEventHandler | This event is triggered when the custom color selection view is opened/closed. Custom color selection view is available when "enableCustomColors" property is true. | ColorPickerCustomColorSelectionedEventArgs |
| OnDropDownButtonClick | EventCallback<Event> | This event is triggered when user clicks on the drop down button. | N/A |
| DropDownButtonClicked | event ColorPickerDropDownButtonClickedEventHandler | This event is triggered when user clicks on the drop down button. | ColorPickerDropDownButtonClickedEventArgs |
| OnOkButtonClick | EventCallback<Event> | This event is triggered when the ok button is clicked. | N/A |
| OkButtonClicked | event ColorPickerOkButtonClickedEventHandler | This event is triggered when the ok button is clicked. | ColorPickerOkButtonClickedEventArgs |
| OnOpen | EventCallback<Event> | This event is triggered when the drop down is opened. | N/A |
| Opened | event ColorPickerOpenedEventHandler | This event is triggered when the drop down is opened. | ColorPickerOpenedEventArgs |
| OnOpening | EventCallback<Event> | This event is triggered when the drop down is about to be opened. This event allows to cancel the opening operation calling event.preventDefault() in the event handler function. | N/A |
| Opening | event ColorPickerOpeningEventHandler | This event is triggered when the drop down is about to be opened. This event allows to cancel the opening operation calling event.preventDefault() in the event handler function. | ColorPickerOpeningEventArgs |
| OnResizeStart | EventCallback<Event> | This event is triggered when user starts resizing the drop down. | dynamic position- An object containing the current left and top positions of the drop down. |
| ResizeStarted | event ColorPickerResizeStartedEventHandler | This event is triggered when user starts resizing the drop down. | ColorPickerResizeStartedEventArgs |
| OnResizeEnd | EventCallback<Event> | This event is triggered when the resizing of the drop down is finished. | dynamic position- An object containing the current left and top positions of the drop down. |
| ResizeEnded | event ColorPickerResizeEndedEventHandler | This event is triggered when the resizing of the drop down is finished. | ColorPickerResizeEndedEventArgs |