Keytips

[gouttierre]

💡 When you create a PR for any of the checklist items, add a link to this Epic under the PR's Related Issues section.

Preparation

• Open UI Research
  • OpenUI does not have research on Keytips.
• Open GitHub issues related to component
  • [Feature]: KeyTipLayer add ability to invoke keytips after certain amount of time #31500
  • [Feature]: KeyTipLayer add support for keyUp event #31499
• Create react-keytips-preview package
• (Optional) Draft implementation
  • Draft implementation in fluent-contrib
• Component Spec authored and reviewed
  • Spec in fluent-contrib

Implementation

• Component implementation
• Initial conformance and unit tests (validate basic functionality)
• Initial documentation
  • Storybook stories
  • README.md covering basic usage
  • MIGRATION.md guide (include v8 and v0)
• Component released as preview

Validation

• Add tests
  • Unit and conformance tests
  • VR tests
  • Bundle size fixtures
  • Accessibility behavior tests
  • Create an issue and run manual accessibility tests: [link to issue]
• Validate with partners
• Run a bug bash with other FUI crews
• Finalize documentation
  • Review and add any missing storybook stories
  • Finalize migration guide
• Component released as stable
  • Run the prepare-initial-release script to remove the -preview suffix from the package name
  • Deprecate the -preview package in NPM
  • Export the component from @fluentui/react-components
  • In package.json: Remove the alpha/beta tag from the version number in package.json
  • In package.json: Change beachball's disallowedChangeTypes to "major", "prerelease"

[gouttierre]

📢

• KeyTips supports things like v9 Menu as part of the internal partner apps. i.e. OOUI v9 migrations / the Experiences Platform team in Dynamics 365 Business Central
• We need Office Design involved because it's mostly used in the Ribbon scenario, plus we'll need design guidance on what is the recommended key to listen to, and what UX components to apply KeyTips to if there's more than just the Ribbon scenarios.

cc @JustSlone , @paulgildea , @tudorpopams, @jurokapsiar

[gouttierre]

📢

• Still in early days w/ in teams discussions.
• Viktor will be on dev support and Tuesday Clark with be the design PoC.

cc @mainframev , @tudorpopams , @jurokapsiar , @JustSlone , @paulgildea

[gouttierre]

📢

• Viktor, prepared a specification (currently in review) and draft implementation (will be available for review soon)

cc ~ @tudorpopams , @JustSlone , @paulgildea , @mainframev

[gouttierre]

📢

• The initial implementation / preview of keytips was just released, so it's available for early feedback and try out.
• This component is not part of the core, but fluent-contrib.
• Dev will continue to add support for persisted keytips and a couple of features that were requested for v8 earlier.

cc @tudorpopams , @mainframev