StencilJS Solves Our Design System Problem

 

Christopher Bloom

The Problem

Design systems we build can only be used in Drupal.

Why?

Twig for components

(Tech debt)

Ideal

  1. Components usable in Drupal

  2. Components usable in React/etc

  3. TypeScript

  4. Less bespoke/simpler

  5. Design system versioning/publishing

  6. Storybook

  7. Tailwind

StencilJS

<p2-cta-image pixel subtitle="Digital experience that advances the human experience.">
  <img src="image.jpg" alt="Demo image"/>
</p2-cta-image>
  1. Components usable in Drupal

  2. Components usable in React/etc

Web components are the web standard way to define custom elements that contain their own markup, styles, and behavior.

 

They work perfectly in Drupal and JS frameworks.

StencilJS

import { Component, Prop, h } from '@stencil/core';

@Component({
  tag: 'my-embedded-component'
})
export class MyEmbeddedComponent {
  @Prop() color: string = 'blue';

  render() {
    return (
      <div>My favorite color is {this.color}</div>
    );
  }
}

3. TypeScript

TypeScript is baked into all Stencil tooling.

StencilJS

4. Less bespoke/simpler

5. Versioning/publishing

A design repository of components makes for simpler tooling AND easy publishing on the package systems of GitHub/GitLab/NPM.

Repo

Package

StencilJS

6. StoryBook

Solved with a bit of integration:

https://github.com/dutscher/stencil-storybook

StencilJS

7. Tailwind

@apply works in Stencil CSS. It's not true utility classes, but it's at least token-based styling.

:host {
  @apply block w-3 h-3;

  &([color="p2-blue"]) {
    @apply bg-p2-blue;
  }
  &([color="karma-coral"]) {
    @apply bg-karma-coral;
  }
  &([color="soft-black"]) {
    @apply bg-soft-black;
  }
  &([color="not-gray"]) {
    @apply bg-not-gray;
  }
  &([color="dusty-blue"]) {
    @apply bg-dusty-blue;
  }
  &([color="misty-teal"]) {
    @apply bg-misty-teal;
  }
  &([color="electric-violet"]) {
    @apply bg-electric-violet;
  }
  &([color="dark-gray"]) {
    @apply bg-dark-gray;
  }
  &([color="white"]) {
    @apply bg-white;
  }
  &([color="black"]) {
    @apply bg-black;
  }
}

StencilJS

By Christopher Bloom

StencilJS

  • 1,437