Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-admin/bin/hook-reference
History
Christopher Allford fa011a431b Removed Unnecessary `run` From `pnpm` 2023-12-09 14:36:22 -08:00
..
README.md Removed Unnecessary `run` From `pnpm` 2023-12-09 14:36:22 -08:00
data.js Add hook reference generator README and documentation (https://github.com/woocommerce/woocommerce-admin/pull/8004) 2022-02-11 10:38:38 -04:00
data.json Add hook reference generator README and documentation (https://github.com/woocommerce/woocommerce-admin/pull/8004) 2022-02-11 10:38:38 -04:00
index.js Hook reference: Add SlotFill support (https://github.com/woocommerce/woocommerce-admin/pull/6833) 2021-07-09 11:01:43 +12:00

README.md

Hook Reference Generator

Compile a publishable JSON object of WooCommerce's JavaScript filters and slotFill entry points.

Usage

Generate a new reference found at bin/hook-reference/data.json by running the following command.

pnpm create-hook-reference

The data includes references to code in the Github repository by commit hash, so it is essential to commit the resulting data in a pull request to main so code references are publicly available.

DocBlock Requirements

JavaScript documentation blocks require certain fields in order to be included in the reference.

Filter

Tag Description
@filter Filter string used as addFilter's first argument

SlotFill

Tag Description
@slotFill The fill component's name