> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sirius.menu/llms.txt
> Use this file to discover all available pages before exploring further.

# Color picker

> Pick a colour, and optionally alpha.

A color picker chooses a colour and, if you want it, an alpha. Drag the map and bars, or type into the fields.

<Frame>
  <img src="https://mintcdn.com/sirius-b451bfde/f6FV7zSG5WdJNsXv/images/gen2/colorpicker.png?fit=max&auto=format&n=f6FV7zSG5WdJNsXv&q=85&s=0c75824935a332ee0f8b9e97ffb4a3b7" alt="An open color picker with map, hue and alpha bars" width="705" height="730" data-path="images/gen2/colorpicker.png" />
</Frame>

```lua theme={null}
tab:CreateColorPicker({
    name = "Highlight",
    color = Color3.fromRGB(96, 205, 255),
    callback = function(color, alpha)
        print(color, alpha)
    end,
})
```

<Note>
  Color pickers are full-width and live at the tab level. Create them directly on the tab, not inside a group.
</Note>

## Properties

<ResponseField name="name" type="string">
  The label.
</ResponseField>

<ResponseField name="description" type="string">
  Hint text under the label. Optional.
</ResponseField>

<ResponseField name="icon" type="string | number">
  An icon shown beside the label. Optional.
</ResponseField>

<ResponseField name="color" type="Color3 | string">
  The initial colour. A hex string is accepted.
</ResponseField>

<ResponseField name="alpha" type="number" default="1">
  The initial alpha, from 0 to 1.
</ResponseField>

<ResponseField name="flag" type="string" default="name">
  The save key. Colour and alpha both persist. Optional.
</ResponseField>

<ResponseField name="forgetState" type="boolean" default="false">
  Skip saving.
</ResponseField>

<ResponseField name="callback" type="function">
  Runs with `(color, alpha)` on every change.
</ResponseField>

## Handle

<ResponseField name=".value" type="Color3">
  The current colour.
</ResponseField>

<ResponseField name=".alpha" type="number">
  The current alpha.
</ResponseField>

<ResponseField name="Set(color, skipCallback?)">
  Set the colour.
</ResponseField>

<ResponseField name="SetAlpha(alpha, skipCallback?)">
  Set the alpha.
</ResponseField>
