Welcome to UI Patterns’ documentation

The UI Patterns module allows developers to define self-contained UI patterns as Drupal plugins and use them seamlessly in their panels, field groups or Display Suite view modes.


Project overview

The UI Patterns project provides 6 modules:

  • UI Patterns: the main module, it exposes the UI Patterns system APIs and it does not do much more than that.
  • UI Patterns Library: allows to define patterns via YAML and generates a pattern library page available at /patterns to be used as documentation for content editors or as a showcase for business. Use this module if you don’t plan to use more advanced component library systems such as PatternLab or Fractal. Learn more
  • UI Patterns Field Group: allows to use patterns to format field groups provided by the Field group module.
  • UI Patterns Layouts: allows to use patterns as layouts. This allows patterns to be used on Display Suite view modes or on panels out of the box.
  • UI Patterns Display Suite: allows to use patterns to format Display Suite field templates.
  • UI Patterns Views: allows to use patterns as Views row templates.

By the way plugin definitions are handled the UI Patterns module also integrates with with tools like PatternLab or modules like Component Libraries.