Support captions or custom html in page headings. about govuk-formbuilder

[peteryates]

Good call, I'll add this to the legend and label options, probably in the following format:

= form.govuk_text_field(:number_of_places,
   label: {
     text: "How many places would you like to request?",
     size: "xl",
     tag: "h1",
     caption: @training_provider.provider_name
   },
   pattern: "[0-9]*",
   inputmode: "numeric",
   width: 10) do

[aliuk2012]

Is it worth adding a caption_position which would accept either inside or outside which would control the positioning of the caption?

[aliuk2012]

The caption could include visually hidden content for screenreader users too

[peteryates]

If it's meant to be outside wouldn't just manually placing the caption outside work?

span.govuk-caption = @training_provider.provider_name

= form.govuk_text_field(:number_of_places, ...)

With regards to visually hidden captions I'd be inclined to let them be configured manually (and left outside the helper) too. There's no reference to hiding them in the design system docs.

[aliuk2012]

I suppose placing the caption outside like I have already done would work, it just means that the page would look like the screenshot above with the caption not being included in the error form group.

I know the design system doesn't mention it but I've seen services where extra visually hidden content is included.

Eg.

<span class="govuk-caption-xl">
  <span class="govuk-visually-hidden">You are currently viewing </span>
  <%= provider_name %>
</span>

Eg.

<span class="govuk-caption-xl">
  <%= provider_name %><span class="govuk-visually-hidden">:</span>
</span>
<h1>Location</h1>

[peteryates]

I suppose placing the caption outside like I have already done would work, it just means that the page would look like the screenshot above with the caption not being included in the error form group.

Ah, I see what you mean now, inside or outside the tag, not the .form-group. Makes sense.

I think this could be solved entirely by allowing legend to take a proc rather than a hash, similar to how it works on #govuk_collection_radio_buttons. That would keep the API simple but allow full customisation of the contents of <legend>.

[aliuk2012]

That sounds a good approach 👍