Display a color picker widget.
Function signature

st.color_picker(label, value=None, key=None, help=None, on_change=None, args=None, kwargs=None, *, disabled=False)

Parameters

label (str)

A short label explaining to the user what this input is for.

value (str)

The hex value of this widget when it first renders. If None, defaults to black.

key (str or int)

An optional string or integer to use as the unique key for the widget. If this is omitted, a key will be generated for the widget based on its content. Multiple widgets of the same type may not share the same key.

help (str)

An optional tooltip that gets displayed next to the color picker.

on_change (callable)

An optional callback invoked when this color_picker's value changes.

args (tuple)

An optional tuple of args to pass to the callback.

kwargs (dict)

An optional dict of kwargs to pass to the callback.

disabled (bool)

An optional boolean, which disables the color picker if set to True. The default is False. This argument can only be supplied by keyword.

Returns

(str)

The selected color as a hex string.

Example

color = st.color_picker('Pick A Color', '#00f900')
st.write('The current color is', color)
(view standalone Streamlit app)

Was this page helpful?

editSuggest edits
forum

Still have questions?

Our forums are full of helpful information and Streamlit experts.