Security News
JavaScript Leaders Demand Oracle Release the JavaScript Trademark
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
@wordpress/block-library
Advanced tools
Block library for the WordPress editor.
Install the module
npm install @wordpress/block-library --save
This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default
in your code.
Function to register core blocks provided by the block editor.
Usage
import { registerCoreBlocks } from '@wordpress/block-library';
registerCoreBlocks();
Parameters
Array
: An optional array of the core blocks being registered.When you only care about registering the block when file gets imported:
import '@wordpress/block-library/build-module/verse/init';
When you want to use the reference to the block after it gets automatically registered:
import verseBlock from '@wordpress/block-library/build-module/verse/init';
When you need a full control over when the block gets registered:
import { init } from '@wordpress/block-library/build-module/verse';
const verseBlock = init();
This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.
To find out more about contributing to this package or Gutenberg as a whole, please read the project's main contributor guide.
⚠️ Adding new blocks to this package requires additional steps!
Do not forget to register a new core block in the index.js
file of this package. For example, if you were to add the new core block called core/blinking-paragraph
, you would have to add something like:
// packages/block-library/src/index.js
import * as blinkingParagraph from './blinking-paragraph';
Then add blinkingParagraph
to the list in the getAllBlocks()
function.
If it's experimental, add the following property to block.json
:
{
"__experimental": "true"
}
Register the block in the gutenberg_reregister_core_block_types()
function of the lib/blocks.php
file. Add it to the block_folders
array if it's a static block or to the block_names
array if it's a dynamic block.
Add init.js
file to the directory of the new block:
/**
* Internal dependencies
*/
import { init } from './';
export default init();
This file is used when using the option to register individual block from the @wordpress/block-library
package.
If a view.js
file (or a file prefixed with view
, e.g. view-example.js
) is present in the block's directory, this file will be built along other assets, making it available to load from the browser. You only need to reference a view.min.js
(notice the different file extension) file in the block.json
file as follows:
{
"viewScript": "file:./view.min.js"
}
This file will get automatically loaded when the static block is present on the front end. For dynamic block, you need to manually enqueue the view script in render_callback
of the block, example:
function render_block_core_blinking_paragraph( $attributes, $content ) {
$should_load_view_script = ! empty( $attributes['isInteractive'] ) && ! wp_script_is( 'wp-block-blinking-paragraph-view' );
if ( $should_load_view_script ) {
wp_enqueue_script( 'wp-block-blinking-paragraph-view' );
}
return $content;
}
FAQs
Block library for the WordPress editor.
The npm package @wordpress/block-library receives a total of 17,765 weekly downloads. As such, @wordpress/block-library popularity was classified as popular.
We found that @wordpress/block-library demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.