# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022) # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. from dataclasses import dataclass from textwrap import dedent from typing import TYPE_CHECKING, Optional, cast from streamlit.elements.form import current_form_id from streamlit.elements.utils import ( check_callback_rules, check_session_state_rules, get_label_visibility_proto_value, ) from streamlit.proto.Checkbox_pb2 import Checkbox as CheckboxProto from streamlit.runtime.metrics_util import gather_metrics from streamlit.runtime.scriptrunner import ScriptRunContext, get_script_run_ctx from streamlit.runtime.state import ( WidgetArgs, WidgetCallback, WidgetKwargs, register_widget, ) from streamlit.type_util import Key, LabelVisibility, maybe_raise_label_warnings, to_key if TYPE_CHECKING: from streamlit.delta_generator import DeltaGenerator @dataclass class CheckboxSerde: value: bool def serialize(self, v: bool) -> bool: return bool(v) def deserialize(self, ui_value: Optional[bool], widget_id: str = "") -> bool: return bool(ui_value if ui_value is not None else self.value) class CheckboxMixin: @gather_metrics("checkbox") def checkbox( self, label: str, value: bool = False, key: Optional[Key] = None, help: Optional[str] = None, on_change: Optional[WidgetCallback] = None, args: Optional[WidgetArgs] = None, kwargs: Optional[WidgetKwargs] = None, *, # keyword-only arguments: disabled: bool = False, label_visibility: LabelVisibility = "visible", ) -> bool: r"""Display a checkbox widget. Parameters ---------- label : str A short label explaining to the user what this checkbox is for. The label can optionally contain Markdown and supports the following elements: Bold, Italics, Strikethroughs, Inline Code, Emojis, and Links. This also supports: * Emoji shortcodes, such as ``:+1:`` and ``:sunglasses:``. For a list of all supported codes, see https://share.streamlit.io/streamlit/emoji-shortcodes. * LaTeX expressions, by wrapping them in "$" or "$$" (the "$$" must be on their own lines). Supported LaTeX functions are listed at https://katex.org/docs/supported.html. * Colored text, using the syntax ``:color[text to be colored]``, where ``color`` needs to be replaced with any of the following supported colors: blue, green, orange, red, violet. Unsupported elements are unwrapped so only their children (text contents) render. Display unsupported elements as literal characters by backslash-escaping them. E.g. ``1\. Not an ordered list``. value : bool Preselect the checkbox when it first renders. This will be cast to bool internally. 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 checkbox. on_change : callable An optional callback invoked when this checkbox'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 checkbox if set to True. The default is False. This argument can only be supplied by keyword. label_visibility : "visible" or "hidden" or "collapsed" The visibility of the label. If "hidden", the label doesn't show but there is still empty space for it (equivalent to label=""). If "collapsed", both the label and the space are removed. Default is "visible". This argument can only be supplied by keyword. Returns ------- bool Whether or not the checkbox is checked. Example ------- >>> import streamlit as st >>> >>> agree = st.checkbox('I agree') >>> >>> if agree: ... st.write('Great!') .. output:: https://doc-checkbox.streamlitapp.com/ height: 220px """ ctx = get_script_run_ctx() return self._checkbox( label=label, value=value, key=key, help=help, on_change=on_change, args=args, kwargs=kwargs, disabled=disabled, label_visibility=label_visibility, ctx=ctx, ) def _checkbox( self, label: str, value: bool = False, key: Optional[Key] = None, help: Optional[str] = None, on_change: Optional[WidgetCallback] = None, args: Optional[WidgetArgs] = None, kwargs: Optional[WidgetKwargs] = None, *, # keyword-only arguments: disabled: bool = False, label_visibility: LabelVisibility = "visible", ctx: Optional[ScriptRunContext] = None, ) -> bool: key = to_key(key) check_callback_rules(self.dg, on_change) check_session_state_rules( default_value=None if value is False else value, key=key ) maybe_raise_label_warnings(label, label_visibility) checkbox_proto = CheckboxProto() checkbox_proto.label = label checkbox_proto.default = bool(value) checkbox_proto.form_id = current_form_id(self.dg) if help is not None: checkbox_proto.help = dedent(help) serde = CheckboxSerde(value) checkbox_state = register_widget( "checkbox", checkbox_proto, user_key=key, on_change_handler=on_change, args=args, kwargs=kwargs, deserializer=serde.deserialize, serializer=serde.serialize, ctx=ctx, ) # This needs to be done after register_widget because we don't want # the following proto fields to affect a widget's ID. checkbox_proto.disabled = disabled checkbox_proto.label_visibility.value = get_label_visibility_proto_value( label_visibility ) if checkbox_state.value_changed: checkbox_proto.value = checkbox_state.value checkbox_proto.set_value = True self.dg._enqueue("checkbox", checkbox_proto) return checkbox_state.value @property def dg(self) -> "DeltaGenerator": """Get our DeltaGenerator.""" return cast("DeltaGenerator", self)