@ons/design-system 70.0.7 → 70.0.9

package/components/table-of-contents/_macro.njk

@@ -1,43 +1,45 @@
 {% macro onsTableOfContents(params) %}
-{% from "components/list/_macro.njk" import onsList %}
-{% from "components/skip-to-content/_macro.njk" import onsSkipToContent %}
+    {% from "components/list/_macro.njk" import onsList %}
+    {% from "components/skip-to-content/_macro.njk" import onsSkipToContent %}
 
-<aside class="ons-toc-container" role="complementary">
-    {% if params.skipLink %}
-        {{
-            onsSkipToContent({
-                "url": params.skipLink.url,
-                "text": params.skipLink.text
-            })
-        }}
-    {% endif %}
+    <aside class="ons-toc-container" role="complementary">
+        {% if params.skipLink %}
+            {{
+                onsSkipToContent({
+                    "url": params.skipLink.url,
+                    "text": params.skipLink.text
+                })
+            }}
+        {% endif %}
 
-    <nav class="ons-toc" aria-label="{{ params.ariaLabel | default('Table of contents') }}">
-        <h2 class="ons-toc__title ons-u-fs-r--b ons-u-mb-s">{{ params.title }}</h2>
-        {% if params.lists %}
-            {% for list in params.lists %}
-                {% if list.listHeading %}
-                    <h3 class="ons-u-fs-r ons-u-mb-xs">{{ list.listHeading }}<span class="ons-u-vh"> {{ list.listHeadingHidden }}</span>:</h3>
-                {% endif %}
+        <nav class="ons-toc" aria-label="{{ params.ariaLabel | default('Table of contents') }}">
+            <h2 class="ons-toc__title ons-u-fs-r--b ons-u-mb-s">{{ params.title }}</h2>
+            {% if params.lists %}
+                {% for list in params.lists %}
+                    {% if list.listHeading %}
+                        <h3 class="ons-u-fs-r ons-u-mb-xs">
+                            {{ list.listHeading }}<span class="ons-u-vh"> {{ list.listHeadingHidden }}</span>:
+                        </h3>
+                    {% endif %}
+                    {{
+                        onsList({
+                            "element": 'ol',
+                            "classes": 'ons-u-mb-m',
+                            "variants": 'dashed',
+                            "itemsList": list.itemsList
+                        })
+                    }}
+                {% endfor %}
+            {% elif params.itemsList %}
                 {{
                     onsList({
                         "element": 'ol',
                         "classes": 'ons-u-mb-m',
                         "variants": 'dashed',
-                        "itemsList": list.itemsList
+                        "itemsList": params.itemsList
                     })
                 }}
-            {% endfor %}
-        {% elif params.itemsList %}
-            {{
-                onsList({
-                    "element": 'ol',
-                    "classes": 'ons-u-mb-m',
-                    "variants": 'dashed',
-                    "itemsList": params.itemsList
-                })
-            }}
-        {% endif %}
-    </nav>
-</aside>
+            {% endif %}
+        </nav>
+    </aside>
 {% endmacro %}

package/components/table-of-contents/_macro.spec.js

@@ -7,164 +7,164 @@ import { mapAll } from '../../tests/helpers/cheerio';
 import { renderComponent, templateFaker } from '../../tests/helpers/rendering';
 
 const EXAMPLE_TABLE_OF_CONTENTS_SKIP_LINK = {
-  title: 'Contents',
-  skipLink: {
-    url: '#the-content',
-    text: 'Skip to guide content',
-  },
-  itemsList: [],
+    title: 'Contents',
+    skipLink: {
+        url: '#the-content',
+        text: 'Skip to guide content',
+    },
+    itemsList: [],
 };
 
 const EXAMPLE_TABLE_OF_CONTENTS_SINGLE = {
-  title: 'Contents',
-  itemsList: [
-    {
-      url: '#overview',
-      text: 'Overview',
-    },
-    {
-      url: '#who-should-take-part-and-why',
-      text: 'Who should take part and why',
-    },
-  ],
+    title: 'Contents',
+    itemsList: [
+        {
+            url: '#overview',
+            text: 'Overview',
+        },
+        {
+            url: '#who-should-take-part-and-why',
+            text: 'Who should take part and why',
+        },
+    ],
 };
 
 const EXAMPLE_TABLE_OF_CONTENTS_MULTIPLE = {
-  title: 'Contents',
-  lists: [
-    {
-      listHeading: 'Household questions',
-      listHeadingHidden: 'help topics',
-      itemsList: [
+    title: 'Contents',
+    lists: [
         {
-          url: '#household1',
-          text: 'Household and who lives here',
+            listHeading: 'Household questions',
+            listHeadingHidden: 'help topics',
+            itemsList: [
+                {
+                    url: '#household1',
+                    text: 'Household and who lives here',
+                },
+            ],
         },
-      ],
-    },
-    {
-      listHeading: 'Individual questions',
-      listHeadingHidden: 'help topics',
-      itemsList: [
         {
-          url: '#individual1',
-          text: 'Name, date of birth and marital status',
+            listHeading: 'Individual questions',
+            listHeadingHidden: 'help topics',
+            itemsList: [
+                {
+                    url: '#individual1',
+                    text: 'Name, date of birth and marital status',
+                },
+            ],
         },
-      ],
-    },
-  ],
+    ],
 };
 
 describe('macro: table-of-contents', () => {
-  it('renders a default aria label', () => {
-    const $ = cheerio.load(renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_SINGLE));
+    it('renders a default aria label', () => {
+        const $ = cheerio.load(renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_SINGLE));
 
-    expect($('.ons-toc').attr('aria-label')).toBe('Table of contents');
-  });
-
-  it('renders the provided `ariaLabel`', () => {
-    const $ = cheerio.load(
-      renderComponent('table-of-contents', {
-        ...EXAMPLE_TABLE_OF_CONTENTS_SINGLE,
-        ariaLabel: 'Contents',
-      }),
-    );
-
-    expect($('.ons-toc').attr('aria-label')).toBe('Contents');
-  });
-
-  it('renders title as heading element', () => {
-    const $ = cheerio.load(renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_SINGLE));
-
-    expect($('.ons-toc__title').text().trim()).toBe('Contents');
-  });
-
-  describe('skip to content when `skipLink` is provided', () => {
-    it('passes jest-axe checks', async () => {
-      const $ = cheerio.load(renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_SKIP_LINK));
-
-      const results = await axe($.html());
-      expect(results).toHaveNoViolations();
+        expect($('.ons-toc').attr('aria-label')).toBe('Table of contents');
     });
 
-    it('outputs `skip-to-content` component', () => {
-      const faker = templateFaker();
-      const skipToContentSpy = faker.spy('skip-to-content');
+    it('renders the provided `ariaLabel`', () => {
+        const $ = cheerio.load(
+            renderComponent('table-of-contents', {
+                ...EXAMPLE_TABLE_OF_CONTENTS_SINGLE,
+                ariaLabel: 'Contents',
+            }),
+        );
 
-      faker.renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_SKIP_LINK);
-
-      expect(skipToContentSpy.occurrences[0]).toEqual({
-        url: '#the-content',
-        text: 'Skip to guide content',
-      });
+        expect($('.ons-toc').attr('aria-label')).toBe('Contents');
     });
-  });
 
-  describe('single list', () => {
-    it('passes jest-axe checks', async () => {
-      const $ = cheerio.load(renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_SINGLE));
+    it('renders title as heading element', () => {
+        const $ = cheerio.load(renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_SINGLE));
 
-      const results = await axe($.html());
-      expect(results).toHaveNoViolations();
+        expect($('.ons-toc__title').text().trim()).toBe('Contents');
     });
 
-    it('outputs `lists` component', () => {
-      const faker = templateFaker();
-      const listsSpy = faker.spy('list');
+    describe('skip to content when `skipLink` is provided', () => {
+        it('passes jest-axe checks', async () => {
+            const $ = cheerio.load(renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_SKIP_LINK));
 
-      faker.renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_SINGLE);
+            const results = await axe($.html());
+            expect(results).toHaveNoViolations();
+        });
 
-      expect(listsSpy.occurrences[0]).toEqual({
-        element: 'ol',
-        classes: 'ons-u-mb-m',
-        variants: 'dashed',
-        itemsList: EXAMPLE_TABLE_OF_CONTENTS_SINGLE.itemsList,
-      });
-    });
-  });
+        it('outputs `skip-to-content` component', () => {
+            const faker = templateFaker();
+            const skipToContentSpy = faker.spy('skip-to-content');
 
-  describe('multiple lists', () => {
-    it('passes jest-axe checks', async () => {
-      const $ = cheerio.load(renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_MULTIPLE));
+            faker.renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_SKIP_LINK);
 
-      const results = await axe($.html());
-      expect(results).toHaveNoViolations();
+            expect(skipToContentSpy.occurrences[0]).toEqual({
+                url: '#the-content',
+                text: 'Skip to guide content',
+            });
+        });
     });
 
-    it('renders a heading for each list', () => {
-      const $ = cheerio.load(renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_MULTIPLE));
+    describe('single list', () => {
+        it('passes jest-axe checks', async () => {
+            const $ = cheerio.load(renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_SINGLE));
 
-      $('.ons-u-vh').remove();
+            const results = await axe($.html());
+            expect(results).toHaveNoViolations();
+        });
 
-      const headings = mapAll($('h3'), (node) => $(node).text().trim());
-      expect(headings).toEqual(['Household questions:', 'Individual questions:']);
-    });
+        it('outputs `lists` component', () => {
+            const faker = templateFaker();
+            const listsSpy = faker.spy('list');
 
-    it('renders visually hidden heading for each list', () => {
-      const $ = cheerio.load(renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_MULTIPLE));
+            faker.renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_SINGLE);
 
-      const headings = mapAll($('h3 .ons-u-vh'), (node) => node.text().trim());
-      expect(headings).toEqual(['help topics', 'help topics']);
+            expect(listsSpy.occurrences[0]).toEqual({
+                element: 'ol',
+                classes: 'ons-u-mb-m',
+                variants: 'dashed',
+                itemsList: EXAMPLE_TABLE_OF_CONTENTS_SINGLE.itemsList,
+            });
+        });
     });
 
-    it('outputs `lists` component for each list', () => {
-      const faker = templateFaker();
-      const listsSpy = faker.spy('list');
-
-      faker.renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_MULTIPLE);
-
-      expect(listsSpy.occurrences[0]).toEqual({
-        element: 'ol',
-        classes: 'ons-u-mb-m',
-        variants: 'dashed',
-        itemsList: EXAMPLE_TABLE_OF_CONTENTS_MULTIPLE.lists[0].itemsList,
-      });
-      expect(listsSpy.occurrences[1]).toEqual({
-        element: 'ol',
-        classes: 'ons-u-mb-m',
-        variants: 'dashed',
-        itemsList: EXAMPLE_TABLE_OF_CONTENTS_MULTIPLE.lists[1].itemsList,
-      });
+    describe('multiple lists', () => {
+        it('passes jest-axe checks', async () => {
+            const $ = cheerio.load(renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_MULTIPLE));
+
+            const results = await axe($.html());
+            expect(results).toHaveNoViolations();
+        });
+
+        it('renders a heading for each list', () => {
+            const $ = cheerio.load(renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_MULTIPLE));
+
+            $('.ons-u-vh').remove();
+
+            const headings = mapAll($('h3'), (node) => $(node).text().trim());
+            expect(headings).toEqual(['Household questions:', 'Individual questions:']);
+        });
+
+        it('renders visually hidden heading for each list', () => {
+            const $ = cheerio.load(renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_MULTIPLE));
+
+            const headings = mapAll($('h3 .ons-u-vh'), (node) => node.text().trim());
+            expect(headings).toEqual(['help topics', 'help topics']);
+        });
+
+        it('outputs `lists` component for each list', () => {
+            const faker = templateFaker();
+            const listsSpy = faker.spy('list');
+
+            faker.renderComponent('table-of-contents', EXAMPLE_TABLE_OF_CONTENTS_MULTIPLE);
+
+            expect(listsSpy.occurrences[0]).toEqual({
+                element: 'ol',
+                classes: 'ons-u-mb-m',
+                variants: 'dashed',
+                itemsList: EXAMPLE_TABLE_OF_CONTENTS_MULTIPLE.lists[0].itemsList,
+            });
+            expect(listsSpy.occurrences[1]).toEqual({
+                element: 'ol',
+                classes: 'ons-u-mb-m',
+                variants: 'dashed',
+                itemsList: EXAMPLE_TABLE_OF_CONTENTS_MULTIPLE.lists[1].itemsList,
+            });
+        });
     });
-  });
 });

package/components/table-of-contents/_toc.scss

@@ -1,12 +1,12 @@
 .ons-toc {
-  &-container {
-    border-bottom: 1px solid var(--ons-color-grey-15);
-    margin-bottom: 2rem;
-    padding-bottom: 1rem;
-  }
+    &-container {
+        border-bottom: 1px solid var(--ons-color-grey-15);
+        margin-bottom: 2rem;
+        padding-bottom: 1rem;
+    }
 
-  &__link-active {
-    color: var(--ons-color-text-link-hover);
-    text-decoration: underline solid var(--ons-color-text-link-hover) 2px;
-  }
+    &__link-active {
+        color: var(--ons-color-text-link-hover);
+        text-decoration: underline solid var(--ons-color-text-link-hover) 2px;
+    }
 }

package/components/table-of-contents/example-table-of-contents-grouped.njk

@@ -47,4 +47,4 @@
             }
         ]
     })
-}}
+-}}

package/components/table-of-contents/example-table-of-contents-single.njk

@@ -36,4 +36,4 @@
             }
         ]
     })
-}}
+-}}

package/components/table-of-contents/example-table-of-contents-sticky-full-page.njk

@@ -1,37 +1,38 @@
 ---
-title: "Example: Table of contents on full page"
+title: 'Example: Table of contents on full page'
 layout: ~
 ---
-{% from "components/table-of-contents/_macro.njk" import onsTableOfContents %}
 
+{% from "components/table-of-contents/_macro.njk" import onsTableOfContents %}
 {% extends "layout/_template.njk" %}
-
-{% set pageConfig = {
-    "header": {
-        "title": "What is the census?"
-    },
-    "breadcrumbs": {
-        "ariaLabel": 'Back',
-        "itemsList": [
-            {
-                "url": '/',
-                "id": "back-example-feedback-form-error",
-                "text": 'Back',
-                "attributes": {
-                    "data-attribute": "Example attribute"
+{%
+    set pageConfig = {
+        "header": {
+            "title": "What is the census?"
+        },
+        "breadcrumbs": {
+            "ariaLabel": 'Back',
+            "itemsList": [
+                {
+                    "url": '/',
+                    "id": "back-example-feedback-form-error",
+                    "text": 'Back',
+                    "attributes": {
+                        "data-attribute": "Example attribute"
+                    }
                 }
+            ]
+        },
+        "footer": {
+            "OGLLink": {
+                "pre": 'All content is available under the',
+                "link": 'Open Government Licence v3.0',
+                "url": 'https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/',
+                "post": ', except where otherwise stated'
             }
-        ]
-    },
-    "footer": {
-        "OGLLink": {
-            "pre": 'All content is available under the',
-            "link": 'Open Government Licence v3.0',
-            "url": 'https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/',
-            "post": ', except where otherwise stated'
         }
     }
-} %}
+%}
 
 {% block main %}
     <div class="ons-page__container ons-container">
@@ -69,42 +70,82 @@ layout: ~
             <div class="ons-grid__col ons-col-7@m ons-push-1@m">
                 <section id="section1">
                     <h2>What is the census?</h2>
-                    <p>The census is a survey that happens every 10 years and gives us a picture of all the people and households in England and Wales.</p>
+                    <p>
+                        The census is a survey that happens every 10 years and gives us a picture of all the people and households in
+                        England and Wales.
+                    </p>
 
-                    <p>Your answers to the census questions will help organisations make decisions on planning and funding public services in your area, including transport, education and healthcare.</p>
+                    <p>
+                        Your answers to the census questions will help organisations make decisions on planning and funding public services
+                        in your area, including transport, education and healthcare.
+                    </p>
                 </section>
                 <section id="section2">
                     <h2>The online census has now closed</h2>
                     <p>Census Day was on Sunday 21 March 2021.</p>
 
-                    <p>If you still have a paper census questionnaire, fill it in as soon as you can and return it to FREEPOST, Census 2021.</p>
+                    <p>
+                        If you still have a paper census questionnaire, fill it in as soon as you can and return it to FREEPOST, Census
+                        2021.
+                    </p>
                 </section>
                 <section id="section3">
                     <h2>What happens after Census Day</h2>
-                    <p>Two follow-up surveys, the <a href="#0">Census Coverage Survey</a> and the <a href="#0">Census Quality Survey</a>, help to improve the quality and accuracy of the census results.</p>
+                    <p>
+                        Two follow-up surveys, the <a href="#0">Census Coverage Survey</a> and the <a href="#0">Census Quality Survey</a>,
+                        help to improve the quality and accuracy of the census results.
+                    </p>
 
-                    <p>Over the next year, we work hard to process the answers from all the census questionnaires. This is so that we can publish the initial Census 2021 findings one year after the census and the main releases two years after the census.</p>
+                    <p>
+                        Over the next year, we work hard to process the answers from all the census questionnaires. This is so that we can
+                        publish the initial Census 2021 findings one year after the census and the main releases two years after the census.
+                    </p>
 
-                    <p>To make sure the Census 2021 statistics we publish meet the needs of those who use them, we also run an outputs consultation.</p>
+                    <p>
+                        To make sure the Census 2021 statistics we publish meet the needs of those who use them, we also run an outputs
+                        consultation.
+                    </p>
                 </section>
                 <section id="section4">
                     <h2>The census in Northern Ireland and Scotland</h2>
                     <p>The Office for National Statistics (ONS) runs the census in England and Wales.</p>
 
-                    <p>If you live in Northern Ireland, visit the Northern Ireland Statistics Agency (NISRA) census website to find out about the census for Northern Ireland.</p>
+                    <p>
+                        If you live in Northern Ireland, visit the Northern Ireland Statistics Agency (NISRA) census website to find out
+                        about the census for Northern Ireland.
+                    </p>
 
-                    <p>If you live in Scotland, visit the National Records of Scotland census website to find out how to take part in the census for Scotland.</p>
+                    <p>
+                        If you live in Scotland, visit the National Records of Scotland census website to find out how to take part in the
+                        census for Scotland.
+                    </p>
                 </section>
                 <section id="section5">
                     <h2>The last census</h2>
-                    <p>The last census took place in 2011. Many people and organisations used information from the 2011 Census in a variety of ways.</p>
+                    <p>
+                        The last census took place in 2011. Many people and organisations used information from the 2011 Census in a variety
+                        of ways.
+                    </p>
 
-                    <p>For example, Bristol City Council used it to inform decisions on how to fund local housing improvements. It was also essential for the charity Redbridge Council for Voluntary Services to help people from ethnic minority groups learn more about dementia.</p>
+                    <p>
+                        For example, Bristol City Council used it to inform decisions on how to fund local housing improvements. It was also
+                        essential for the charity Redbridge Council for Voluntary Services to help people from ethnic minority groups learn
+                        more about dementia.
+                    </p>
 
-                    <p>To read more about the benefits that information from the 2011 Census helped to create, visit the Office for National Statistics (ONS) website.</p>
-                    <p>The Census Coverage Survey (CCS) was a short, separate survey that we at the Office for National Statistics (ONS) started six to eight weeks after Census Day.</p>
+                    <p>
+                        To read more about the benefits that information from the 2011 Census helped to create, visit the Office for
+                        National Statistics (ONS) website.
+                    </p>
+                    <p>
+                        The Census Coverage Survey (CCS) was a short, separate survey that we at the Office for National Statistics (ONS)
+                        started six to eight weeks after Census Day.
+                    </p>
 
-                    <p>The CCS helps make sure everyone is counted and our census results are as accurate as possible. It asked similar questions to the main census, just fewer of them, at addresses in a selection of postcodes across England and Wales.</p>
+                    <p>
+                        The CCS helps make sure everyone is counted and our census results are as accurate as possible. It asked similar
+                        questions to the main census, just fewer of them, at addresses in a selection of postcodes across England and Wales.
+                    </p>
 
                     <p>The CCS has now closed.</p>
                 </section>