Define and expose self-contained UI patterns as Drupal plugins and use them seamlessly as drop-in templates for panels, field groups, views, Display Suite field templates, paragraphs, nodes or any other entity types.

The module generates a pattern library page to be used as documentation for content editors or as a showcase for business and clients.

The UI Patterns module also integrates with with tools like PatternLab or modules like Component Libraries thanks to definition overrides.

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. Learn more
  • 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. Learn more
  • UI Patterns Field Group: allows to use patterns to format field groups
    provided by the Field group module. Learn more
  • UI Patterns Display Suite: allows to use patterns to format Display Suite field templates. Learn more
  • UI Patterns Views: allows to use patterns as Views row templates. Learn more

Try it out!

Download and install the Bootstrap Patterns theme on a vanilla Drupal 8 installation to quickly try out the UI Patterns module.


Due to changes in core:

  • For Drupal 8.2 or lower: Use UI Patterns 1.0-beta6.
  • For Drupal 8.3 or higher: Use UI Patterns 1.0-beta7 or higher. See issue.


Issues and support requests

Please file issues and/or support requests using this GitHub repository.

Supporting organizations: 

Project information