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

Fix/form caption accessibility #893

Merged
merged 9 commits into from
Feb 9, 2024
Merged

Fix/form caption accessibility #893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c5b65eb
dynamically inject base path
ChristianHoffmannS2 Feb 5, 2024
a928702
merge conflicts
davidken91 Feb 7, 2024
aeb26f4
fix(ui-library): resolving caption accessibility warning
davidken91 Feb 7, 2024
ecc5eb5
fix(ui-library): removing form caption aria label
davidken91 Feb 8, 2024
ec16d0e
Merge branch 'develop' into fix/form-caption-accessibility
davidken91 Feb 8, 2024
ddd18f0
fix(ui-library): restoring example js app configuration
davidken91 Feb 8, 2024
5f43df5
fix(ui-library): reverting ejs changes
davidken91 Feb 8, 2024
95096fc
fix(ui-library): removing aria-label from form caption group
davidken91 Feb 8, 2024
f0e9815
Merge branch 'develop' into fix/form-caption-accessibility
davidken91 Feb 9, 2024
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
2 changes: 0 additions & 2 deletions packages/ui-library/src/components/internal-components/form-caption-group/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ const hintCaption = BlrFormCaptionRenderFunction({
icon: 'blrInfo',
size: 'md',
theme: 'Light',
arialabel: 'Form Hint',
});

const errorCaption = BlrFormCaptionRenderFunction({
Expand All @@ -27,7 +26,6 @@ const errorCaption = BlrFormCaptionRenderFunction({
icon: 'blrInfo',
size: 'md',
theme: 'Light',
arialabel: 'Form Error',
});

const mixedCaptions = html` ${hintCaption} ${errorCaption} `;
Expand Down
9 changes: 0 additions & 9 deletions packages/ui-library/src/components/internal-components/form-caption/index.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,6 @@ export default {
category: 'Content / Setting',
},
},
arialabel: {
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this mean that this property needs to be removed from all other components or just the formCaption?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't believe so, the other aria-labels are being used on buttons and form components which would make sense because it doesn't contain any text that can be picked up by a screen reader. I just updated my PR btw, I noticed that I never removed it from the formCaptionGroup

options: [undefined, ...PureIconKeys],
description:
'Provides additional information about the elements purpose and functionality to assistive technologies, such as screen readers.',
table: {
category: 'Accessibility',
},
},
},
parameters: {
design: {
Expand Down Expand Up @@ -97,7 +89,6 @@ BlrFormCaption.storyName = 'Form Caption';
const args: BlrFormCaptionType = {
theme: 'Light',
message: 'Message-text',
arialabel: 'Hint',
icon: 'blr360',
variant: 'hint',
size: 'sm',
Expand Down
3 changes: 1 addition & 2 deletions packages/ui-library/src/components/internal-components/form-caption/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ export class BlrFormCaption extends LitElement {
static styles = [];

@property() message?: string;
@property() arialabel?: string;
@property() icon?: SizelessIconType;
@property() variant: CaptionVariantType = 'hint';
@property() size?: FormSizesType = 'md';
Expand Down Expand Up @@ -50,7 +49,7 @@ export class BlrFormCaption extends LitElement {
<style>
${dynamicStyles}
</style>
<div class=${classes} aria-label=${this.arialabel || nothing}>
<div class=${classes}>
${this.icon
? BlrIconRenderFunction(
{
Expand Down
Loading