@progress/kendo-react-inputs 5.6.0-dev.202208251227 → 5.7.0-sig.202208281415

package/docs/api/ColorPickerProps.md

@@ -0,0 +1,1078 @@
+---
+title: ColorPickerProps
+description: "Learn how to build custom functionality when working with the React Inputs by Kendo UI with the help of the ColorPickerProps."
+api_reference: true
+type: inner_api
+slug: api_inputs_colorpickerprops
+---
+
+# ColorPickerProps
+Represents the props of the [KendoReact ColorPicker component]({% slug overview_colorpicker %}).
+
+
+<table class="api-table api-table-properties">
+<thead>
+<tr>
+<th class="th-name">Name</th>
+<th class="th-type">Type</th>
+<th class="th-default">Default</th>
+<th class="th-desc">Description</th>
+</tr>
+</thead>
+<tbody class="api-table-body">
+<tr>
+<td class="table-cell-name">
+
+
+#### ariaDescribedBy?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Identifies the element(s) which will describe the component, similar to [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-describedby_attribute).
+For example these elements could contain error or hint message.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### ariaLabelledBy?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Identifies the element(s) which will label the component.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### defaultValue?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+The default value of the ColorPicker
+([see example]({% slug default_value_colorpicker %})).
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### dir?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Represents the `dir` HTML attribute.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### disabled?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+boolean
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Sets the disabled state of the ColorPicker
+([see example]({% slug disabled_colorpicker %})).
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### fillMode?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+"null" | "flat" | "outline" | "solid"
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+<code>
+
+
+`solid`
+
+
+</code>
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Configures the `fillMode` of the ColorPicker.
+
+The available options are:
+- solid
+- outline
+- flat
+- null&mdash;Does not set a fillMode `className`.
+
+
+
+
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### gradientSettings?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+[ColorPickerGradientSettings]({% slug api_inputs_colorpickergradientsettings %})
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Configures the ColorGradient that is displayed in the ColorPicker popup
+([see example]({% slug customizecolorpicker_colorpicker %}#toc-customizing-the-gradient-popup)).
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### icon?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Defines the name of an [existing icon in the KendoReact theme]({% slug icons %}).
+You have to provide only the name of the icon without the `k-icon` or the `k-i-` prefixes.
+For example, `edit-tools` will be parsed to `k-icon k-i-edit-tools`
+([see example]({% slug customizecolorpicker_colorpicker %}#toc-displaying-kendo-ui-icons)).
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### iconClassName?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+The class name which displays an icon in the ColorPicker button
+([see example]({% slug customizecolorpicker_colorpicker %}#toc-displaying-custom-icons)).
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### id?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Specifies the id of the component.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### open?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+boolean
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Sets the open and close state of the ColorPicker.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### paletteSettings?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+[ColorPickerPaletteSettings]({% slug api_inputs_colorpickerpalettesettings %})
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Configures the ColorPalette that is displayed in the ColorPicker popup
+([see example]({% slug customizecolorpicker_colorpicker %}#toc-customizing-the-palette-popup)).
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### popupSettings?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+[ColorPickerPopupSettings]({% slug api_inputs_colorpickerpopupsettings %})
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Configures the popup of the ColorPicker.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### rounded?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+"null" | "small" | "medium" | "full" | "large"
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+<code>
+
+
+`medium`
+
+
+</code>
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Configures the `roundness` of the ColorPicker.
+
+The available options are:
+- small
+- medium
+- large
+- full
+- null&mdash;Does not set a rounded `className`.
+
+
+
+
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### size?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+"null" | "small" | "medium" | "large"
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+<code>
+
+
+`medium`
+
+
+</code>
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Configures the `size` of the ColorPicker.
+
+The available options are:
+- small
+- medium
+- large
+- null&mdash;Does not set a size `className`.
+
+
+
+
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### tabIndex?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+number
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Sets the `tabIndex` property of the ColorPicker.
+Defaults to `0`.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### title?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Sets the `title` property of the ColorPicker.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### valid?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+boolean
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Overrides the validity state of the component.
+If `valid` is set, the `required` property will be ignored.
+
+This property is part of the [FormComponentProps]({% slug api_common_formcomponentprops %}) interface.
+
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### value?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Specifies the value of the ColorPicker. Currently, only the RGBA format is supported.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### view?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+[ColorPickerView]({% slug api_inputs_colorpickerview %})
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Sets the view which the ColorPicker will render in the popup
+([see example]({% slug combinedview_colorpicker %})).
+
+
+</td>
+</tr>
+</tbody>
+</table>
+
+
+
+## Methods
+
+<table class="api-table api-table-methods">
+<thead class="api-table-methods-head">
+<tr>
+<th>
+
+
+#### onActiveColorClick
+
+
+</th>
+</tr>
+</thead>
+<tbody class="api-table-body">
+<tr>
+<td>
+
+
+The event handler that will be fired when the left side of the ColorPicker is clicked.
+
+
+</td>
+</tr>
+<tr class="nested-table">
+<td>
+<table class="api-table api-table-parameters">
+<thead class="api-table-parameters-head">
+<tr>
+<th class="th-name">Parameters</th>
+<th class="th-type"></th>
+<th class="th-desc"></th>
+</tr>
+</thead>
+<tbody class="api-table-body">
+<tr>
+<td>
+
+
+event
+
+
+</td>
+<td type>
+
+
+<code>
+
+
+[ColorPickerActiveColorClick]({% slug api_inputs_colorpickeractivecolorclick %})
+
+
+</code>
+
+
+</td>
+<td>
+
+
+
+
+
+</td>
+</tr>
+</tbody>
+</table>
+</td>
+</tr>
+
+</tbody>
+</table>
+
+<table class="api-table api-table-methods">
+<thead class="api-table-methods-head">
+<tr>
+<th>
+
+
+#### onBlur
+
+
+</th>
+</tr>
+</thead>
+<tbody class="api-table-body">
+<tr>
+<td>
+
+
+The event handler that will be fired when ColorPicker is blurred.
+
+
+</td>
+</tr>
+<tr class="nested-table">
+<td>
+<table class="api-table api-table-parameters">
+<thead class="api-table-parameters-head">
+<tr>
+<th class="th-name">Parameters</th>
+<th class="th-type"></th>
+<th class="th-desc"></th>
+</tr>
+</thead>
+<tbody class="api-table-body">
+<tr>
+<td>
+
+
+event
+
+
+</td>
+<td type>
+
+
+<code>
+
+
+[ColorPickerBlurEvent]({% slug api_inputs_colorpickerblurevent %})
+
+
+</code>
+
+
+</td>
+<td>
+
+
+
+
+
+</td>
+</tr>
+</tbody>
+</table>
+</td>
+</tr>
+
+</tbody>
+</table>
+
+<table class="api-table api-table-methods">
+<thead class="api-table-methods-head">
+<tr>
+<th>
+
+
+#### onChange
+
+
+</th>
+</tr>
+</thead>
+<tbody class="api-table-body">
+<tr>
+<td>
+
+
+The event handler that will be fired when the user edits the value.
+
+
+</td>
+</tr>
+<tr class="nested-table">
+<td>
+<table class="api-table api-table-parameters">
+<thead class="api-table-parameters-head">
+<tr>
+<th class="th-name">Parameters</th>
+<th class="th-type"></th>
+<th class="th-desc"></th>
+</tr>
+</thead>
+<tbody class="api-table-body">
+<tr>
+<td>
+
+
+event
+
+
+</td>
+<td type>
+
+
+<code>
+
+
+[ColorPickerChangeEvent]({% slug api_inputs_colorpickerchangeevent %})
+
+
+</code>
+
+
+</td>
+<td>
+
+
+
+
+
+</td>
+</tr>
+</tbody>
+</table>
+</td>
+</tr>
+
+</tbody>
+</table>
+
+<table class="api-table api-table-methods">
+<thead class="api-table-methods-head">
+<tr>
+<th>
+
+
+#### onFocus
+
+
+</th>
+</tr>
+</thead>
+<tbody class="api-table-body">
+<tr>
+<td>
+
+
+The event handler that will be fired when ColorPicker is focused.
+
+
+</td>
+</tr>
+<tr class="nested-table">
+<td>
+<table class="api-table api-table-parameters">
+<thead class="api-table-parameters-head">
+<tr>
+<th class="th-name">Parameters</th>
+<th class="th-type"></th>
+<th class="th-desc"></th>
+</tr>
+</thead>
+<tbody class="api-table-body">
+<tr>
+<td>
+
+
+event
+
+
+</td>
+<td type>
+
+
+<code>
+
+
+[ColorPickerFocusEvent]({% slug api_inputs_colorpickerfocusevent %})
+
+
+</code>
+
+
+</td>
+<td>
+
+
+
+
+
+</td>
+</tr>
+</tbody>
+</table>
+</td>
+</tr>
+
+</tbody>
+</table>
+
+
+