Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gradio-app/gradio/llms.txt

Use this file to discover all available pages before exploring further.

The CheckboxGroup component creates a set of checkboxes for selecting multiple options.

​
Basic usage

import gradio as gr

def show_selections(choices):
    return f"You selected: {', '.join(choices)}"

gr.Interface(
    fn=show_selections,
    inputs=gr.CheckboxGroup(["A", "B", "C"]),
    outputs=gr.Textbox()
).launch()

​
Constructor

​
choices
Sequence[str | int | float | tuple] | None
default:"None"
List of options. Can be values or (label, value) tuples
​
value
Sequence[str | float | int] | str | float | int | Callable | None
default:"None"
Default selected values as list, or single value
​
type
Literal['value', 'index']
default:"'value'"
Return type:
  • "value" - Returns list of selected values
  • "index" - Returns list of selected indices
​
label
str | None
default:"None"
Label displayed above component
​
show_select_all
bool
default:"False"
If True, shows select/deselect all checkbox

​
Events

  • change - Triggered when selection changes
  • input - Triggered on input
  • select - Triggered when checkbox is toggled

​
Example

import gradio as gr

gr.CheckboxGroup(
    choices=[
        ("Python", "py"),
        ("JavaScript", "js"),
        ("Java", "java")
    ],
    value=["py"],
    label="Programming languages",
    show_select_all=True
)

Build docs developers (and LLMs) love

Get started for freeTalk to us