CA.gov Design System Gutenberg Blocks

Version 2.0.0 (DEVELOPMENT)) @cagov/design-system-wordpress-gutenberg

What this plugin does

Integrates the State of California Design System into the WordPress Gutenberg editor.

The CA.gov design system defines “Content Components”. This can be structured markup with CSS and custom elements, or interactive web components.

Gutenberg is an open-source editor that is included in core WordPress, version 5.0 and later. This editor tool allows content editors to use pre-defined markup blocks in content.

This plugin includes only Content components from the CA Design System.

How to use this plugin

• Install and enable this plugin
• This will create a WordPress Block library that is available in the Gutenberg Editor UI.
• Keep the plugin up-to-date for important security and design updates.
• Check our CHANGELOG for notifications of major updates for database updates to keep content in sync with design system changes.

Content design and using Gutenberg Blocks

• Review guidance for content editors
  • Please also check the principles and content principles of the design system for more information on improving content for State of California website users.
• The Office of Digital Innovation has drafted content guidance for content editors on our systems.
  • If needed please reach out to the Design System team until we are able to publish the full version for any site using these Gutenberg Blocks.

Dependencies

• Requires WordPress 5.9 or later.
• Requires core Gutenberg feature to be enabled and not blocked.

Maintenance

• Since the Design System is in continuous development, components are continuously improved.
• All components are versioned, this means you can coordinate your update on your own schedule and test your update to make sure that everything is working well.
• Check the maintenance docs on how to perform an update.

Compatible WordPress themes

• Compatible themes that implement the CA Design System
  • CAWeb theme Version (x.x.x) @TBD
  • Design System WordPress theme (DEVELOPMENT)

Using with CAWeb theme

• We are aligning with the CAWeb State Template theme.
• This is the same codebase that will be used in the CAWeb theme.

Contributions

Thank you for contributing to the CA Design System. Your help is important and will help us deliver services to Californians while maintaining our committments to accessibility, performance and equity.

This plugin is the official and validated set of block plugins for the core California Design System.

To contribute

• Please submit a pull request to this repository and the Design System team can review it.

Custom Gutenberg blocks

We understand that you may want to extend your WordPress site with additional Gutenberg Blocks.

An example of extending a custom site will be found at: https://github.com/cagov/cannabis-ca-gov-wordpress