783f613815
add data store for settings using wp.data add use-select-with-refresh example replace fresh-data usage with new settings data store for settings page Add data package move to packages Fix isDirty after save Add isBusy to primary button when saving update Readme remove comment readme to use useSelect Revert "update Readme" This reverts commit 7402fd49b8f384fde5878e0bee0616f0a87bb4f6. Data Layer: Settings page to use Settings store (https://github.com/woocommerce/woocommerce-admin/pull/3430) * Data Layer: Settings store as source of truth for settings page This reverts commit 7402fd49b8f384fde5878e0bee0616f0a87bb4f6. * fixup * save on reset * non mutable constants * add set/getSettings * save using setSettings * separate HOC * cleanup * remove settingsToData * withHydration * remove withSettings HOC * renmove useSettins for now * withSettingsHydration updates * Revert "withSettingsHydration updates" This reverts commit f2adf108fbe19b574978fea5925a1a18e7ed3007. * rename withSettingsHydration * redo withSettingsHydration simplification * restore * useSettings * render using useSettings * handleInputChange working * get setIsDirty working * saving works * reset and cleanup * cleanup * use snake case on hook files * use clearIsDirty * Avoid mutation on setting update * remove @todo * persiting -> isPersisting * better reducer ternaries * add wcSettings as arg to withSettingsHydration reset package-lock Settings: split out mutable wcAdminSettings (https://github.com/woocommerce/woocommerce-admin/pull/3675) Settings: handle async settings groups (https://github.com/woocommerce/woocommerce-admin/pull/3707) |
||
---|---|---|
.. | ||
components | ||
dashboard-charts | ||
leaderboards | ||
profile-wizard | ||
store-performance | ||
task-list | ||
README.md | ||
customizable.js | ||
default-sections.js | ||
index.js | ||
section-controls.js | ||
section.js | ||
style.scss | ||
utils.js |
README.md
Dashboard
This folder contains the components used in the Dashboard page.
Extending the Dashboard
New Dashboard sections can be added by hooking into the filter woocommerce_dashboard_default_sections
. For example:
addFilter( 'woocommerce_dashboard_default_sections', sections => {
return [
...sections,
{
key: 'example',
component: ExampleSection,
title: 'My Example Dashboard Section',
isVisible: true,
icon: 'arrow-right-alt',
hiddenBlocks: [],
},
];
} );
Each section is defined by an object containing the following properties.
key
(string): The key used internally to identify the section.title
(string): The title shown in the Dashboard. It can be modified by users.icon
(string|function|WPComponent|null): Icon to be used to identify the section.component
(react component): The component containing the section content.isVisible
(boolean): Whether the section is visible by default. Sections can be added/hidden by users.hiddenBlocks
(array of strings): The keys of the blocks that must be hidden by default. Used in Sections that contain several blocks that can be shown or hidden. It can be modified by users.
The component will get the following props:
hiddenBlocks
(array of strings): Hidden blocks according to the default settings or the user preferences if they had made any modification.isFirst
(boolean): Whether the component is the first one shown in the Dashboard.isLast
(boolean): Whether the component is the last one shown in the Dashboard.onMove
(boolean): Event to trigger when moving the section.onRemove
(boolean): Event to trigger when removing the section.onTitleBlur
(function): Event to trigger when the edit title input box is unfocused.onTitleChange
(function): Event to trigger when the edit title input box receives a change event.onToggleHiddenBlock
(function): Event to trigger when the user toggles one of the hidden blocks preferences.titleInput
(string): Current string to be displayed in the edit title input box. Title is only updated on blur, so this value will be different thantitle
when the user is modifying the input box.path
(string): The exact path for this view.query
(object): The query string for the current view, can be used to read current preferences for time periods or chart interval/type.title
(string): Title of the section according to the default settings or the user preferences if they had made any modification.controls
(react component): Controls to move a section up/down or remove it from view to be rendered inside the EllipsisMenu.