Class: Primer::Alpha::ToggleSwitch

Inherits:
Component
  • Object
show all
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

Status::Dsl::STATUSES

Constants included from ViewHelper

ViewHelper::HELPERS

Constants included from TestSelectorHelper

TestSelectorHelper::TEST_SELECTOR_TAG

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::InvalidValueError

Instance Method Summary collapse

Methods included from JoinStyleArgumentsHelper

#join_style_arguments

Methods included from TestSelectorHelper

#add_test_selector

Methods included from FetchOrFallbackHelper

#fetch_or_fallback, #fetch_or_fallback_boolean, #silence_deprecations?

Methods included from ClassNameHelper

#class_names

Constructor Details

#initialize(src: nil, csrf_token: nil, checked: false, enabled: true, size: SIZE_DEFAULT, status_label_position: STATUS_LABEL_POSITION_DEFAULT, **system_arguments) ⇒ ToggleSwitch

Returns a new instance of ToggleSwitch.

Examples:

Default

<%= render(Primer::Alpha::ToggleSwitch.new(src: "/foo")) %>

Checked

<%= render(Primer::Alpha::ToggleSwitch.new(src: "/foo", checked: true)) %>

Disabled

<%= render(Primer::Alpha::ToggleSwitch.new(src: "/foo", enabled: false)) %>

Checked and Disabled

<%= render(Primer::Alpha::ToggleSwitch.new(src: "/foo", checked: true, enabled: false)) %>

Small

<%= render(Primer::Alpha::ToggleSwitch.new(src: "/foo", size: :small)) %>

With status label positioned at the end

<%= render(Primer::Alpha::ToggleSwitch.new(src: "/foo", status_label_position: :end)) %>

Parameters:

  • src (String) (defaults to: nil) —

    The URL to POST to when the toggle switch is toggled. If nil, the toggle switch will not make any requests.

  • csrf_token (String) (defaults to: nil) —

    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) (defaults to: false) —

    Whether the toggle switch is on or off.

  • enabled (Boolean) (defaults to: true) —

    Whether or not the toggle switch responds to user input.

  • size (Symbol) (defaults to: SIZE_DEFAULT) —

    What size toggle switch to render. <%= one_of(Primer::Alpha::ToggleSwitch::STATUS_LABEL_POSITION_OPTIONS) %>

  • status_label_position (Symbol) (defaults to: STATUS_LABEL_POSITION_DEFAULT) —

    Which side of the toggle switch to render the status label. <%= one_of(Primer::Alpha::ToggleSwitch::SIZE_OPTIONS) %>

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'app/components/primer/alpha/toggle_switch.rb', line 48

def initialize(src: nil, csrf_token: nil, checked: false, enabled: true, size: SIZE_DEFAULT, status_label_position: STATUS_LABEL_POSITION_DEFAULT, **system_arguments)
  @src = src
  @csrf_token = csrf_token
  @checked = checked
  @enabled = enabled
  @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]
  )

  @system_arguments[:src] = @src if @src

  return unless @src && @csrf_token

  @system_arguments[:csrf] = @csrf_token
end

Instance Method Details

#disabled? ⇒ Boolean

Returns:

  • (Boolean) 


84
85
86
 
# File 'app/components/primer/alpha/toggle_switch.rb', line 84

def disabled?
  !enabled?
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'app/components/primer/alpha/toggle_switch.rb', line 80

def enabled?
  @enabled
end

#on? ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
 
# File 'app/components/primer/alpha/toggle_switch.rb', line 76

def on?
  @checked
end