Merge pull request #2373 from alphagov/textarea-id

Update calls to textarea component with the `id` option
alphagov · Jan 22, 2025 · 297cbbf · 297cbbf
2 parents 7442771 + cb4f2d8
commit 297cbbf
Show file tree

Hide file tree

Showing 11 changed files with 24 additions and 24 deletions.
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -199,7 +199,7 @@ GEM
     govuk_personalisation (1.1.0)
       plek (>= 1.9.0)
       rails (>= 6, < 9)
-    govuk_publishing_components (49.1.0)
+    govuk_publishing_components (50.0.0)
       govuk_app_config
       govuk_personalisation (>= 0.7.0)
       kramdown
@@ -233,7 +233,7 @@ GEM
       activesupport (>= 3.0)
       nokogiri (>= 1.6)
     io-console (0.8.0)
-    irb (1.15.0)
+    irb (1.15.1)
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)

diff --git a/app/views/components/_markdown_editor.html.erb b/app/views/components/_markdown_editor.html.erb
@@ -9,7 +9,7 @@
 <%= tag.div class: component_classes do %>
 
   <%= render "govuk_publishing_components/components/label", {
-    html_for: textarea[:id],
+    html_for: textarea[:textarea_id],
   }.merge(label.symbolize_keys) %>
 
   <% if error_message.present? %>
@@ -21,7 +21,7 @@
    <div class="app-c-markdown-editor__container">
     <div class="app-c-markdown-editor__head">
       <div class="app-c-markdown-editor__toolbar">
-        <markdown-toolbar class="app-c-markdown-editor__toolbar-group" for="<%= textarea[:id] %>">
+        <markdown-toolbar class="app-c-markdown-editor__toolbar-group" for="<%= textarea[:textarea_id] %>">
           <% if controls.include?(:headings) %>
             <md-header-2 class="app-c-markdown-editor__toolbar-button" title="Heading level 2" aria-label="Heading level 2">
               <%= inline_svg_tag "components/markdown-editor/heading-two.svg", class: "app-c-markdown-editor__toolbar-icon" , aria_hidden: true %>

diff --git a/app/views/components/docs/markdown_editor.yml b/app/views/components/docs/markdown_editor.yml
@@ -25,7 +25,7 @@ examples:
         text: Body
       textarea:
         name: markdown-editor
-        id: markdown-editor
+        textarea_id: markdown-editor
   with_bullet_list_button:
     data:
       controls:
@@ -34,7 +34,7 @@ examples:
         text: Body
       textarea:
         name: markdown-editor
-        id: markdown-editor
+        textarea_id: markdown-editor
   with_headings_buttons:
     data:
       controls:
@@ -43,7 +43,7 @@ examples:
         text: Body
       textarea:
         name: markdown-editor
-        id: markdown-editor
+        textarea_id: markdown-editor
   with_blockquote_button:
     data:
       controls:
@@ -52,7 +52,7 @@ examples:
         text: Body
       textarea:
         name: markdown-editor
-        id: markdown-editor
+        textarea_id: markdown-editor
   with_numbered_list_button:
     data:
       controls:
@@ -61,4 +61,4 @@ examples:
         text: Body
       textarea:
         name: markdown-editor
-        id: markdown-editor
+        textarea_id: markdown-editor
diff --git a/app/views/coronavirus/pages/_form.html.erb b/app/views/coronavirus/pages/_form.html.erb
@@ -16,7 +16,7 @@
   },
   textarea: {
     name: "landing_page[header_body]",
-    id: "header_body",
+    textarea_id: "header_body",
     rows: 20,
     value: @page.header_body,
   },

diff --git a/app/views/coronavirus/sub_sections/_form.html.erb b/app/views/coronavirus/sub_sections/_form.html.erb
@@ -50,7 +50,7 @@
     bold: true,
   },
   name: "sub_section[action_link_summary]",
-  id: "action_link_summary",
+  textarea_id: "action_link_summary",
   value: @sub_section.action_link_summary,
   rows: 5,
   error_message: error_items(@sub_section.errors.messages, :action_link_summary),
@@ -77,7 +77,7 @@
   },
   textarea: {
     name: "sub_section[content]",
-    id: "content",
+    textarea_id: "content",
     rows: 20,
     value: @sub_section.content,
   },

diff --git a/app/views/review/submit_2i_verdict.erb b/app/views/review/submit_2i_verdict.erb
@@ -39,7 +39,7 @@
         label: {
           text: t("step_by_step_pages.#{review_phrase}.label"),
         },
-        id: "additional-comments",
+        textarea_id: "additional-comments",
         name: textarea_name,
       } %>
 

diff --git a/app/views/review/submit_for_2i.html.erb b/app/views/review/submit_for_2i.html.erb
@@ -29,7 +29,7 @@
         text: t("step_by_step_pages.submit_for_2i.label"),
         bold: true,
       },
-      id: "additional-comments",
+      textarea_id: "additional-comments",
       name: "additional_comments",
     } %>
   <% end %>

diff --git a/app/views/step_by_step_pages/_form.html.erb b/app/views/step_by_step_pages/_form.html.erb
@@ -43,7 +43,7 @@
         text: t("step_by_step_pages.form.introduction.label"),
         bold: true,
       },
-      id: "step_by_step_page_introduction",
+      textarea_id: "step_by_step_page_introduction",
       name: "step_by_step_page[introduction]",
       value: step_by_step_page.introduction,
     } %>
@@ -59,7 +59,7 @@
         text: t("step_by_step_pages.form.meta_description.label"),
         bold: true,
       },
-      id: "step_by_step_page_meta_description",
+      textarea_id: "step_by_step_page_meta_description",
       name: "step_by_step_page[description]",
       value: step_by_step_page.description,
     } %>

diff --git a/app/views/step_by_step_pages/internal_change_notes.html.erb b/app/views/step_by_step_pages/internal_change_notes.html.erb
@@ -32,7 +32,7 @@
         text: t("step_by_step_pages.internal_change_notes.label"),
         bold: true,
       },
-      id: "internal-change-note-description",
+      textarea_id: "internal-change-note-description",
       name: "internal_change_note[description]",
     } %>
   <% end %>

diff --git a/app/views/steps/_form.html.erb b/app/views/steps/_form.html.erb
@@ -115,7 +115,7 @@
     },
     textarea: {
       name: "step[contents]",
-      id: "step-content",
+      textarea_id: "step-content",
       rows: 20,
       value: step.contents,
     },

diff --git a/spec/components/markdown_editor_spec.rb b/spec/components/markdown_editor_spec.rb
@@ -14,7 +14,7 @@
            },
            textarea: {
              name: "markdown-editor",
-             id: "markdown-editor",
+             textarea_id: "markdown-editor",
            }
 
     assert_select ".govuk-label[for='markdown-editor']", text: "Body"
@@ -30,7 +30,7 @@
            },
            textarea: {
              name: "markdown-editor",
-             id: "markdown-editor",
+             textarea_id: "markdown-editor",
            }
 
     assert_select ".app-c-markdown-editor__toolbar-button[title='Bullets']", count: 1
@@ -44,7 +44,7 @@
            },
            textarea: {
              name: "markdown-editor",
-             id: "markdown-editor",
+             textarea_id: "markdown-editor",
            }
 
     assert_select ".app-c-markdown-editor__toolbar-button[title='Heading level 2']", count: 1
@@ -59,7 +59,7 @@
            },
            textarea: {
              name: "markdown-editor",
-             id: "markdown-editor",
+             textarea_id: "markdown-editor",
            }
 
     assert_select ".app-c-markdown-editor__toolbar-button[title='Blockquote']", count: 1
@@ -73,7 +73,7 @@
            },
            textarea: {
              name: "markdown-editor",
-             id: "markdown-editor",
+             textarea_id: "markdown-editor",
            }
 
     assert_select ".app-c-markdown-editor__toolbar-button[title='Numbered list']", count: 1
@@ -87,7 +87,7 @@
            },
            textarea: {
              name: "markdown-editor",
-             id: "markdown-editor",
+             textarea_id: "markdown-editor",
            }
 
     assert_select ".govuk-error-message", text: "Error: Something is wrong"