Skip to content

ColorPicker

An easy-to-use component that allows users to pick a custom color or choose from a predefined set of colors.

Properties

Color, AppearanceOverride

Use the Color and AppearanceOverride properties to style the component.

Available colors are white. Worth noting is that the Color property is not used for the component, but instead for the Tabs component that is used inside of it. As such, AppearanceOverrides for Tabs can be passed through an alternate property, TabsAppearanceOverride.

The theme data for the component can be found in the Theming section and can be overwritten through AppearanceOverride.

Pass Color as a string and AppearanceOverride as an optionalColorTable. More information on overrides can be found here.

TabsAppearance

The appearance override for the Tabs component.Theming info is available here.

Type

luau

Code block has not loaded. An error may have occurred.

HidePalette

Whether the color palette should be hidden, resulting in only the color picker being visible. This also hides the Tabs component.

Type

luau

Code block has not loaded. An error may have occurred.

Value

One-way Value

Type

luau

Code block has not loaded. An error may have occurred.

PaletteColors

This value defaults to a set of predefined colors, which is a list of pre-existing BrickColors. If you want to use a custom set of colors, you can pass a list of Color3s.

Type

luau

Code block has not loaded. An error may have occurred.

OnColorChange

Type

luau

Code block has not loaded. An error may have occurred.

OnColorSet

Type

luau

Code block has not loaded. An error may have occurred.

OnDragStart

Fired when the user starts dragging any handle.

Type

luau

Code block has not loaded. An error may have occurred.

OnDragEnd

Fired when the user stops dragging any handle. Do not use this as replacement for OnColorSet, as text changes will not trigger this event.

Type

luau

Code block has not loaded. An error may have occurred.

Instance Properties

This instance takes all the properties of a Frame. SpecialKeys, such as fusion.Children will also be passed to the instance.

Theming

States

StateDescription
Base
Hover

The hover state for a color palette button.

Press

The press state for a color palette button/

Colors

ColorDescription
PaletteBackground
Stroke
SliderHandle

This value manages the shadow and stroke of the slider handle. The stroke is automatically applied to the handle inside of the color palette

Background

The background overlay for color palette buttons.

Stroke

The stroke for color palette buttons.