square / maker

Maker Design System by Square

Home Page:https://square.github.io/maker/styleguide/latest-stable/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Component + Theme Doc Dev / Styleguide testing

landondurnan opened this issue · comments

Feature request

Our styleguide does a great job of defining the individual components. While we have individual theme component documentation, we can't easily see what the impact is of the theme data with each component. This has resulted in us shipping bugs where things looked fine with the individual component, but when used inside of a Theme it's caused issues.

It would be ideal to have a better sense of how a component operates both inside and outside of the theme component for testing

Why?

Improve testing during development and reduce bugs.

Alternatives

Our current alternative are labs that have more real-world feature rich examples to test multiple components with themes, but this is limited to the components in that lab.

  1. We could enable a tabbed output in doc dev to preview / test the component inside of a theme wrapper.
  2. We could modify our styleguide to have a theme wrapper so we can preview all the components within a theme. (If we do this then we'd absolutely need to have a way to test components with / without the theme wrapper in doc dev)

Extra nice: having different themes to test with particularly a light vs dark one so we can verify our contrast logic as we move more color functions into Maker.

Additional context

theme switcher inspiration? click the button in the top right: https://theme-ui.com/
Uploading CleanShot 2022-05-24 at 09.32.41.png…

This issue has been automatically closed because it hasn't received any activity in over 6 months.