Sha256: ebb387e676606d5b544f5b487b29a85ae3ef476188f7b14cc3818d6af73876b3

Contents?: true

Size: 1.34 KB

Versions: 250

Compression:

Stored size: 1.34 KB

Contents

name: Contextual guidance
description: Provides a container with additional information when focusing an input field (e.g. input, textarea)
body: |
  This component is build to be used with an input field passed in as a block and must reference its ID using the `html_for` attribute.

  On tablet and desktop, the guidance container is set to float on the page and prevent other elements from moving around (e.g. pushing next fields down the page).
part_of_admin_layout: true
accessibility_criteria: |
  The component must:

  * be hidden by default
  * be visible when the associated input field if focused
  * stay visible until another input field with guidance is being focused
shared_accessibility_criteria:
  - link
examples:
  default:
    description: Reveals a contextul guidance on the side overflowing the container
    data:
      html_for: news-title
      title: Writing a news title
      guidance_id: news-title-guidance
      content: |
        <p>The title must make clear what the content offers users. Use the words your users do to help them find this. Avoid wordplay or teases.</p>
      block: |
        <div class="govuk-form-group">
          <label class="gem-c-label govuk-label" for="news-title">News title</label>
          <input id="news-title" type="text" class="gem-c-input govuk-input" aria-describedby="news-title-guidance">
        </div>

Version data entries

250 entries across 250 versions & 1 rubygems

Version Path
govuk_publishing_components-24.13.3 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.13.2 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.13.1 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.13.0 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.12.0 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.11.1 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.11.0 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.10.3 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.10.2 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.10.1 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.10.0 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.9.4 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.9.3 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.9.2 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.9.1 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.9.0 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.8.0 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.7.1 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.7.0 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml
govuk_publishing_components-24.6.1 app/views/govuk_publishing_components/components/docs/contextual_guidance.yml