【Streamlit】トグル（toggle）の表示方法

Streamlitは、Pythonで簡単にWebアプリケーションを作成できるフレームワークで、データの可視化やインタラクティブなUIの構築に優れています。

その中でも、st.toggleはユーザーが特定の機能をオン・オフできるトグルスイッチを提供するウィジェットです。

このウィジェットを使用することで、ユーザーは直感的に設定を切り替えることができます。

st.toggleの基本的な使い方

st.toggleは、ユーザーが特定のオプションを有効または無効にするためのトグルスイッチを表示します。

以下は基本的な使用例です。

import streamlit as st

# トグルスイッチを表示
is_active = st.toggle("機能を有効にする")

# トグルの状態に応じてメッセージを表示
if is_active:
    st.write("機能が有効になっています。")
else:
    st.write("機能が無効になっています。")

このコードでは、「機能を有効にする」というラベルのトグルスイッチが表示され、ユーザーの選択に応じてメッセージが変化します。

オンにした画面が以下のとおりです。

st.toggleの引数

st.toggleは以下の引数を取ります。

label (str)
トグルスイッチのラベルを指定します。ユーザーにトグルの目的を説明する短いテキストです。
value (bool)
トグルスイッチの初期状態を指定します。Trueでオン、Falseでオフになります。デフォルトはFalseです。
key (str or int)
ウィジェットの一意なキーを指定します。これにより、セッションステートでの状態管理が可能になります。
help (str)
ラベルの横に表示されるツールチップを指定します。ユーザーがホバーすると追加情報が表示されます。
on_change (callable)
トグルの状態が変化したときに呼び出されるコールバック関数を指定します。
args (tuple)
on_changeコールバックに渡す追加の引数を指定します。
kwargs (dict)
on_changeコールバックに渡す追加のキーワード引数を指定します。
disabled (bool)
Trueに設定すると、トグルスイッチが無効化され、ユーザーは操作できなくなります。
デフォルトはFalseです。
label_visibility (“visible”, “hidden”, or “collapsed”)
ラベルの表示状態を指定します。
"visible"で表示、"hidden"でスペースを確保しつつ非表示、"collapsed"でラベルとスペースの両方を非表示にします。
デフォルトは"visible"です。