patternfly / patternfly/patternfly-react
Spike - Investigate options for updating a11y props being required or not
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 862
- Forks
- 392
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 9
Description
Describe the enhancement or change
Spike for a discussion to have regarding https://github.com/patternfly/patternfly-react/issues/5397
Basically we need to decide whether:
-
we want to update certain a11y props to either be required (if currently optional) or make them optional (if currently required)
-
we want to add console warnings when an optional a11y prop is not passed in, but ideally should be (e.g. if an element doesn't have a visible text label, typically we should want an
aria-labeladded somewhere) -
leave things as-is - props will remain optional or required as they already are
-
some combination of all of the above
-
some props should have an (updated?) default value
Is this request originating from a Red Hat product team? If so, which ones and is there any sort of deadline for this enhancement?
Any other information?
Jira Issue: PF-108
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked PatternFly issue #5397 and reviewing the current required and optional accessibility props across the affected components. Compare the options described here, including warnings and defaults. Done means the alternatives, affected props, and a recommended direction are documented for discussion.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- accessibility
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100