readme.md

Code Amp Block Components

React components for the WordPress block editor.

Inspired by the work in 10up/block-components

Install

Run npm install @codeamp/block-components

Components

• MultiSelectControl

  A multi-select control for the block editor based on FormTokenField.

• ResourceSelectControl

  A select control with actions for creating and editing resources.

Usage

Use imports to include the components in your project.

import { MultiSelectControl, ResourceSelectControl } from '@codeamp/block-components';

Requirements

This project is depends on the WordPress block editor and such it expects those packages to already be installed/aliased.

Ensure you add @wordpress/dependency-extraction-webpack-plugin to your project or manually install the WordPress packages.

If you use @wordpress/create-block to create a plugin, this is handled for you automatically.

Project status

This package is currently published as beta while we continue to setup the repository and add testing, but should be completely usable.

Contributing

All contributions are welcome, but at this early stage the priority is to setup testing and improve the documentation.

Updating the project version number

To update the project version number, run the following command:

npm version <update_type>

Where <update_type> is one of the semantic versioning release types: patch, minor, or major. This command will update the version number in package.json, create a version commit, and tag the commit.