Uploaded image for project: 'stripes-components'
  1. stripes-components
  2. STCOM-856

Headline documentation should endorse h1-h6

    XMLWordPrintable

Details

    • Story
    • Status: Closed (View Workflow)
    • P2
    • Resolution: Won't Do
    • None
    • None
    • Stripes Force

    Description

      Headlines should use <h1> ... <h6> tags to provide semantic code for headings in the content. Heading markup will allow assistive technologies like screenreaders to present the heading status of text to a user.

      The default tag of a Stripes Headline is <div>.

      The Headline documentation https://github.com/folio-org/stripes-components/tree/master/lib/Headline should endorse not to use the default <div> but <h1> ... <h6>.

      Properly using <h1> ... <h6> is a WCAG 2.1 Level A requirement:

      Only 153 out of 263 <Headline> usages change the <div> tag, see attached headline.txt file:

      cd platform-complete/node_modules/@folio
      grep -rPazo "<Headline[^>]*>" | tr \\0 \\n | grep Headline | wc -l
      263
      grep -rPazo "<Headline[^>]*>" | tr \\0 \\n | grep "tag" | wc -l
      153
      

      TestRail: Results

        Attachments

          Issue Links

            Activity

              People

                Unassigned Unassigned
                julianladisch Julian Ladisch
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  TestRail: Runs

                    TestRail: Cases