Component Variants

Variants are useful when you have one component that has multiple different possible implementations. These could be implemented as separate components but often it's easier and more semantic to create them as variants of an existing component.

Let's take a look at the Card component for example. Here are two different ways in which this component will be displayed:

Planning for component variants

Looking at the two cards above, we see that they are practically the same card component but with some differences. There are many factors that determine if a component could be used as the base for variants.

  • Does the proposed variant have the overall look and feel of the original component?

  • Are there common patterns (fields, markup, layout, etc.) that can facilitate a variant vs. a whole new component?

  • Does the component behavior and layout lend themselves to new variants without altering markup or sacrificing accessibility or user experience?

  • Can I achieve the variants with a CSS modifier class or basic twig logic?

These are questions you should ask yourself before deciding to create component variants. If not properly planned, you could paint yourself in a corner when your components have been over engineered in an effort to accommodate for variants.

Let's build the variant next

Last updated