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.

Sign up for GitHub

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

Set language on document instead of screen #730

Merged
merged 3 commits into from
Nov 9, 2023
Merged

Set language on document instead of screen #730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
81ed87f
Revert "Set screen language to Dutch (#710)"
VincentSmedinga Nov 8, 2023
00129f7
Update documentation on the language attribute
VincentSmedinga Nov 8, 2023
906f4cc
Merge branch 'main' into feature/DES-490-revert-screen-lang-prop
alimpens Nov 9, 2023
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
7 changes: 1 addition & 6 deletions packages/react/src/Screen/Screen.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,7 @@ export interface ScreenProps extends PropsWithChildren<HTMLAttributes<HTMLDivEle

export const Screen = forwardRef(
({ children, className, maxWidth = 'wide', ...restProps }: ScreenProps, ref: ForwardedRef<HTMLDivElement>) => (
<div
{...restProps}
ref={ref}
className={clsx('amsterdam-screen', `amsterdam-screen--${maxWidth}`, className)}
lang="nl"
>
<div {...restProps} ref={ref} className={clsx('amsterdam-screen', `amsterdam-screen--${maxWidth}`, className)}>
{children}
</div>
),
Expand Down
52 changes: 52 additions & 0 deletions storybook/storybook-docs/src/language.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import { Meta } from "@storybook/blocks";

<Meta title="Docs/Designrichtlijnen/Taal" />

# Taal

## Geef de taal op voor het hele document

Het is verplicht om expliciet aan te geven in welke taal de inhoud van je pagina is.
Met de juiste taal ingesteld werkt je applicatie beter.
Schermlezers kunnen hiermee tekst in de juiste taal uitspreken.
Ook voor zoekmachineoptimalisatie (SEO) is het nuttig.

Geef de taal aan op het `<html>`-element van je applicatie.
Immers, ook de inhoud van elementen in de `<head>`, zoals `title` en `meta`, bevatten inhoud in dezelfde taal.
Dat is buiten de scope van de componenten van het design system.
Vandaar dat je er zelf aan moet denken dit goed te doen.

```html
<html lang="nl">
…
</html>
```

## Markeer elementen in een andere taal

Als een specifiek element in een andere taal is geschreven geef je dat daar aan.

Bijvoorbeeld voor een link naar een Engelse site of pagina in een menu:

```html
<nav>
<ul>
<li><a href="https://mijn.amsterdam.nl/">Mijn Amsterdam</a></li>
<li><a href="https://www.amsterdam.nl/en/" lang="en">English site</a></li>
</ul>
</nav>
```

## Specificeer de regio niet

De _language tag_ `nl` is voldoende.
Die uitbreiden met de _region subtag_ `nl-NL` is niet nodig:

> The golden rule when creating language tags is to keep the tag as short as possible.
> Avoid region, script or other subtags except where they add useful distinguishing information.
> For instance, use `ja` for Japanese and not `ja-JP`, unless there is a particular reason that you need to say that this is Japanese as spoken in Japan, rather than elsewhere.
> – [W3C Internationalization Activity](https://www.w3.org/International/articles/language-tags/)

## Relevante WCAG-eisen

- [WCAG 3.1.2](https://www.w3.org/TR/WCAG22/#language-of-parts): geef aan in welke taal tekst in een afwijkende taal is
23 changes: 0 additions & 23 deletions storybook/storybook-docs/src/typography.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,29 +94,6 @@ Een manier om dat te doen is met de volgende _css snippet_, waarin `hyphens` en

Voor verdere informatie: [Wrapping and breaking text op MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_text/Wrapping_breaking_text)

## Andere talen

Geef programmatisch aan in welke taal tekst in een afwijkende taal is.
Dit is onder andere nodig zodat schermlezers deze tekst in de juiste taal uitspreken.

```html
<html lang="nl-NL">
<head>
...
</head>
<body>
<ul>
<li><a href="https://mijn.amsterdam.nl/">Mijn Amsterdam</a></li>
<li><a href="https://www.amsterdam.nl/en/" lang="en">English site</a></li>
</ul>
</body>
</html>
```

### Relevante WCAG-eisen

- [WCAG 3.1.2](https://www.w3.org/TR/WCAG22/#language-of-parts): geef aan in welke taal tekst in een afwijkende taal is

## Hoe te gebruiken?

Er zijn twee manieren om Amsterdam Sans te gebruiken in je applicatie:
Expand Down