Flexible section

Document list

A wrapper for the document list component

This flexible section wraps the document list component and provides an additional header (above) and links (below).

See the document list component for more details of what can be passed to the document list.

Overview

How it looks (preview) (preview all)

Some documents

See all of these documents

Subscriptions

Passing data to this flexible section

Flexible sections are not called in the way shown below, however this information serves as a reference for the data required by this flexible section.

<%= render "flexible_page/flexible_sections/document_list", {
  email_signup_link: "/email",
  email_signup_link_text: "Get emails",
  heading_text: "Some documents",
  see_all_items_link: "/see_all",
  see_all_items_link_text: "See all of these documents",
  items: [
    {
      link: {
        text: "Alternative provision",
        path: "/government/publications/alternative-provision"
      },
      metadata: {
        public_updated_at: "2016-06-27 10:29:44 +0000",
        document_type: "Statutory guidance"
      }
    },
    {
      link: {
        text: "Behaviour and discipline in schools: guide for governing bodies",
        path: "/government/publications/behaviour-and-discipline-in-schools-guidance-for-governing-bodies"
      },
      metadata: {
        public_updated_at: "2015-09-24 16:42:48 +0000",
        document_type: "Statutory guidance"
      }
    },
    {
      link: {
        text: "Children missing education",
        path: "/government/publications/children-missing-education"
      },
      metadata: {
        public_updated_at: "2016-09-05 16:48:27 +0000",
        document_type: "Statutory guidance"
      }
    }
  ]
} %>

Accessibility acceptance criteria

Links must:

  • accept focus
  • be focusable with a keyboard
  • be usable with a keyboard
  • indicate when they have focus
  • change in appearance when touched (in the touch-down state)
  • change in appearance when hovered
  • be usable with touch
  • be usable with voice commands
  • have visible text
  • have meaningful text