woocommerce/packages/js/components/src/product-fields
louwie17 b8c25b49bf
Initial product form field store (#36362)
* Add initial product fields registry store and helper functions

* Add changelog

* Change edit to render and address PR feedback

* Make use of memoize-one instead of rememo as memoize-one is already installed
2023-01-12 04:02:35 -04:00
..
api Initial product form field store (#36362) 2023-01-12 04:02:35 -04:00
store Initial product form field store (#36362) 2023-01-12 04:02:35 -04:00
stories Initial product form field store (#36362) 2023-01-12 04:02:35 -04:00
README.md Initial product form field store (#36362) 2023-01-12 04:02:35 -04:00
index.ts Initial product form field store (#36362) 2023-01-12 04:02:35 -04:00

README.md

Product Fields

Product Fields are used within the WooCommerce Admin product editor, for rendering new fields using PHP.

Example

// product-field.js
( function ( element ) {
	const el = element.createElement;

	registerProductField( 'number', {
		name: 'number',
		render: () => {
			return <InputControl type="number" />;
		},
	} );
} )( window.wp.element );

API

registerProductField

Registers a new product field provided a unique name and an object defining its behavior.

Usage

import { __ } from '@wordpress/i18n';
import { registerProductField } from '@woocommerce/components';

registerProductField( 'number', {
	name: 'number',
	render: () => {
		return <InputControl type="number" />;
	},
} );

Parameters

  • fieldName string: Field name.
  • settings Object: Field settings.
    • render ComponentType: React functional component to be rendered.