云策 WordPress 开发者社区

块编辑器开发文档

@wordpress/dom-ready

查看官方原文 ↗
💡 云策文档标注

概述

@wordpress/dom-ready 是一个 WordPress 包，用于在 DOM 加载完成后执行回调函数。它适用于 ES2015+ 环境，并提供了简单的 API 来确保代码在 DOM 就绪时运行。

关键要点

  • 安装方式：通过 npm 安装 @wordpress/dom-ready 包，并确保环境支持 ES2015+ 或使用 polyfill。
  • 核心功能：提供 domReady 函数，接受一个回调函数作为参数，在 DOM 完全加载后执行。
  • 使用场景：适用于需要在 DOM 就绪后执行初始化或操作 DOM 元素的 WordPress 开发任务。
  • 浏览器支持：参考 WordPress 核心的浏览器支持文档，确保兼容性。
  • 贡献方式：作为 Gutenberg 项目的一部分，遵循其贡献指南进行开发。

代码示例

import domReady from '@wordpress/dom-ready';

domReady( function () {
    //do something after DOM loads.
} );
📄 原文内容

Execute callback after the DOM is loaded.

Installation

Install the module

npm install @wordpress/dom-ready --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.

API

default

Specify a function to execute when the DOM is fully loaded.

Usage

import domReady from '@wordpress/dom-ready';

domReady( function () {
    //do something after DOM loads.
} );

Parameters

  • callback VoidFunction: A function to execute after the DOM is ready.

Browser support

See https://make.wordpress.org/core/handbook/best-practices/browser-support/

Contributing to this package

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.