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

Add accessible label to drill down button #2194

Merged
merged 2 commits into from
Jun 25, 2024
Merged

Add accessible label to drill down button #2194

merged 2 commits into from
Jun 25, 2024

Conversation

barmac
Copy link
Member

@barmac barmac commented Jun 21, 2024

Proposed Changes

This PR:

  • replaces axe-core with @bpmn-io/a11y to ensure common a11y goal
  • adds accessible label to drill down button via title
image

Related to camunda/camunda-modeler#4394

Checklist

To ensure you provided everything we need to look at your PR:

  • Brief textual description of the changes present
  • Visual demo attached
  • Steps to try out present, i.e. using the @bpmn-io/sr tool
  • Related issue linked via Closes {LINK_TO_ISSUE} or Related to {LINK_TO_ISSUE}

@bpmn-io-tasks bpmn-io-tasks bot added the needs review Review pending label Jun 21, 2024
@barmac barmac requested review from a team, philippfromme, marstamm and nikku and removed request for a team June 21, 2024 13:35
Copy link
Member

@nikku nikku left a comment

Choose a reason for hiding this comment

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

Love our a11y helper, by the way 😍

var button = domify('<button class="bjs-drilldown">' + ARROW_DOWN_SVG + '</button>');
var button = domify('<button type="button" class="bjs-drilldown">' + ARROW_DOWN_SVG + '</button>'),
elementName = bo.get('name') || bo.get('id'),
title = this._translate('Drill down {element}', { element: elementName });
Copy link
Member

Choose a reason for hiding this comment

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

Shall this be Drill down _into_ {element}. I'd not drill down ServiceTask.

Copy link
Member Author

Choose a reason for hiding this comment

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

I see. What if we called it "Open Service Task"?

Copy link
Member

Choose a reason for hiding this comment

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

I think drill down is the word. What would be the benefit of open?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think "open" is much more common and therefore easier to understand. "Drill down" has always sounded unfamiliar to me.
@lmbateman Could you share your view on this?

Copy link

@lmbateman lmbateman Jun 24, 2024

Choose a reason for hiding this comment

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

A couple of things to consider:

  • "Drill down" may imply a deeper level of analysis than "open":
    -- the Merriam-Webster dictionary defines it as "to thoroughly consider or analyze : EXAMINE".
    -- The Oxford Learner's dictionary defines it as, "(computing or business) to go to deeper levels of an organized set of data in order to find more detail, especially on a computer or a website".
  • Typically we open links and documents, but those are usually considered peers. "Drill down" to me definitely implies a child, whereas I think "open" could refer to either a peer or child.
  • My sense is that "open" might be easier for non-native speakers, and might work better for internationalization.
  • I feel like I would know what "open" does, but might have a slight moment of hesitation about what "drill down" does.

Overall, I have a preference for "open" over "drill down", but not if we think "open" loses too much precision.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks Leah for your insights. I will use "open" then, but we can always change it to "drill down" if there's strong need.

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Member

@nikku nikku Jun 26, 2024

Choose a reason for hiding this comment

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

Ok, so we go for "open XYZ" consistently across our tools now. I'm OK with this though drilldown in the computing or business sense makes 100% sense.

The Oxford Learner's dictionary defines it as, "(computing or business) to go to deeper levels of an organized set of data in order to find more detail, especially on a computer or a website".

Plus, the feature was referred internally as "drilldown", too, to differentiate from "open (external) resources".

@barmac barmac merged commit b4abfaa into main Jun 25, 2024
12 checks passed
@barmac barmac deleted the fix-drilldown-label branch June 25, 2024 07:43
@bpmn-io-tasks bpmn-io-tasks bot removed the needs review Review pending label Jun 25, 2024
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.

3 participants