sdr_view_components 0.15.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +19 -0
- data/app/components/sdr_view_components/elements/button_link_component.rb +6 -4
- data/app/components/sdr_view_components/forms/field_component.html.erb +1 -1
- data/app/components/sdr_view_components/forms/field_component.rb +23 -2
- data/app/components/sdr_view_components/forms/radio_button_group_component.html.erb +6 -0
- data/app/components/sdr_view_components/forms/radio_button_group_component.rb +26 -0
- data/lib/sdr_view_components/version.rb +1 -1
- data/spec/components/previews/sdr_view_components/forms/radio_button_group_component_preview/default.html.erb +12 -0
- data/spec/components/previews/sdr_view_components/forms/radio_button_group_component_preview/with_nested_content.html.erb +18 -0
- data/spec/components/previews/sdr_view_components/forms/radio_button_group_component_preview/with_validation_error.html.erb +13 -0
- data/spec/components/previews/sdr_view_components/forms/radio_button_group_component_preview.rb +23 -0
- metadata +7 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6fffa520e874d95db0c98e2154b4c6725d119919d9b58c723ed418d99ddf9f9e
|
|
4
|
+
data.tar.gz: c6fea4f2e4a80fb4a2a9a81547d084c4c1900e30f6d1ca9bfdc0f35aacb387e8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e3c2ccadf81aaf8265e78a842c7eb6b4207a35c4f75b6026320dba695e240ab85182590d31a9b12782aef7ba68e6baa3a0d75112d226527fee48d04697c361b1
|
|
7
|
+
data.tar.gz: 2ee11d5a9e3c2cf96a71a878e8e94cb05dcdaefac3b66943c8de2b16c43cbee156597e096264bc84fe13e5635bf12b64b01128431cccf3a59e6442e168145b40
|
data/README.md
CHANGED
|
@@ -127,6 +127,25 @@ At a minimum, each of these components must be provided wih the `form:` and `fie
|
|
|
127
127
|
- `help_`: is used to pass arguments to the help text available for the component.
|
|
128
128
|
- `error_`: is used to pass arguments to the validation output of the component.
|
|
129
129
|
|
|
130
|
+
An `input_aria:` hash is merged with the arias the component sets itself (`aria-invalid`, `aria-required`), and its `describedby` is added to the component's error and help text ids rather than replacing them. The component's own arias take precedence, so `input_aria:` can add attributes but can't override the field's error or required state.
|
|
131
|
+
|
|
132
|
+
#### Radio button groups
|
|
133
|
+
|
|
134
|
+
Use `SdrViewComponents::Forms::RadioButtonGroupComponent` for a set of radio buttons that share a field. It renders the radio buttons in a `FieldsetComponent` and renders the field's validation error once for the group, rather than under each radio button. Each radio button gets `aria-invalid` and an `aria-describedby` pointing at that error. Arguments other than `form:` and `field_name:` (`label:`, `tooltip:`, `mark_required:`, `help_text:`, etc.) are passed to the `FieldsetComponent`; arguments to `with_radio_button` are passed to `RadioButtonComponent`.
|
|
135
|
+
|
|
136
|
+
A block given to `with_radio_button` is rendered as that radio button's additional container content, for example a field that applies only when that option is chosen.
|
|
137
|
+
|
|
138
|
+
```erb
|
|
139
|
+
<%= render SdrViewComponents::Forms::RadioButtonGroupComponent.new(form:, field_name: :delivery_method, label: 'Delivery method') do |group| %>
|
|
140
|
+
<% group.with_radio_button(input_value: 'email', label_text: 'Email') do %>
|
|
141
|
+
<%= render SdrViewComponents::Forms::TextFieldComponent.new(form:, field_name: :email_address, label_text: 'Email address') %>
|
|
142
|
+
<% end %>
|
|
143
|
+
<% group.with_radio_button(input_value: 'mail', label_text: 'Mail') %>
|
|
144
|
+
<% end %>
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
For layouts the group component doesn't support (for example, showing the error next to one particular radio button), pass `show_errors: false` to each composed component to skip its validation error, and render the error once yourself with `SdrViewComponents::Forms::InvalidFeedbackComponent.new(form:, field_name:)`. The inputs still point their `aria-describedby` at the error's id, so make sure it is rendered.
|
|
148
|
+
|
|
130
149
|
TODO:
|
|
131
150
|
- Outline the supported params for each prefix
|
|
132
151
|
- Provide an example instantiation and output
|
|
@@ -20,10 +20,12 @@ module SdrViewComponents
|
|
|
20
20
|
attr_reader :link, :label
|
|
21
21
|
|
|
22
22
|
def call
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
23
|
+
classes = ComponentSupport::ButtonSupport.classes(classes: @classes, variant: @variant,
|
|
24
|
+
bordered: @bordered, size: @size, disabled: @disabled)
|
|
25
|
+
# The class only styles the link; dropping href keeps it from being followed from the keyboard.
|
|
26
|
+
return tag.a(class: classes, aria: { disabled: true }, tabindex: -1, **@options) { label || content } if @disabled
|
|
27
|
+
|
|
28
|
+
link_to(link, class: classes, **@options) do
|
|
27
29
|
label || content
|
|
28
30
|
end
|
|
29
31
|
end
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
<%= render SdrViewComponents::Forms::LabelComponent.new(form:, field_name: label_field_name, **label_args) %>
|
|
3
3
|
<%= render SdrViewComponents::Forms::HelpTextComponent.new(**help_text_args) unless help_text_below? %>
|
|
4
4
|
<%= render input_component %>
|
|
5
|
-
<%= render SdrViewComponents::Forms::InvalidFeedbackComponent.new(form:, field_name:, **error_args) %>
|
|
5
|
+
<%= render SdrViewComponents::Forms::InvalidFeedbackComponent.new(form:, field_name:, **error_args) if show_errors? %>
|
|
6
6
|
<%= render SdrViewComponents::Forms::HelpTextComponent.new(**help_text_args) if help_text_below? %>
|
|
7
7
|
|
|
8
8
|
<%= additional_container_content %>
|
|
@@ -6,7 +6,10 @@ module SdrViewComponents
|
|
|
6
6
|
class FieldComponent < BaseComponent
|
|
7
7
|
renders_one :additional_container_content
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
# @param show_errors [Boolean] Whether to render the field's invalid feedback. Set to false when several
|
|
10
|
+
# inputs share a field (e.g. a radio button group) and the error is rendered once elsewhere. The input
|
|
11
|
+
# still gets aria-invalid and an aria-describedby pointing at the field's error id.
|
|
12
|
+
def initialize(form:, field_name:, container_classes: [], variant: :default, show_errors: true, **args) # rubocop:disable Metrics/ParameterLists
|
|
10
13
|
@form = form
|
|
11
14
|
@field_name = field_name
|
|
12
15
|
@container_classes = container_classes
|
|
@@ -15,6 +18,7 @@ module SdrViewComponents
|
|
|
15
18
|
# This is necessary for some types of fields such as checkboxes.
|
|
16
19
|
raise ArgumentError, 'invalid variant' unless %i[default help_text_below].include?(@variant)
|
|
17
20
|
|
|
21
|
+
@show_errors = show_errors
|
|
18
22
|
@args = args
|
|
19
23
|
super()
|
|
20
24
|
end
|
|
@@ -57,8 +61,13 @@ module SdrViewComponents
|
|
|
57
61
|
# Returns a hash of arguments for the input element.
|
|
58
62
|
# Prefix and argument with 'input_' in order for it to be passed to
|
|
59
63
|
# the input element.
|
|
64
|
+
# A caller-supplied :input_aria is merged with the field's arias, with
|
|
65
|
+
# describedby values joined. The field's own arias (e.g. invalid, required)
|
|
66
|
+
# take precedence, so a caller can't override the field's error state.
|
|
60
67
|
def input_args
|
|
61
|
-
args_for(args:, prefix: 'input_').
|
|
68
|
+
args_for(args:, prefix: 'input_').then do |input|
|
|
69
|
+
input.merge({ aria: merge_arias(field_aria, input[:aria]) })
|
|
70
|
+
end
|
|
62
71
|
end
|
|
63
72
|
|
|
64
73
|
# Returns a hash of arguments for the label element.
|
|
@@ -80,10 +89,22 @@ module SdrViewComponents
|
|
|
80
89
|
def help_text_below?
|
|
81
90
|
variant == :help_text_below
|
|
82
91
|
end
|
|
92
|
+
|
|
93
|
+
def show_errors?
|
|
94
|
+
@show_errors
|
|
95
|
+
end
|
|
83
96
|
##########################################################################
|
|
84
97
|
|
|
85
98
|
private
|
|
86
99
|
|
|
100
|
+
def merge_arias(arias, other_arias)
|
|
101
|
+
return arias if other_arias.blank?
|
|
102
|
+
|
|
103
|
+
arias.merge(other_arias.symbolize_keys) do |key, value, other_value|
|
|
104
|
+
key == :describedby ? merge_actions(value, other_value) : value
|
|
105
|
+
end
|
|
106
|
+
end
|
|
107
|
+
|
|
87
108
|
def error_aria
|
|
88
109
|
InvalidFeedbackSupport.arias_for(field_name:, form:).tap do |arias|
|
|
89
110
|
arias[:describedby] = merge_actions(arias[:describedby], help_text_id) if help_text_args[:text].present?
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module SdrViewComponents
|
|
4
|
+
module Forms
|
|
5
|
+
# Component for a group of radio buttons that share a field.
|
|
6
|
+
# The field's error is rendered once for the group rather than under each radio button.
|
|
7
|
+
class RadioButtonGroupComponent < BaseComponent
|
|
8
|
+
# A block given to with_radio_button is rendered as the radio button's additional container content.
|
|
9
|
+
renders_many :radio_buttons, lambda { |**args, &block|
|
|
10
|
+
Forms::RadioButtonComponent.new(form:, field_name:, show_errors: false, **args).tap do |radio_button|
|
|
11
|
+
radio_button.with_additional_container_content(&block) if block
|
|
12
|
+
end
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
# @param fieldset_args [Hash] Passed to FieldsetComponent (e.g. label:, tooltip:, mark_required:, help_text:).
|
|
16
|
+
def initialize(form:, field_name:, **fieldset_args)
|
|
17
|
+
@form = form
|
|
18
|
+
@field_name = field_name
|
|
19
|
+
@fieldset_args = fieldset_args
|
|
20
|
+
super()
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
attr_reader :form, :field_name, :fieldset_args
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
<% model = SdrViewComponents::Forms::RadioButtonGroupComponentPreview::RadioButtonGroupPreviewModel.new(delivery_method: 'email') %>
|
|
2
|
+
|
|
3
|
+
<%= form_with(model: model, url: '/example') do |form| %>
|
|
4
|
+
<%= render SdrViewComponents::Forms::RadioButtonGroupComponent.new(
|
|
5
|
+
form: form,
|
|
6
|
+
field_name: :delivery_method,
|
|
7
|
+
label: 'Delivery method'
|
|
8
|
+
) do |group| %>
|
|
9
|
+
<% group.with_radio_button(input_value: 'email', label_text: 'Email') %>
|
|
10
|
+
<% group.with_radio_button(input_value: 'mail', label_text: 'Mail') %>
|
|
11
|
+
<% end %>
|
|
12
|
+
<% end %>
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<% model = SdrViewComponents::Forms::RadioButtonGroupComponentPreview::RadioButtonGroupPreviewModel.new(delivery_method: 'email') %>
|
|
2
|
+
|
|
3
|
+
<%= form_with(model: model, url: '/example') do |form| %>
|
|
4
|
+
<%= render SdrViewComponents::Forms::RadioButtonGroupComponent.new(
|
|
5
|
+
form: form,
|
|
6
|
+
field_name: :delivery_method,
|
|
7
|
+
label: 'Delivery method'
|
|
8
|
+
) do |group| %>
|
|
9
|
+
<% group.with_radio_button(input_value: 'email', label_text: 'Email') do %>
|
|
10
|
+
<%= render SdrViewComponents::Forms::TextFieldComponent.new(
|
|
11
|
+
form: form,
|
|
12
|
+
field_name: :email_address,
|
|
13
|
+
label_text: 'Email address'
|
|
14
|
+
) %>
|
|
15
|
+
<% end %>
|
|
16
|
+
<% group.with_radio_button(input_value: 'mail', label_text: 'Mail') %>
|
|
17
|
+
<% end %>
|
|
18
|
+
<% end %>
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<% model = SdrViewComponents::Forms::RadioButtonGroupComponentPreview::RadioButtonGroupPreviewModel.new(delivery_method: nil) %>
|
|
2
|
+
<% model.valid? %>
|
|
3
|
+
|
|
4
|
+
<%= form_with(model: model, url: '/example') do |form| %>
|
|
5
|
+
<%= render SdrViewComponents::Forms::RadioButtonGroupComponent.new(
|
|
6
|
+
form: form,
|
|
7
|
+
field_name: :delivery_method,
|
|
8
|
+
label: 'Delivery method'
|
|
9
|
+
) do |group| %>
|
|
10
|
+
<% group.with_radio_button(input_value: 'email', label_text: 'Email') %>
|
|
11
|
+
<% group.with_radio_button(input_value: 'mail', label_text: 'Mail') %>
|
|
12
|
+
<% end %>
|
|
13
|
+
<% end %>
|
data/spec/components/previews/sdr_view_components/forms/radio_button_group_component_preview.rb
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module SdrViewComponents
|
|
4
|
+
module Forms
|
|
5
|
+
class RadioButtonGroupComponentPreview < ViewComponent::Preview
|
|
6
|
+
def default; end
|
|
7
|
+
|
|
8
|
+
def with_validation_error; end
|
|
9
|
+
|
|
10
|
+
def with_nested_content; end
|
|
11
|
+
|
|
12
|
+
class RadioButtonGroupPreviewModel
|
|
13
|
+
include ActiveModel::Model
|
|
14
|
+
include ActiveModel::Attributes
|
|
15
|
+
|
|
16
|
+
attribute :delivery_method, :string, default: nil
|
|
17
|
+
attribute :email_address, :string, default: nil
|
|
18
|
+
|
|
19
|
+
validates :delivery_method, presence: true
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: sdr_view_components
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.17.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Aaron Collier
|
|
@@ -133,6 +133,8 @@ files:
|
|
|
133
133
|
- app/components/sdr_view_components/forms/label_component.html.erb
|
|
134
134
|
- app/components/sdr_view_components/forms/label_component.rb
|
|
135
135
|
- app/components/sdr_view_components/forms/radio_button_component.rb
|
|
136
|
+
- app/components/sdr_view_components/forms/radio_button_group_component.html.erb
|
|
137
|
+
- app/components/sdr_view_components/forms/radio_button_group_component.rb
|
|
136
138
|
- app/components/sdr_view_components/forms/select_field_component.rb
|
|
137
139
|
- app/components/sdr_view_components/forms/submit_component.html.erb
|
|
138
140
|
- app/components/sdr_view_components/forms/submit_component.rb
|
|
@@ -290,6 +292,10 @@ files:
|
|
|
290
292
|
- spec/components/previews/sdr_view_components/forms/radio_button_component_preview/with_help_text_below.html.erb
|
|
291
293
|
- spec/components/previews/sdr_view_components/forms/radio_button_component_preview/with_label.html.erb
|
|
292
294
|
- spec/components/previews/sdr_view_components/forms/radio_button_component_preview/with_validation_error.html.erb
|
|
295
|
+
- spec/components/previews/sdr_view_components/forms/radio_button_group_component_preview.rb
|
|
296
|
+
- spec/components/previews/sdr_view_components/forms/radio_button_group_component_preview/default.html.erb
|
|
297
|
+
- spec/components/previews/sdr_view_components/forms/radio_button_group_component_preview/with_nested_content.html.erb
|
|
298
|
+
- spec/components/previews/sdr_view_components/forms/radio_button_group_component_preview/with_validation_error.html.erb
|
|
293
299
|
- spec/components/previews/sdr_view_components/forms/select_field_component_preview.rb
|
|
294
300
|
- spec/components/previews/sdr_view_components/forms/select_field_component_preview/default.html.erb
|
|
295
301
|
- spec/components/previews/sdr_view_components/forms/select_field_component_preview/with_additional_container_content.html.erb
|