diff --git a/packages/css/src/components/description-list/description-list.scss b/packages/css/src/components/description-list/description-list.scss index 4c3c983fd0..40c1db033c 100644 --- a/packages/css/src/components/description-list/description-list.scss +++ b/packages/css/src/components/description-list/description-list.scss @@ -54,15 +54,15 @@ } } -@mixin reset-details { +@mixin reset-description { margin-inline: 0; } -.ams-description-list__details { - font-weight: var(--ams-description-list-details-font-weight); - padding-inline-start: var(--ams-description-list-details-padding-inline-start); +.ams-description-list__description { + font-weight: var(--ams-description-list-description-font-weight); + padding-inline-start: var(--ams-description-list-description-padding-inline-start); - @include reset-details; + @include reset-description; @media screen and (min-width: $ams-breakpoint-medium) { grid-column-start: 2; diff --git a/packages/react/src/DescriptionList/DescriptionList.tsx b/packages/react/src/DescriptionList/DescriptionList.tsx index b65f45e22a..65b54b325d 100644 --- a/packages/react/src/DescriptionList/DescriptionList.tsx +++ b/packages/react/src/DescriptionList/DescriptionList.tsx @@ -6,7 +6,7 @@ import clsx from 'clsx' import { forwardRef } from 'react' import type { ForwardedRef, HTMLAttributes, PropsWithChildren } from 'react' -import { DescriptionListDetails } from './DescriptionListDetails' +import { DescriptionListDescription } from './DescriptionListDescription' import { DescriptionListTerm } from './DescriptionListTerm' export const descriptionListTermsWidths = ['sm', 'md', 'lg'] as const @@ -43,5 +43,5 @@ DescriptionListRoot.displayName = 'DescriptionList' export const DescriptionList = Object.assign(DescriptionListRoot, { Term: DescriptionListTerm, - Details: DescriptionListDetails, + Description: DescriptionListDescription, }) diff --git a/packages/react/src/DescriptionList/DescriptionListDetails.test.tsx b/packages/react/src/DescriptionList/DescriptionListDescription.test.tsx similarity index 62% rename from packages/react/src/DescriptionList/DescriptionListDetails.test.tsx rename to packages/react/src/DescriptionList/DescriptionListDescription.test.tsx index 56129737e6..41b7dfa4ea 100644 --- a/packages/react/src/DescriptionList/DescriptionListDetails.test.tsx +++ b/packages/react/src/DescriptionList/DescriptionListDescription.test.tsx @@ -5,7 +5,7 @@ import '@testing-library/jest-dom' describe('Description List Description', () => { it('renders', () => { - render(Test) + render(Test) const component = screen.getByRole('definition') @@ -14,25 +14,25 @@ describe('Description List Description', () => { }) it('renders a design system BEM class name', () => { - render(Test) + render(Test) const component = screen.getByRole('definition') - expect(component).toHaveClass('ams-description-list__details') + expect(component).toHaveClass('ams-description-list__description') }) it('renders an additional class name', () => { - render(Test) + render(Test) const component = screen.getByRole('definition') - expect(component).toHaveClass('ams-description-list__details extra') + expect(component).toHaveClass('ams-description-list__description extra') }) it('supports ForwardRef in React', () => { const ref = createRef() - render(Test) + render(Test) const component = screen.getByRole('definition') diff --git a/packages/react/src/DescriptionList/DescriptionListDescription.tsx b/packages/react/src/DescriptionList/DescriptionListDescription.tsx new file mode 100644 index 0000000000..798e1bae33 --- /dev/null +++ b/packages/react/src/DescriptionList/DescriptionListDescription.tsx @@ -0,0 +1,20 @@ +/** + * @license EUPL-1.2+ + * Copyright Gemeente Amsterdam + */ + +import clsx from 'clsx' +import { forwardRef } from 'react' +import type { ForwardedRef, HTMLAttributes, PropsWithChildren } from 'react' + +export type DescriptionListDescriptionProps = PropsWithChildren> + +export const DescriptionListDescription = forwardRef( + ({ children, className, ...restProps }: DescriptionListDescriptionProps, ref: ForwardedRef) => ( +
+ {children} +
+ ), +) + +DescriptionListDescription.displayName = 'DescriptionList.Description' diff --git a/packages/react/src/DescriptionList/DescriptionListDetails.tsx b/packages/react/src/DescriptionList/DescriptionListDetails.tsx deleted file mode 100644 index 79a800891a..0000000000 --- a/packages/react/src/DescriptionList/DescriptionListDetails.tsx +++ /dev/null @@ -1,20 +0,0 @@ -/** - * @license EUPL-1.2+ - * Copyright Gemeente Amsterdam - */ - -import clsx from 'clsx' -import { forwardRef } from 'react' -import type { ForwardedRef, HTMLAttributes, PropsWithChildren } from 'react' - -export type DescriptionListDetailsProps = PropsWithChildren> - -export const DescriptionListDetails = forwardRef( - ({ children, className, ...restProps }: DescriptionListDetailsProps, ref: ForwardedRef) => ( -
- {children} -
- ), -) - -DescriptionListDetails.displayName = 'DescriptionList.Details' diff --git a/packages/react/src/DescriptionList/index.ts b/packages/react/src/DescriptionList/index.ts index fa57776c93..b5895ee183 100644 --- a/packages/react/src/DescriptionList/index.ts +++ b/packages/react/src/DescriptionList/index.ts @@ -1,4 +1,4 @@ export { DescriptionList } from './DescriptionList' export type { DescriptionListProps } from './DescriptionList' export type { DescriptionListTermProps } from './DescriptionListTerm' -export type { DescriptionListDetailsProps } from './DescriptionListDetails' +export type { DescriptionListDescriptionProps } from './DescriptionListDescription' diff --git a/proprietary/tokens/src/components/ams/description-list.tokens.json b/proprietary/tokens/src/components/ams/description-list.tokens.json index 639290b568..1339b48d6b 100644 --- a/proprietary/tokens/src/components/ams/description-list.tokens.json +++ b/proprietary/tokens/src/components/ams/description-list.tokens.json @@ -11,7 +11,7 @@ "term": { "font-weight": { "value": "{ams.text.font-weight.bold}" } }, - "details": { + "description": { "font-weight": { "value": "{ams.text.font-weight.normal}" }, "padding-inline-start": { "value": "{ams.space.lg}" } } diff --git a/storybook/src/components/DescriptionList/DescriptionList.stories.tsx b/storybook/src/components/DescriptionList/DescriptionList.stories.tsx index a61605e981..4719cc032f 100644 --- a/storybook/src/components/DescriptionList/DescriptionList.stories.tsx +++ b/storybook/src/components/DescriptionList/DescriptionList.stories.tsx @@ -15,15 +15,15 @@ const meta = { args: { children: [ Het hoger onderwijs, - Het hbo en wo, + Het hbo en wo, Het mbo en hoger onderwijs, - Het vervolgonderwijs, + Het vervolgonderwijs, Laagopgeleid, - Praktisch opgeleid, + Praktisch opgeleid, Hoogopgeleid, - Theoretisch opgeleid, + Theoretisch opgeleid, Opleidingsniveau, - Onderwijsrichting, + Onderwijsrichting, ], inverseColor: false, }, @@ -48,10 +48,10 @@ export const MultipleDescriptions: Story = { args: { children: [ Blinde, slechtziende, - Persoon met een visuele beperking, - Persoon met een visuele handicap, - Persoon die blind is, - Persoon die slechtziend is, + Persoon met een visuele beperking, + Persoon met een visuele handicap, + Persoon die blind is, + Persoon die slechtziend is, ], }, } @@ -60,7 +60,7 @@ export const RichDescription: Story = { render: (args) => ( Amsterdam Light Festival - + Een jaarlijks evenement waarbij kunstenaars van over de hele wereld hun{' '} creatieve lichtinstallaties tonen. De kunstwerken zijn verspreid over de stad en zijn zowel @@ -77,7 +77,7 @@ export const RichDescription: Story = { . - + ), } @@ -87,9 +87,9 @@ export const MultipleTerms: Story = { children: [ mbo-leerling, mbo-scholier, - + mbo-student - , + , ], }, }