Component Architecture

I typically recommend to group components or patterns in individual folders within your Drupal theme. This not only provides organization as your catalog of components grows, but it also makes each component completely reusable and even portable as all the pieces of a component are encapsulated in a single folder. Here's an example of a typical component architecture. Your particular workflow may vary.

|  |--patterns
|     |--components
|        |--card
|           |-- card.js
|           |--
|           |-- card.scss
|           |-- card.twig
|           |-- card.json

A component is typically broken down in four parts:

  • Markup: Markup or HTML for a component is written in Twig templates, Drupal 8's templating engine.

  • Data: Demo or stock data for components is usually provided in YAML or JSON format. These are lightweight formats for storing data. In this training we will use JSON (JavaScript Object Notation).

  • Styles: These are written in CSS or SCSS.

  • Behavior/interaction: The component's behaviors are usually handled with JavaScript. Most components don't need JavaScript.

  • Annotations (Optional): Annotations are used to document the details of a component and are typically written in markdown format (.md). This is extremely useful for teams because it outlines technical details of a pattern such as variable names, attributes, data structure, etc.

Last updated