UI Shell: v11 audit

Audit

A designer and developer will pair on this audit, some tasks may be discipline focused. Follow the checklist below for the features and items to review. If there are no issues with the item then check the item as complete. If any problems or bugs come up when auditing add a comment to this issue with the problem and how to correct it (if you know how). Bugs do not need to be fixed while auditing.

Resources

• Design spec in Sketch
• V11 Website
• SCSS
• Storybook

Variants

• Header
• Left panel
• Right panel

Checklist

Visual (in React code) Design and dev check

• Component is using the correct design tokens (color and type), see design spec and scss code.
• Component is rendering correctly across themes and layers, see design spec and storybook.
  • White theme
  • Gray 10 theme
  • Gray 90 theme
  • Gray 100 theme
• Component is rendering correctly across browsers (check themes across browsers as well), see storybook.
  • Firefox
  • Safari
  • Chrome
• Component sizes are rendering and named correctly (if applicable)

Website (v11) Design checks

• Style tab has correct design tokens listed
• Style and usage tabs are using the correct size props names (if applicable)
• Usage tab is up-to-date for with any v11 behavioral changes (if any)
• ~Live Demo has applied v11 changes~
  • ~Themes are rendering correctly~
  • ~Size props are named correctly~
  • ~No light props included~

Design Kits (Sketch only) Design checks

• Correct design tokens (type and color) are used
• Component using the correct size prop names
• Any additional v11 behaviors have been added

Storybook Dev checks

• Confirm that prop table is populating
• Take note of missing examples/stories (if any)

React package Dev checks

• Go to https://codesandbox.io/s/github/carbon-design-system/carbon/tree/main/packages/react/examples/codesandbox and confirm that you can use the component as expected from @carbon/react

Accessibility Dev checks

• Confirm that there are no violations in Accessibility checker
• Confirm that component works as expected with VoiceOver

Migration docs Design and dev check

• Any breaking changes to this component are present in the v11 migration guide.
  • Design
  • Develop

[abbeyhrt]

Throwing this here since I just noticed it but the UISHell docs for the storybook are pretty broken. It looks like it’s trying to render all UI Shells on the docs page.

[aagonzales]

Kit

• Update “UI Shell template” (can only be done after we push the theme kits live on GA day)
• Update symbols to use theming tokens
  • White theme
  • G10 theme
  • G90 theme
  • G100 theme