dc5304823b
* add new woocommerce/eslint-plugin * implement eslint-plugin (switch scripts to use wp-scripts etc) * various linting fixes * more lint fixes * improve fix script * more eslint fixes * more eslint fixes * temporary convert rules to warnings until they are all handled * linting fixes * update package-lock.json * remove duplicates * remove unnecessary `@wordpress/dependency-group` rule config * add docs and adjust rules * prettier fix * fix merge artifact * convert more rules to warnings * change order to reflect importance * install babel-preset-default * remove unnecessary configuration for babel * fix dependency group rule and test * fix test * handle collapsible whitespace * add react testing library eslint plugin * linter errors * Add back in prettierrc * package-lock update * js lint fix with --fix * disable whitespace in translation * package-lock update * make eslint actual dependency, not peer dependency * pin eslint to v7 * I don't know why, but its working * fix lint js Co-authored-by: Paul Sealock <psealock@gmail.com> |
||
|---|---|---|
| .. | ||
| 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.