Class: Primer::Alpha::FormControl
- Defined in:
- app/components/primer/alpha/form_control.rb
Overview
Wraps an input (or arbitrary content) with a label above and a caption and validation message beneath. NOTE: This ‘FormControl` component is designed for wrapping inputs that aren’t supported by the Primer forms framework.
Constant Summary
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
- #full_width? ⇒ Boolean
-
#initialize(label:, caption: nil, validation_message: nil, required: false, visually_hide_label: false, full_width: false, **system_arguments) ⇒ FormControl
constructor
A new instance of FormControl.
- #required? ⇒ Boolean
- #visually_hide_label? ⇒ Boolean
- #with_input(&block) ⇒ Object
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, #merge_aria, #merge_data, #merge_prefixed_attribute_hashes
Constructor Details
#initialize(label:, caption: nil, validation_message: nil, required: false, visually_hide_label: false, full_width: false, **system_arguments) ⇒ FormControl
Returns a new instance of FormControl.
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
# File 'app/components/primer/alpha/form_control.rb', line 20 def initialize(label:, caption: nil, validation_message: nil, required: false, visually_hide_label: false, full_width: false, **system_arguments) @label = label @init_caption = caption @validation_message = @required = required @visually_hide_label = visually_hide_label @full_width = full_width @system_arguments = system_arguments @system_arguments[:classes] = class_names( @system_arguments[:classes], "FormControl", "FormControl--fullWidth" => full_width? ) @label_arguments = { classes: class_names( "FormControl-label", visually_hide_label? ? "sr-only" : nil ) } base_id = self.class.generate_id @validation_id = "validation-#{base_id}" @caption_id = "caption-#{base_id}" @validation_arguments = { classes: "FormControl-inlineValidation", id: @validation_id } end |
Instance Method Details
#full_width? ⇒ Boolean
69 70 71 |
# File 'app/components/primer/alpha/form_control.rb', line 69 def full_width? @full_width end |
#required? ⇒ Boolean
61 62 63 |
# File 'app/components/primer/alpha/form_control.rb', line 61 def required? @required end |
#visually_hide_label? ⇒ Boolean
65 66 67 |
# File 'app/components/primer/alpha/form_control.rb', line 65 def visually_hide_label? @visually_hide_label end |
#with_input(&block) ⇒ Object
57 58 59 |
# File 'app/components/primer/alpha/form_control.rb', line 57 def with_input(&block) @input_block = block end |