Class: Primer::Alpha::ToggleSwitch
- Defined in:
- app/components/primer/alpha/toggle_switch.rb
Overview
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”.
Constant Summary collapse
- SIZE_DEFAULT =
:medium
- SIZE_MAPPINGS =
{ SIZE_DEFAULT => nil, :small => "ToggleSwitch--small" }.freeze
- SIZE_OPTIONS =
SIZE_MAPPINGS.keys.freeze
- STATUS_LABEL_POSITION_DEFAULT =
:start
- STATUS_LABEL_POSITION_MAPPINGS =
{ STATUS_LABEL_POSITION_DEFAULT => nil, :end => "ToggleSwitch--statusAtEnd" }.freeze
- STATUS_LABEL_POSITION_OPTIONS =
STATUS_LABEL_POSITION_MAPPINGS.keys.freeze
Constants inherited from Component
Component::INVALID_ARIA_LABEL_TAGS
Constants included from Status::Dsl
Constants included from ViewHelper
Constants included from TestSelectorHelper
TestSelectorHelper::TEST_SELECTOR_TAG
Constants included from FetchOrFallbackHelper
FetchOrFallbackHelper::InvalidValueError
Constants included from Primer::AttributesHelper
Primer::AttributesHelper::PLURAL_ARIA_ATTRIBUTES, Primer::AttributesHelper::PLURAL_DATA_ATTRIBUTES
Instance Method Summary collapse
- #disabled? ⇒ Boolean
- #enabled? ⇒ Boolean
-
#initialize(src: nil, csrf_token: nil, checked: false, enabled: true, size: SIZE_DEFAULT, status_label_position: STATUS_LABEL_POSITION_DEFAULT, turbo: false, **system_arguments) ⇒ ToggleSwitch
constructor
A new instance of ToggleSwitch.
- #on? ⇒ Boolean
Methods inherited from Component
Methods included from JoinStyleArgumentsHelper
Methods included from TestSelectorHelper
Methods included from FetchOrFallbackHelper
#fetch_or_fallback, #fetch_or_fallback_boolean, #silence_deprecations?
Methods included from ClassNameHelper
Methods included from Primer::AttributesHelper
#aria, #data, #extract_data, #merge_aria, #merge_data, #merge_prefixed_attribute_hashes
Methods included from ExperimentalSlotHelpers
Methods included from ExperimentalRenderHelpers
Constructor Details
permalink #initialize(src: nil, csrf_token: nil, checked: false, enabled: true, size: SIZE_DEFAULT, status_label_position: STATUS_LABEL_POSITION_DEFAULT, turbo: false, **system_arguments) ⇒ ToggleSwitch
Returns a new instance of ToggleSwitch.
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'app/components/primer/alpha/toggle_switch.rb', line 31 def initialize(src: nil, csrf_token: nil, checked: false, enabled: true, size: SIZE_DEFAULT, status_label_position: STATUS_LABEL_POSITION_DEFAULT, turbo: false, **system_arguments) @src = src @csrf_token = csrf_token @checked = checked @enabled = enabled @turbo = turbo @system_arguments = system_arguments @size = fetch_or_fallback(SIZE_OPTIONS, size, SIZE_DEFAULT) @status_label_position = fetch_or_fallback( STATUS_LABEL_POSITION_OPTIONS, status_label_position, STATUS_LABEL_POSITION_DEFAULT ) @system_arguments[:classes] = class_names( @system_arguments.delete(:classes), "ToggleSwitch", on? ? "ToggleSwitch--checked" : nil, enabled? ? nil : "ToggleSwitch--disabled", STATUS_LABEL_POSITION_MAPPINGS[@status_label_position], SIZE_MAPPINGS[@size] ) @aria_arguments = { aria: merge_aria( @system_arguments, aria: { pressed: on? } ) } @system_arguments[:src] = @src if @src end |
Instance Method Details
permalink #disabled? ⇒ Boolean
71 72 73 |
# File 'app/components/primer/alpha/toggle_switch.rb', line 71 def disabled? !enabled? end |
permalink #enabled? ⇒ Boolean
67 68 69 |
# File 'app/components/primer/alpha/toggle_switch.rb', line 67 def enabled? @enabled end |
permalink #on? ⇒ Boolean
63 64 65 |
# File 'app/components/primer/alpha/toggle_switch.rb', line 63 def on? @checked end |