Skip to content

Commit

Permalink
Use ‘description’ instead of ‘details’
Browse files Browse the repository at this point in the history
  • Loading branch information
VincentSmedinga committed Oct 21, 2024
1 parent e44cea1 commit 4f68bd0
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions packages/css/src/components/description-list/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

# Description List

A collection of terms and their details.
A collection of terms and their descriptions.

## Design

On a narrow screen, details appear indented below their term.
From the medium breakpoint, terms and details appear next to each other.
The column for the details is twice as wide as the one for the term.
On a narrow screen, descriptions appear indented below their term.
From the medium breakpoint, terms and descriptions appear next to each other.
The column for the descriptions is twice as wide as the one for the term.
The term is set in bold text.

## References
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ import README from "../../../../packages/css/src/components/description-list/REA

### Multiple details

A term may have multiple details.
A term may have multiple descriptions.

<Canvas of={DescriptionListStories.MultipleDetails} />
<Canvas of={DescriptionListStories.MultipleDescriptions} />

### Inverse colour

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ type Story = StoryObj<typeof meta>

export const Default: Story = {}

export const MultipleDetails: Story = {
export const MultipleDescriptions: Story = {
args: {
children: [
<DescriptionList.Term key={1}>blinde, slechtziende</DescriptionList.Term>,
Expand Down

0 comments on commit 4f68bd0

Please sign in to comment.