Workday / canvas-kit

Development kits to implement UI following the Workday Canvas Design System (https://canvas.workday.com/). See our Component Storybook -
https://workday.github.io/canvas-kit/
Apache License 2.0
302 stars 221 forks source link

docs: Refreshing preview SidePanel storybook examples #3056

Open williamjstanton opened 1 week ago

williamjstanton commented 1 week ago

Summary

I recently reviewed the accessibility of a bespoke team's work, using the Canvas SidePanel component for their navigation.

Release Category

Documentation > Storybook examples

Release Note

Optional release note message. Changelog and release summaries will contain a pull request title. This section will add additional notes under that title. This section is not a summary, but something extra to point out in release notes. An example might be calling out breaking changes in a labs component or minor visual changes that need visual regression updates. Remove this section if no additional release notes are required.

Checklist

For the Reviewer

Where Should the Reviewer Start?

Start here: modules/react/_examples/stories/mdx/examples/SidePanelWithNavigation.tsx Updated docs: modules/react/_examples/stories/mdx/SidePanel.mdx modules/react/_examples/stories/mdx/examples/SidePanelWithOverlay.tsx

Important change to external controlProps: modules/preview-react/side-panel/stories/examples/ExternalControl.tsx Notes about accessibility: modules/preview-react/side-panel/stories/SidePanel.mdx

modules/preview-react/side-panel/stories/examples/Basic.tsx And all other examples in this folder.

Areas for Feedback? (optional)

I'd like some feedback about CSS styling and my use of the new tokens system.

Testing Manually

Screenshots or GIFs (if applicable)

Thank You Gif (optional)

cypress[bot] commented 1 week ago

Workday/canvas-kit    Run #8061

Run Properties:  status check passed Passed #8061  •  git commit d8ce2bd004 ℹ️: Merge edf126db25f90696e7ac0d3d7beb11da5e25ac41 into 9a6f57a9daed9618b7de81ff67ec...
Project Workday/canvas-kit
Branch Review william-sidepanel-nav-example
Run status status check passed Passed #8061
Run duration 03m 55s
Commit git commit d8ce2bd004 ℹ️: Merge edf126db25f90696e7ac0d3d7beb11da5e25ac41 into 9a6f57a9daed9618b7de81ff67ec...
Committer William Stanton
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 31
Tests that did not run due to a developer annotating a test with .skip  Pending 24
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 1093
View all changes introduced in this branch ↗︎
UI Coverage  21.95%
  Untested elements 1623  
  Tested elements 454  
Accessibility  99.17%
  Failed rules  5 critical   5 serious   0 moderate   2 minor
  Failed elements 178