Skip to content

System Configuration

There are a number of system configuration options related to the admin dashboard module. These options can be found by logging into the admin and navigating to Stores -> Settings -> Configuration -> Hyvä Themes -> Admin Dashboard. Each option is documented below.

Generic Configuration

Enable Dashboard Widgets

  • Config Path: hyva_admin_dashboard/general/enable
  • Default Value: Yes

This configuration option toggles the dashboard widget functionality on or off. Setting this option to No will remove the Hyvä Commerce dashboard content and prevent admin users from viewing, creating, editing, or deleting widgets.

Keep Default Dashboard Content

  • Config Path: hyva_admin_dashboard/general/keep_default
  • Default Value: No

This configuration option toggles the default Magento dashboard content on or off. Setting this option to No will remove the default dashboard blocks, buttons, and store switcher.

Default Dashboard Position

  • Config Path: hyva_admin_dashboard/general/dashboard_position
  • Default Value: After

This configuration option controls whether the Hyvä Commerce dashboard content is displayed before or after the default Magento dashboard content. This configuration option only takes effect when both sets of dashboard content are enabled i.e. when both hyva_admin_dashboard/general/enable and hyva_admin_dashboard/general/keep_default are set to Yes.

Toasts

Duration

  • Config Path: hyva_admin_dashboard/toasts/duration
  • Default Value: 3000

This configuration option determines the number of milliseconds dashboard-related messages are displayed before being dismissed.

Charts

Theme

  • Config Path: hyva_admin_dashboard/charts/theme
  • Default Value: Light

This configuration option controls whether the chart widgets use the light or the dark theme.

Fill Style

  • Config Path: hyva_admin_dashboard/charts/fill_type
  • Default Value: Solid Colours

This configuration option controls whether the chart widgets use solid colours or a pattern for visual styling.

Enable Monochrome Colours

  • Config Path: hyva_admin_dashboard/charts/monochrome
  • Default Value: No

This configuration option controls whether the chart widgets use separate colours or shades of a single colour.

Monochrome Colour

  • Config Path: hyva_admin_dashboard/charts/monochrome_color
  • Default Value: #003A7D

This configuration option defines the hex colour to use for chart widgets when monochrome colours are enabled.

Chart Colours

  • Config Path: hyva_admin_dashboard/charts/colors
  • Default Value: #003A7D,#C701FF,#5940FF,#4ECBBD,#F9E858,#D83034,#FF9D3A,#008DFF,#FF73B6

This configuration option defines the hex colours to use for chart widgets when monochrome colours are disabled.

Google CrUX History Widget Configuration

Google CrUX History Widget Availability

This set of system configuration is only available when the Hyva_AdminDashboardGoogleCruxHistoryWidget module is installed and enabled.

API Key

  • Config Path: hyva_admin_dashboard/google_crux_history/api_key
  • Default Value: N/A

This configuration option houses the API key for the Google CrUX history API.

Developer

Batch Loading Widget Content

Enable Batch Loading

  • Config Path: hyva_admin_dashboard/developer/batching/enable
  • Default Value: Yes

This configuration option toggles the batching feature on or off. When enabled, widget instance content will be populated in batches, reducing the number of requests being made to the server.

Maximum Batch Size

  • Config Path: hyva_admin_dashboard/developer/batching/max_batch_size
  • Default Value: 4

This configuration option defines the maximum number of widget instances to request content for per request.

Info

Increasing this number too much will prolong the time it takes for the request to complete, resulting in admin users having to wait longer before their content is rendered.

Debounce

  • Config Path: hyva_admin_dashboard/developer/batching/debounce_ms
  • Default Value: 250

This configuration option defines the number of milliseconds to wait before sending the request for widget instance content to the server.

Developer Note

Widget instance content is loaded when it enters the viewport. The request for content is sent either when the maximum batch size or the debounce limit is reached. Scrolling more widget instances into view causes them to either join the existing batch and reset the debounce timer or create a new batch and release the previous batch request.

The Alpine component associated with widget instances is deferred using x-defer="intersect". More information about x-defer can be found here.

Max. Wait Time

  • Config Path: hyva_admin_dashboard/developer/batching/max_wait_ms
  • Default Value: 600

This configuration option defines the maximum number of milliseconds a batch content request will wait before being released to the server.

Max. Concurrent Requests

  • Config Path: hyva_admin_dashboard/developer/batching/max_concurrent_requests
  • Default Value: 3

This configuration option defines the maximum number of permitted "in-flight" batch content requests. Batches will continue to be created beyond this number but they will form a queue of requests which will be released as others complete.