Pop-over: v11 audit

[aagonzales]

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

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) NA

Website (v11)
Design checks

• Style tab has correct design tokens listed
• Style and usage tabs are using the correct size props names (if applicable) NA
• 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

[laurenmrice]

Visual bugs

scss

• The heading text should be $heading-compact-01.
• Question for dev: Currently the body text should be $body-compact-01. When a popover has one line of text can you specify the token as $body-compact-01 and then change it to $body-01 when it wraps to two lines? Or does it always have to be one token for both scenarios? I made a note of this in the Toggletip and Tooltip component audits so we can align them.
• This should be background-layer = $layer-01.Should this still be called light if we are getting rid of the light aspect in v11?

.#{$prefix}--popover--light .#{$prefix}--popover-contents {
background-color: $background;
}

• Fix alignment of caret, container and trigger button fix(Popover): adjust popover content placement #10539 (comment)

Storybook

• The Popover story needs to come out of Experimental and into Stable before the v11 release.
• Activating the light prop only changes the popovers background color. It should also change the caret tip color as well. Should this still be called light if we are getting rid of the light aspect in v11?

[laurenmrice]

Website

Live demo

• We need a Live demo built for Popover. [popover] create live demo for the popover component carbon-website#2487

Code tab

• We need to add a code tab. [popover] code tab documentation carbon-website#2474

A11y tab

• We need to add an a11y tab. [popover] accessibility tab documentation carbon-website#2475

[tay1orjones]

Closing since we've got the remaining items covered via #2487, #2474, #2475.