d8098d6fd7
* Add @woocommerce/tracks package.json * Add @woocommerce/tracks .npmrc * Move lib/tracks.js in to tracks package * Add tracks package debug dependency * Add readme for tracks package * Add changelog for tracks package * Add info about debugging and opt-ins to tracks package readme * Load tracks package script * Add tracks package to packages readme * Add tracks package to webpack config * Add tracks package external to starter-pack * Replace lib/tracks uses with @woocommerce/tracks * Update package-lock.json |
||
|---|---|---|
| .. | ||
| historical-data | ||
| README.md | ||
| config.js | ||
| default-date.js | ||
| index.js | ||
| index.scss | ||
| setting.js | ||
| setting.scss | ||
README.md
Settings
The settings used to modify the way data is retreived or displayed in WooCommerce reports.
Extending Settings
Settings can be added, removed, or modified outside oc wc-admin by hooking into woocommerce_admin_analytics_settings. For example:
addFilter( 'woocommerce_admin_analytics_settings', 'wc-example/my-setting', settings => {
return [
...settings,
{
name: 'custom_setting',
label: __( 'Custom setting:', 'woocommerce-admin' ),
inputType: 'text',
helpText: __( 'Help text to describe what the setting does.' ),
defaultValue: 'Default value',
},
];
} );
Each settings has the following properties:
name(string): The slug of the setting to be updated.label(string): The label used to describe and displayed next to the setting.inputType(enum: text|checkbox|checkboxGroup): The type of input to use.helpText(string): Text displayed beneath the setting.options(array): Array of options used for inputs with selectable options.defaultValue(string|array): Value used when resetting to default settings.