Skip to content

Commit

Permalink
Merge pull request #1087 from dpc-sdp/fix/docs-feedback
Browse files Browse the repository at this point in the history
fix(docs): 🐛 fix docs issues
  • Loading branch information
dylankelly authored Mar 21, 2024
2 parents cbffcc4 + 93510fc commit 7e8c5aa
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/content/design-system/5.components/accordion.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ id: core-containers-accordion--accordion
- Make sure accordion headings are descriptive and succinct.

### When and how not to use
- Never use a single accordion.
- Never use a single accordion.
- Avoid putting all page content into accordions.
- Don't use accordions for important information all users need to read.
- Putting accordions in accordions can confuse the user.
Expand Down Expand Up @@ -60,11 +60,11 @@ id: core-containers-accordion--accordion
::

### Numbered
Use the numbered variant when it is important the content is read in sequential order.
Use the numbered variant when it is important the content is read in sequential order.

::DocsExample
---
id: core-containers-accordion--accordion&args=numbered:true
id: core-containers-accordion--accordion-numbered
---
::

Expand Down
2 changes: 1 addition & 1 deletion docs/content/design-system/5.components/file.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use the File component to let users download an attachment. It is accompanied by
File is made up of:

- the file name
- metadata including file type, size and updated date
- metadata including file type and size
- a document description.

::DocsExample
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ export const Template = (args) => ({

<ArgsTable of={RplAccordion} />

## Default

<Canvas>
<Story
name='Accordion'
Expand All @@ -45,3 +47,19 @@ export const Template = (args) => ({
{Template.bind()}
</Story>
</Canvas>

## Numbered

<Canvas>
<Story
name='Accordion numbered'
play={a11yStoryCheck}
args={{
id: 'example',
items: SAMPLE,
numbered: true
}}
>
{Template.bind()}
</Story>
</Canvas>
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ const onClick = () => {
class="rpl-document__link rpl-u-focusable-within"
:href="url"
:download="download"
:target="openInNewWindow ? '_blank' : null"
:target="openInNewWindow ? '_blank' : undefined"
@click="onClick"
>
<div v-if="$slots.icon" class="rpl-document__icon">
Expand Down

0 comments on commit 7e8c5aa

Please sign in to comment.