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

Jump to bottom

Button: add a11y documentation for icon only button #3713

Merged
merged 6 commits into from
Nov 19, 2024
Merged

Button: add a11y documentation for icon only button #3713

merged 6 commits into from
Nov 19, 2024

Conversation

jakobe
Copy link
Collaborator

@jakobe jakobe commented Nov 19, 2024 •
edited
Loading

Which issue does this PR close?

This PR closes #3709

What is the new behavior?

  • Added a new section on a11y for icon only buttons
  • Icon only buttons with text and [showIconOnly]="true" makes the button text available to AT (visually hidden)

Does this PR introduce a breaking change?

  • Yes
  • No

Are there any additional context?

Checklist:

The following tasks should be carried out in sequence in order to follow the process of contributing correctly.

Reminders

  • Make sure you have implemented tests following the guidelines in: "The good: Test".
  • Make sure you have updated the cookbook with examples and showcases (for bug fixes, enhancements & new components).

Review

  • Determine if your changes are a fix, feature or breaking-change, and add the matching label to your PR. If it is tooling, dependency updates or similar, add ignore-for-release.
  • Do a self-review.
  • Request that the changes are code-reviewed
  • Request that the changes are UX reviewed (only necessary if your PR introduces visual changes)

When the pull request has been approved it will be merged to develop by Team Kirby.

@jakobe jakobe requested a review from jkaltoft as a code owner November 19, 2024 08:32
@jakobe jakobe added the feature Add this PR to the changelog as a feature label Nov 19, 2024
@github-actions github-actions bot temporarily deployed to pr-3709-add-a11y-documentation-for-icon-only-button November 19, 2024 08:37 Inactive
RasmusKjeldgaard
RasmusKjeldgaard reviewed Nov 19, 2024
View reviewed changes
Copy link
Collaborator

@RasmusKjeldgaard RasmusKjeldgaard left a comment

Choose a reason for hiding this comment

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

👏

apps/cookbook/src/app/showcase/button-showcase/button-showcase.component.html Outdated Show resolved Hide resolved
apps/cookbook/src/app/showcase/button-showcase/button-showcase.component.html Outdated Show resolved Hide resolved
jakobe and others added 2 commits November 19, 2024 11:28
@jakobe @RasmusKjeldgaard
📝 typo
3efa430 
Co-authored-by: RasmusKjeldgaard <rkk@bankdata.dk>
@jakobe @RasmusKjeldgaard
📝 improve readability
72be680 
Co-authored-by: RasmusKjeldgaard <rkk@bankdata.dk>
@github-actions github-actions bot temporarily deployed to pr-3709-add-a11y-documentation-for-icon-only-button November 19, 2024 10:33 Inactive
@github-actions github-actions bot had a problem deploying to pr-3709-add-a11y-documentation-for-icon-only-button November 19, 2024 10:34 Failure
@jakobe jakobe enabled auto-merge (squash) November 19, 2024 12:01
@jakobe jakobe added accessibility documentation Improve the documentation of Kirby labels Nov 19, 2024
RasmusKjeldgaard
RasmusKjeldgaard approved these changes Nov 19, 2024
View reviewed changes
Copy link
Collaborator

@RasmusKjeldgaard RasmusKjeldgaard left a comment

Choose a reason for hiding this comment

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

Great stuff!

@jakobe jakobe merged commit 2540a5b into develop Nov 19, 2024
12 checks passed
@jakobe jakobe deleted the enhancement/3709-add-a11y-documentation-for-icon-only-button branch November 19, 2024 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RasmusKjeldgaard RasmusKjeldgaard RasmusKjeldgaard approved these changes

@jkaltoft jkaltoft Awaiting requested review from jkaltoft jkaltoft is a code owner

Assignees
No one assigned
Labels
accessibility documentation Improve the documentation of Kirby feature Add this PR to the changelog as a feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add a11y documentation for icon only button
2 participants
@jakobe @RasmusKjeldgaard