Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DNM] Accordion documentation #579

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/components/accordion/default/index.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Accordion
layout: layout-example.njk
---
28 changes: 28 additions & 0 deletions src/components/accordion/index.md.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Accordion
description:
section: Components
aliases:
backlog_issue_id: 1
layout: layout-pane.njk
---

{% from "_example.njk" import example %}

The accordion component allows users to find content on a page faster by collapsing several sections so that their headers can be easily read, and then allowing access to the content of each section by expanding or collapsing them.


## When to use this component

Use the component component when you have several sections of content which users are unlikely to want to read all of at once.

## When not to use this component

Don’t use the component if you only have a single section to collapse. Consider the details component for that instead.

## How it works


## Research on this component

If you’ve used this component, get in touch to share your user research findings.