search

square / maker

Maker Design System by Square
https://square.github.io/maker/styleguide/latest-stable/
Other
63 stars 14 forks source link

feat: mvp MBread and MToastLayer components #410

Closed pretzelhammer closed 2 years ago

pretzelhammer commented 2 years ago

this pr is the 2nd pr of a 4-part pr series:

  1. mvp transition stack
  2. mvp bread & toastlayer (THIS PR)
  3. mvp toast
  4. toasts lab

what is MTransitionStack?

it's a low-level transition component which renders children in a vertical stack, and animates children as the dynamically enter or leave the stack, it's a necessary precursor to toastlayer. mtransitionstack docs. most users will never touch mtransitionstack, they will only interact with it through mtoastlayer.

what is MToastLayer? (THIS PR)

it's a high-level opinionated component similar to the other layer components like MModalLayer, MBladeLayer, MDialogLayer, etc. you mount it somewhere in the root of an app and then opened toasts are rendered in this layer. this is how most users will setup toast support in their apps. mtoastlayer docs

what is MBread? (THIS PR)

it's a low-level unopinionated container for wrapping toast content, precursor to the eventual opinionated MToast and useful for building custom toasts. most users will probably not touch this, and will only interact with it through mtoast. mbread docs

what is MToast?

it's a high-level opinionated component for rendering toasts. most users will use this for most of their use-cases. mtoast docs.

what is the Toasts Lab for?

it's an interactive toasts playground that engs, designers, and product people can mess around with to decide on how toasts should look and function by default within Maker.

github-actions[bot] commented 2 years ago

Deployed Styleguide and Lab.

Notes
  1. Links may take a few minutes to update after PR is opened or commit is pushed.
  2. Links may become invalidated after PR is merged or closed.
  3. Links for all releases and open PRs can be found on the Maker Deploys 🚀 page.

pretzelhammer commented 2 years ago

closing in favor of final cumulative pr: https://github.com/square/maker/pull/433