ni / nimble

The NI Nimble Design System
https://nimble.ni.dev
MIT License
32 stars 8 forks source link

Improve Storybook API docs for menu component #2076

Closed jattasNI closed 5 months ago

jattasNI commented 5 months ago

Pull Request

๐Ÿคจ Rationale

Continuing the work done in #2027 in service of #824. This PR covers the menu component.

Example of why this is needed: after documenting the nimble-menu-item change event I searched for usages in SLE and found dozens of instances where apps were using the keyboard inaccessible click event instead. I'm fixing them in this PR.

๐Ÿ‘ฉโ€๐Ÿ’ป Implementation

  1. Refactored menu MDX and story files to follow patterns from previous PRs. I made some judgement calls about where to document child components vs examples; open to feedback on how it turned out!
  2. Added more shared documentation strings and used them in several existing stories.

๐Ÿงช Testing

Manual storybook inspection

โœ… Checklist