Enhancement: Update Dropdown props to support customizing additional ARIA attributes #1080
Conversation
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1080 +/- ##
=======================================
Coverage 84.20% 84.20%
=======================================
Files 1146 1146
Lines 21041 21044 +3
Branches 7997 7999 +2
=======================================
+ Hits 17717 17721 +4
+ Misses 3236 3235 -1
Partials 88 88 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![factory-droid[bot]](https://avatars.githubusercontent.com/in/358017?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Description:
The PR enhances the Dropdown component's accessibility implementation by adding ariaHaspopupValue and referenceRole props, and allowing null values for the role prop. A key change preserves existing aria-haspopup values when using ariaRef, maintaining consistency with child reference handling. All changes maintain backward compatibility while providing more granular control over ARIA attributes.
Review:
LGTM
Click For Summary of Files
Summary of Files
Files Modified
src/components/Dropdown/Dropdown.tsx
Enhanced Dropdown component's ARIA attribute handling with configurable values:
- Added new props ariaHaspopupValue and referenceRole to customize ARIA attributes
- Modified ARIA attribute handling to preserve existing aria-haspopup values when using ariaRef
- Updated role and aria-haspopup attribute assignment to use new configurable props while maintaining backward compatibility
src/components/Dropdown/Dropdown.types.ts
Enhanced Dropdown component accessibility configuration:
- Added new props for fine-grained ARIA control:
- ariaHaspopupValue to customize aria-haspopup attribute
- referenceRole to set reference element role
- Modified role prop to accept null values, allowing role attribute suppression
Tips
Review Droid is highly customizable and comes with powerful features for augmenting your organization's code review process. Here are some tips to get the most out of it.
Table of contents
- Droid Fill - Contextual PR Body Replacement
- Review Guidelines - Creating guidelines for Droid to enforce
- Droid Chat - Follow up with Droid's Comments
- PR Healing - Diagnose & Fix Failures in CI
- Teaching Droid - Giving Droid feedback so it learns
- Review Usage
⌨️ Droid Fill
Contextual PR Body Replacement
When you create a PR with the @droid fill command anywhere in your PR body, Review Droid will fill in the PR description for your pull request based on it's PR analysis. This will also take into account your pull request templates.
Review Droid can also analyze your project management system. If you have a project management system integrated with Factory (e.g. Linear, Jira) Review Droid will also integrate information from linked and related tickets.
At Factory, we typically create our PR's with this command. For example, let's say I'm creating a PR which addresses the jira ticket FAC-123. I would write the following PR description:
@droid fill FAC-123
and your Review Droid fills in the rest!
📚 Review Guidelines
Creating guidelines for Droid to follow
You can configure guidelines that Droid will follow when reviewing your PRs. Droid will focus on these aspects of your code and aim to leave in-line comments if any guidelines are violated.
Guidelines are defined in your repository's .droid.yaml. Every week, Droid will automatically refine and edit these guidelines based on the feedback you leave on Droid's comments.
💬 Droid Chat
Ask questions on a PR
You can leave in-line comments on PR's by tagging @droid in-line. This can be helpful when reviewing other's PRs. Some examples include:
@droid this section looks sketchy, are there issues with it?@droid can you show me some examples of what this regex matches?@droid is this the most efficient way to do this? I'm concerned about performance.
Follow up with Review Droid's Comments
You can reply to Review Droid's in-line review comments directly to ask questions or provide feedback. Some examples include:
@droid I made the change you suggested, does that fix the issue?@droid we don't actually need to do this because of X, Y, Z. Can you confirm?@droid do we have any scripts that rely on this behavior?
🛠️ PR Healing
Diagnose & Fix Failures in CI
Review Droid is aware of the CI processes you utilize and proposes fixes in case of any failures. This allows it to promptly address issues in your pull requests before they escalate.
By default, PR Healing is activated. Your organization does not have advanced PR healing enabled, which involved Review Droid directly making a PR to your PR which fixes the issue. If you would like to enable this feature, you must have an Enterprise Plan.
🎓 Teaching Droid
Giving Droid feedback so it learns
You can give feedback to Review Droid by replying or reacting to its comments (👍 / 👎). This helps Review Droid learn from your preferences and improve its future reviews.
To send feedback directly to the Factory team, include @droid feedback in your comment. Droid will file a ticket with your feedback and provide a ticket ID so you can track it with our support team.
🔎 Review Usage
Re-Requesting Review
If you make changes to your PR and want Review Droid to re-review it, you can simply comment @droid review on the PR. This will trigger Droid to re-review the PR and update the review body.
.droid.yaml to Configure Review Droid
You can place a .droid.yaml file in the root of your repository. This file contains settings for a variety of features and settings including:
- Guidelines - For defining the rules that Review Droid will enforce
- Enabling/Disabling Per-file Summaries
- Enabling/Disabling PR Healing
- Path Filters (For ignoring certain files or directories)
- Auto-Review Settings
- Chat settings
To override a setting leave a comment on a PR with the setting to disable/enable/reset. For example @droid setting disable progress_comment. The current options are: progress_comment, lgtm_comment, and list.
list is a special setting that will list all the settings that you have set and will explain what each setting does.
For more information, you can view our documentation at https://docs.factory.ai - the password is factory.
Ignoring Reviews
If you want to have your PR ignored by Review Droid you can define Droid Ignored Title Words in your .droid.yaml file. If the title of your PR contains any of these words, Review Droid will ignore the PR.
Your organization currently has the following words in the Droid Ignored Title Words list:
None
kheinrich-eightfold
force-pushed
the
kheinrich/dropdown-expand-a11y-props
branch
from
6fde721 to
403a415
Compare
kheinrich-eightfold
requested review from
darora-eightfold,
sravichandran-eightfold,
ychhabra-eightfold,
ygupta-eightfold and
ykelkar-eightfold
kheinrich-eightfold
changed the title
SUMMARY:
This PR makes some minor updates to the Dropdown component which are needed to allow consumers to correctly implement certain ARIA patterns.
ariaHaspopupValueandreferenceRole. Existing default values are kept for backward compatibility.roleprop to allownullvalues, which will unset the role from the overlay wrapper. This is needed when the overlay brings its ownroleattribute, e.g. when usingMenuas overlay (very common case). The existing default value has been kept for backward compatibility.Note: One change to logic is made. When applying aria-* attributes to the
ariaRefelement (when provided), Dropdown will now preserve the existing value for aria-haspopup if the attribute is present. This keeps the logic in sync with what we do for the child reference element whenariaRefis not provided. Test case has been added to validate this behavior.GITHUB ISSUE (Open Source Contributors)
JIRA TASK (Eightfold Employees Only):
https://eightfoldai.atlassian.net/browse/ENG-173877
CHANGE TYPE:
TEST COVERAGE:
TEST PLAN:
No change to default behavior, other than the edge case covered in the test. Prop changes are opt-in, preserving the existing behavior but increasing flexibility for consuming components.