What do "variants" do? - Githubissues

nuvoleweb / ui_patterns

[NOTE] Development has moved to https://drupal.org/project/ui_patterns

https://drupal.org/project/ui_patterns

GNU General Public License v2.0

85 stars 56 forks source link

What do "variants" do? #255

Closed jigarius closed 5 years ago

jigarius commented 5 years ago

I've been using UI Patterns for 3 projects now and I was wondering what "variants" actually do?

My understanding

They provide a way to override twig files.
One cannot specify a twig file for a pattern, but one can create a twig file with a specific naming-convention to make UI Patterns discover it and use it.

My expectation

Variants provide a way to override the fields with with the pattern is rendered.

Example

Say, I have a pattern named button with two variants - without_icon and with_icon.
Under with_icon, I want to include 1 extra field named icon_class.
On the patterns library page, I should see 2 button previews: Button without_icon should not have any icon Button with_icon should have an icon

It will be great if you could document what the variants do and how to use them. I couldn't find proper documentation on them anywhere.

jigarius commented 5 years ago

I think I've figured out what they do. I've shared my findings on https://jigarius.com/blog/drupal-ui-patterns. From what I understand, they provide:

An extra variable named variant in the TWIG template to allow the user to modify it accordingly.
A template suggestion which lets the developer write a separate template for each variant.