ToggleSwitch

ready

This page may be removed. Primer plans to move all Rails component documentation to Lookbook.

Description

The ToggleSwitch component is a button that toggles between two boolean states. It is meant to be used for settings that should cause an immediate update. If configured with a "src" attribute, the component will make a POST request containing data of the form "value: 0 | 1".

Arguments

Name	Default	Description
src		`String` The URL to POST to when the toggle switch is toggled. If `nil`, the toggle switch will not make any requests.
csrf_token		`String` A CSRF token that will be sent to the server as "authenticity_token" when the toggle switch is toggled. Unused if `src` is `nil`.
checked		`Boolean` Whether the toggle switch is on or off.
enabled		`Boolean` Whether or not the toggle switch responds to user input.
size		`Symbol` What size toggle switch to render. One of `:medium` or `:small`.
status_label_position		`Symbol` Which side of the toggle switch to render the status label. One of `:end` or `:start`.
turbo		`Boolean` Whether or not to request a turbo stream and render the response as such.
autofocus		`Boolean` Whether switch should be autofocused when rendered.
system_arguments		`Hash` System arguments
on_label		`String` Custom label to show when the switch is ON. Defaults to On. Only customize this label if it makes the toggle’s state more meaningful in its specific context. For example, for a "Show images" setting, you might use "Hide" when the switch is ON.
off_label		`String` Custom label to show when the switch is OFF. Defaults to ("Off"). Only customize this label if it makes the toggle’s state more meaningful in its specific context. For example, for a "Show images" setting, you might use "Show" when the switch is OFF.