diff --git a/packages/css/src/components/mark/README.md b/packages/css/src/components/mark/README.md index 347d4c08df..a0549e380e 100644 --- a/packages/css/src/components/mark/README.md +++ b/packages/css/src/components/mark/README.md @@ -1 +1,18 @@ # Mark + +Markeert een fragment tekst met een gele achtergrond. +Het zorgt voor sterke nadruk op de tekst en leidt de aandacht ernaartoe. + +## Richtlijnen + +### Zo gebruiken + +- Maximaal 1 markering per pagina. + De voorkeur is geen markering. +- Maximaal 1 zin. + +### Dit vermijden + +- Niet in de titel en subtitels gebruiken. + Zorg voor een belangrijke, pakkende titel als de hele paragraaf belangrijk is. +- Mag niet voor een hele paragraaf gebruikt worden. diff --git a/packages/css/src/components/mark/mark.scss b/packages/css/src/components/mark/mark.scss index 6e3021129d..d4cb0d3f70 100644 --- a/packages/css/src/components/mark/mark.scss +++ b/packages/css/src/components/mark/mark.scss @@ -4,5 +4,5 @@ */ .amsterdam-mark { - /* Add styles here */ + background-color: var(--amsterdam-mark-background-color); } diff --git a/packages/react/src/Mark/Mark.test.tsx b/packages/react/src/Mark/Mark.test.tsx index 972fd8ad36..3d7791baa7 100644 --- a/packages/react/src/Mark/Mark.test.tsx +++ b/packages/react/src/Mark/Mark.test.tsx @@ -6,38 +6,27 @@ import '@testing-library/jest-dom' describe('Mark', () => { it('renders', () => { const { container } = render() - const component = container.querySelector(':only-child') - expect(component).toBeInTheDocument() expect(component).toBeVisible() }) it('renders a design system BEM class name', () => { const { container } = render() - const component = container.querySelector(':only-child') - expect(component).toHaveClass('amsterdam-mark') }) it('renders an additional class name', () => { const { container } = render() - const component = container.querySelector(':only-child') - - expect(component).toHaveClass('extra') - - expect(component).toHaveClass('amsterdam-mark') + expect(component).toHaveClass('amsterdam-mark extra') }) it('supports ForwardRef in React', () => { const ref = createRef() - const { container } = render() - const component = container.querySelector(':only-child') - expect(ref.current).toBe(component) }) }) diff --git a/packages/react/src/Mark/Mark.tsx b/packages/react/src/Mark/Mark.tsx index 205a2e8999..e8001d53cf 100644 --- a/packages/react/src/Mark/Mark.tsx +++ b/packages/react/src/Mark/Mark.tsx @@ -9,9 +9,9 @@ import { ForwardedRef, forwardRef, HTMLAttributes, PropsWithChildren } from 'rea export interface MarkProps extends PropsWithChildren> {} export const Mark = forwardRef(({ children, className, ...restProps }: MarkProps, ref: ForwardedRef) => ( - + {children} - + )) Mark.displayName = 'Mark' diff --git a/proprietary/tokens/src/components/amsterdam/mark.tokens.json b/proprietary/tokens/src/components/amsterdam/mark.tokens.json index 3a9bc91fa0..3d423de5e8 100644 --- a/proprietary/tokens/src/components/amsterdam/mark.tokens.json +++ b/proprietary/tokens/src/components/amsterdam/mark.tokens.json @@ -1,5 +1,7 @@ { "amsterdam": { - "mark": {} + "mark": { + "background-color": { "value": "var(--amsterdam-color-yellow)" } + } } } diff --git a/storybook/storybook-react/src/Mark/Mark.docs.mdx b/storybook/storybook-react/src/Mark/Mark.docs.mdx index ddabe39931..91198fcec0 100644 --- a/storybook/storybook-react/src/Mark/Mark.docs.mdx +++ b/storybook/storybook-react/src/Mark/Mark.docs.mdx @@ -1,4 +1,4 @@ -import { Controls, Markdown, Meta, Primary } from "@storybook/blocks"; +import { Markdown, Meta, Primary } from "@storybook/blocks"; import * as MarkStories from "./Mark.stories.tsx"; import README from "../../../../packages/css/src/components/mark/README.md?raw"; @@ -6,6 +6,6 @@ import README from "../../../../packages/css/src/components/mark/README.md?raw"; {README} - +## Voorbeeld - + diff --git a/storybook/storybook-react/src/Mark/Mark.stories.tsx b/storybook/storybook-react/src/Mark/Mark.stories.tsx index 262e9ec975..52f14b5fb4 100644 --- a/storybook/storybook-react/src/Mark/Mark.stories.tsx +++ b/storybook/storybook-react/src/Mark/Mark.stories.tsx @@ -3,11 +3,11 @@ * Copyright (c) 2023 Gemeente Amsterdam */ -import { Mark } from '@amsterdam/design-system-react' +import { Mark, Paragraph } from '@amsterdam/design-system-react' import { Meta, StoryObj } from '@storybook/react' const meta = { - title: 'Mark', + title: 'Text/Mark', component: Mark, args: { children: 'Nieuw component', @@ -18,4 +18,15 @@ export default meta type Story = StoryObj -export const Default: Story = {} +export const Default: Story = { + args: { + children: 'Wat vinden Amsterdammers belangrijk?', + }, + render: (args) => ( + + Daarom organiseren we in 2024 het burgerberaad schone stad, waarin 150 Amsterdammers in gesprek gaan over hoe we + de stad beter schoonhouden. {args.children} Welke oplossingen zien zij? Hier zijn we benieuwd naar. + Want elke Amsterdammer heeft afval en moet het kwijt. Wij kunnen als gemeente veel van deze afvalexperts leren. + + ), +}