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.

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

feat(documentation): Reorganized Accessibility folder and added Form Grouping Controls Section #3638

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

myrta2302
Copy link

@myrta2302 myrta2302 commented Oct 3, 2024

No description provided.

Copy link

changeset-bot bot commented Oct 3, 2024

🦋 Changeset detected

Latest commit: 2fc639b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@swisspost/design-system-documentation Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@swisspost-bot
Copy link
Contributor

swisspost-bot commented Oct 3, 2024

Related Previews

Copy link

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher

🚮 Removed packages: npm/[email protected], npm/[email protected]

View full report↗︎

Copy link

sonarcloud bot commented Oct 3, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
2 New Code Smells (required ≤ 0)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

@myrta2302 myrta2302 marked this pull request as draft October 3, 2024 16:16
… section with minor text changes and corrected the div example
@myrta2302 myrta2302 marked this pull request as ready for review October 4, 2024 07:13
@oliverschuerch oliverschuerch changed the title feat(documentation): Reorganized Accessibility folder and added Form G… feat(documentation): Reorganized Accessibility folder and added Form Grouping Controls Section Oct 7, 2024
Copy link
Contributor

@oliverschuerch oliverschuerch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also it would be nice to have the "Regulations" page at the beginning of the newly created subpages. So "Accessibility/Regulations" comes first and the others do not need an order.

To do so, you can open the documentation/.storybook/preview.ts and add the following:
image


### Disabled state
## Disabled state

Disabled states of input fields or buttons pose many accessibility issues.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also fix the wrong implementation of ul / li elements?
A div is semantically wrong here and not allowed as a child in an ul element.

Should be implemented somehow like this:

<ul class="list-unstyled">
  <li class="d-flex gap-mini">
    <div></div><div>List Item text</div>
  </li>
</ul>

Do this for all ul / li constructs on the page, which are using ❌ or ✔️ as marker/icon.

Comment on lines +330 to +331
<div role="group" aria-labelledby="group-label "aria-describedby="group-description">
<span id="group-label" style="margin-right:5px">Gender </span>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These elements are not rendered on the page under the preview URL. Not sure why, do you have any idea?


<figure>
<blockquote class="blockquote" lang="de">
<p>Die Postdienste müssen so angeboten werden, dass Menschen mit Behinderungen
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we translate this to english? For example with the post translater or with deepl or some other online service.

Bedingungen wie Menschen ohne Behinderungen beanspruchen können.</p>
</blockquote>
<figcaption class="blockquote-footer">
<cite>§14.7 <a href="https://www.fedlex.admin.ch/eli/cc/2012/585/de#art_14">Swiss postal law</a></cite>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the language can be choosen by the page itself, depending on the browser language.

Suggested change
<cite>§14.7 <a href="https://www.fedlex.admin.ch/eli/cc/2012/585/de#art_14">Swiss postal law</a></cite>
<cite>§14.7 <a href="https://www.fedlex.admin.ch/eli/cc/2012/585">Swiss postal law</a></cite>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Accessibility docs: define guiding rules for grouping, labels and disabled state
3 participants