@app-studio/components
ColorInput
A form-integrated color picker component that allows users to select colors from a predefined palette or enter custom color values.
View component sourceImport
ts
import { ColorInput } from '@app-studio/components';New to the library? Complete installation and provider setup first.
Interactive examples
Try the component, then open Code to copy the complete example.
import React from 'react';
import { Vertical } from 'app-studio';
import { ColorInput } from '@app-studio/components';
export const DefaultColorInput = () => {
return (
<Vertical gap={16} width="300px">
<ColorInput
label="Background Color"
placeholder="Choose a color"
helperText="Select a background color for your theme"
/>
<ColorInput
label="Text Color"
defaultValue="color-gray-800"
helperText="Select a text color"
/>
<ColorInput
label="Accent Color"
defaultValue="color-blue-500"
showCustomInput={false}
helperText="Choose from predefined colors only"
/>
</Vertical>
);
};Props
Required props are marked below. A dash indicates an unspecified default. Design system configuration can override implementation defaults.
Scroll horizontally to see every column.
| Prop | Type | Default | Description |
|---|---|---|---|
id | string | — | See the type and source declaration for this property.Source |
error | any | false | Error state — usually a string for the error message, or a boolean toggle.Source |
helperText | string | — | Helper text rendered below the input (hint / error / explanation).Source |
name | string | — | Field name used by forms and Formik bindings.Source |
label | string | — | Visible label rendered alongside the input. Form-library wrappers (Switch, TextField, Checkbox, …) consume this. Not a native HTML attribute on <input>, but conventionally part of the form-control prop surface.Source |
placeholder | string | 'Select a color' | Hint displayed while the field is empty.Source |
isReadOnly | boolean | false | Keeps the value visible without allowing edits.Source |
isDisabled | boolean | false | Disables user interaction.Source |
isAutoFocus | boolean | — | See the type and source declaration for this property.Source |
onChange | ((value: string) => void) | — | Called with the new field value. Check the signature for the exact payload.Source |
onBlur | ((event: any) => void) | — | See the type and source declaration for this property.Source |
onClick | (() => void) | — | Called when the user activates the component.Source |
onFocus | (() => void) | — | See the type and source declaration for this property.Source |
size | Size"sm""md""lg""xs""xl" | 'md' | Size preset for the component.Source |
shadow | ViewProps | Shadow | Elevation | — | Shadow or elevation styling.Source |
shape | Shape"square""rounded""pill""default" | 'default' | Shape preset for the component.Source |
views | ColorInputStyles | {} | Style overrides for the named internal parts.Source |
value | string | — | Current controlled value. Update it from the matching change callback.Source |
defaultValue | string | — | Initial value for uncontrolled usage.Source |
variant | Variant"outline""default""none" | 'default' | Visual treatment of the component.Source |
predefinedColors | PredefinedColor[] | — | See the type and source declaration for this property.Source |
showCustomInput | boolean | true | See the type and source declaration for this property.Source |
showRecentColors | boolean | true | See the type and source declaration for this property.Source |
colorFormat | ColorFormat"hex""rgb""hsl" | — | See the type and source declaration for this property.Source |
maxRecentColors | number | — | See the type and source declaration for this property.Source |
closeOnSelect | boolean | — | See the type and source declaration for this property.Source |
onChangeComplete | ((color: string) => void) | — | See the type and source declaration for this property.Source |
onOpen | (() => void) | — | See the type and source declaration for this property.Source |
onClose | (() => void) | — | Called when the user requests dismissal.Source |
Common inherited styling props (6)
Scroll horizontally to see every column.
| Prop | Type | Default | Description |
|---|---|---|---|
media | Record<string, CssProps> | — | See the type and source declaration for this property. |
as | keyof JSX.IntrinsicElements"symbol""object""slot""style""title""pattern""form""animate""clipPath""filter""marker""mask""a""abbr""address""area""article""aside""audio""b""base""bdi""bdo""big""blockquote""body""br""button""canvas""caption""center""cite""code""col""colgroup""data""datalist""dd""del""details""dfn""dialog""div""dl""dt""em""embed""fieldset""figcaption""figure""footer""h1""h2""h3""h4""h5""h6""head""header""hgroup""hr""html""i""iframe""img""input""ins""kbd""keygen""label""legend""li""link""main""map""mark""menu""menuitem""meta""meter""nav""noindex""noscript""ol""optgroup""option""output""p""param""picture""pre""progress""q""rp""rt""ruby""s""samp""search""script""section""select""small""source""span""strong""sub""summary""sup""table""template""tbody""td""textarea""tfoot""th""thead""time""tr""track""u""ul""var""video""wbr""webview""svg""animateMotion""animateTransform""circle""defs""desc""ellipse""feBlend""feColorMatrix""feComponentTransfer""feComposite""feConvolveMatrix""feDiffuseLighting""feDisplacementMap""feDistantLight""feDropShadow""feFlood""feFuncA""feFuncB""feFuncG""feFuncR""feGaussianBlur""feImage""feMerge""feMergeNode""feMorphology""feOffset""fePointLight""feSpecularLighting""feSpotLight""feTile""feTurbulence""foreignObject""g""image""line""linearGradient""metadata""mpath""path""polygon""polyline""radialGradient""rect""set""stop""switch""text""textPath""tspan""use""view" | — | See the type and source declaration for this property. |
themeMode | "light" | "dark""light""dark" | — | See the type and source declaration for this property. |
_hover | string | CssProps | — | See the type and source declaration for this property. |
_active | string | CssProps | — | See the type and source declaration for this property. |
_focus | string | CssProps | — | See the type and source declaration for this property. |
For shared layout, color, and responsive properties, read Styling & composition and Responsive layouts. Additional native element attributes depend on the target platform.
Usage guidance
- Give controls a visible label or an accessible name, and verify keyboard interaction. See Accessibility.
- For controlled inputs, update the value from the callback shown in the props table. Keep application state in your component or form library.
- These previews run in the browser. Check React Native setup for platform requirements and differences.