salesforce / design-system-react

Salesforce Lightning Design System for React
https://design-system-react-site.herokuapp.com/
BSD 3-Clause "New" or "Revised" License
913 stars 415 forks source link

Add new prop to configure tree node selectable #3083

Open lyy011lyy opened 1 year ago

lyy011lyy commented 1 year ago

Fixes #

In some cases, we don't want the tree node to be selectable and keep refreshing itself, the issue description: https://github.com/salesforce/design-system-react/issues/3081

So I'm thinking to introduce this new prop for the Tree component to make the selectable node configurable.

Additional description


CONTRIBUTOR checklist (do not remove)

Please complete for every pull request

REVIEWER checklist (do not remove)

welcome[bot] commented 1 year ago

Thanks for opening this pull request! :100:

This is a community-driven project, and we can't do it without your participation. Please check out our contributing guidelines and review the Contributor Checklist if you haven't already, to make sure everything is squared away. CircleCI will take about 10 minutes to run through the same items that are on the Contributor checklist with a pass/fail check below. Please fix any issues that cause CircleCI to fail or ask for clarification--we try, but sometimes the errors can be unclear. A maintainer will try to respond within 7 days. If you haven’t heard anything by then, please bump this thread. To ensure codebase quality, large code line changes may take more than 2 weeks to review, but may take longer depending on the number of pull requests in the queue. Feel free to ask for a status update at any time--you won't be bothering anyone. Once feedback has been given, please reply to the feedback giver once the feedback on been addressed, so that they can continue the review. If you need a release while you are waiting for a code review, you can publish a built tag to your own fork. See directions in the release README.

salesforce-cla[bot] commented 1 year ago

Thanks for the contribution! Unfortunately we can't verify the commit author(s): Yaoyao Lin y***@s***.com. One possible solution is to add that email to your GitHub account. Alternatively you can change your commits to another email and force push the change. After getting your commits associated with your GitHub account, refresh the status of this Pull Request.

interactivellama commented 1 year ago

@lyy011lyy Hi, I've been on work leave until this week. Elements with role treeitems were never meant to have clickable children which is what the screen capture looks like. Per ARIA Tree spec, there's only one focus at a time in a Tree widget https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/tree_role#single_and_multiple_select_trees

I haven't looked over the PR yet, but am discussing what the Definition of Done for handling keyboard only use would look like in a Tree pattern that confirms to the ARIA spec, and I'm having difficulty with it. This library implements the patterns here: https://www.lightningdesignsystem.com/components/trees/ which are the scope of this component.

Based on the screenshot, you may be helped by the Tree Grid pattern which does allow multiple focusable elements. https://www.lightningdesignsystem.com/components/tree-grid/#Single-select-headless-with-no-borders-and-a-selected-row Screen Shot 2022-12-15 at 3 40 50 PM

A full TreeGrid pattern has not been added to this library. It would be great to add it. Here is a branch that is close to what you are looking for with a TreeGrid pattern + dropdown menu column. https://github.com/salesforce/design-system-react/pull/2181

The interactions and accessibility were never completed though however in order to add it officially to this library.