77 lines
6.0 KiB
Markdown
77 lines
6.0 KiB
Markdown
# Extensibility in WooCommerce Blocks <!-- omit in toc -->
|
|
|
|
## Table of Contents <!-- omit in toc -->
|
|
|
|
- [Imports and dependency extration](#imports-and-dependency-extration)
|
|
- [Hooks (actions and filters)](#hooks-actions-and-filters)
|
|
- [REST API](#rest-api)
|
|
- [Checkout Payment Methods](#checkout-payment-methods)
|
|
- [Checkout Block](#checkout-block)
|
|
|
|
These documents are all dealing with extensibility in the various WooCommerce Blocks.
|
|
|
|
## Imports and dependency extration
|
|
|
|
The documentation in this section will use window globals in code examples, for example:
|
|
|
|
```js
|
|
const { registerCheckoutFilters } = window.wc.blocksCheckout;
|
|
```
|
|
|
|
However, if you're using `@woocommerce/dependency-extraction-webpack-plugin` for enhanced dependency management you can instead use ES module syntax:
|
|
|
|
```js
|
|
import { registerCheckoutFilters } from '@woocommerce/blocks-checkout';
|
|
```
|
|
|
|
See <https://www.npmjs.com/package/@woocommerce/dependency-extraction-webpack-plugin> for more information.
|
|
|
|
## Hooks (actions and filters)
|
|
|
|
| Document | Description |
|
|
| ----------------------------- | ------------------------------------------------------- |
|
|
| [Actions](./hooks/actions.md) | Documentation covering action hooks on the server side. |
|
|
| [Filters](./hooks/filters.md) | Documentation covering filter hooks on the server side. |
|
|
| [Migrated Hooks](./hooks/migrated-hooks.md) | Documentation covering the migrated WooCommerce core hooks. |
|
|
|
|
## REST API
|
|
|
|
| Document | Description |
|
|
| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
|
| [Exposing your data in the Store API.](./rest-api/extend-rest-api-add-data.md) | Explains how you can add additional data to Store API endpoints. |
|
|
| [Available endpoints to extend with ExtendSchema](./rest-api/available-endpoints-to-extend.md) | A list of all available endpoints to extend. |
|
|
| [Available Formatters](./rest-api/extend-rest-api-formatters.md) | Available `Formatters` to format data for use in the Store API. |
|
|
| [Updating the cart with the Store API](./rest-api/extend-rest-api-update-cart.md) | Update the server-side cart following an action from the front-end. |
|
|
|
|
## Checkout Payment Methods
|
|
|
|
| Document | Description |
|
|
| -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
|
| [Checkout Flow and Events](./checkout-payment-methods/checkout-flow-and-events.md) | All about the checkout flow in the checkout block and the various emitted events that can be subscribed to. |
|
|
| [Payment Method Integration](./checkout-payment-methods/payment-method-integration.md) | Information about implementing payment methods. |
|
|
| [Filtering Payment Methods](./checkout-payment-methods/filtering-payment-methods.md) | Information about filtering the payment methods available in the Checkout Block. |
|
|
|
|
## Checkout Block
|
|
|
|
In addition to the reference material below, [please see the `block-checkout` package documentation](../../../packages/checkout/README.md) which is used to extend checkout with Filters, Slot Fills, and Inner Blocks.
|
|
|
|
| Document | Description |
|
|
| ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
|
|
| [How the Checkout Block processes an order](./checkout-block/how-checkout-processes-an-order.md) | The detailed inner workings of the Checkout Flow. |
|
|
| [IntegrationInterface](./checkout-block/integration-interface.md) | The `IntegrationInterface` class and how to use it to register scripts, styles, and data with WooCommerce Blocks. |
|
|
| [Available Filters](./checkout-block/available-filters.md) | All about the filters that you may use to change values of certain elements of WooCommerce Blocks. |
|
|
| [Slots and Fills](./checkout-block/slot-fills.md) | Explains Slot Fills and how to use them to render your own components in Cart and Checkout. |
|
|
| [Available Slot Fills](./checkout-block/available-slot-fills.md) | Available Slots that you can use and their positions in Cart and Checkout. |
|
|
| [DOM Events](./checkout-block/dom-events.md) | A list of DOM Events used by some blocks to communicate between them and with other parts of WooCommerce. |
|
|
| [Filter Registry](../../../packages/checkout/filter-registry/README.md) | The filter registry allows callbacks to be registered to manipulate certain values. |
|
|
|
|
<!-- FEEDBACK -->
|
|
|
|
---
|
|
|
|
[We're hiring!](https://woo.com/careers/) Come work with us!
|
|
|
|
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/README.md)
|
|
|
|
<!-- /FEEDBACK -->
|