Loading

Options

loading

Ask AI

Source code

loading.loading : boolean | object

The loading option configures the Loading plugin.

Loading plugin, automatically loads Dialog plugin.

You can set the loading option to one of the following:

Setting	Description
false	Disable the Loading plugin
true	Enable the Loading plugin with default configuration
An object	- Enable the Loading plugin - Apply custom configuration

If you set the loading option to an object, you can configure the following loading options:

Option	Possible settings	Description
icon	A string	Custom loading icon to display (default: <svg />)
title	A string	Custom loading title to display (default: 'Loading...')
description	A string	Custom loading description to display (default: '')

Read more:

This option can only be set at the grid level. It has no effect when set in the columns, cells, or cell options.

Default: false
Since: 16.1.0
Example

// enable the `Loading` plugin with default configuration
loading: true,

// enable the `Loading` plugin with custom configuration
loading: {
  icon: 'A custom loading icon in SVG format',
  title: 'Custom loading title',
  description: 'Custom loading description',
}

Members

DEFAULT_SETTINGS

Ask AI

Source code

Loading.DEFAULT_SETTINGS

Returns the default settings applied when the plugin is enabled without explicit configuration.

PLUGIN_KEY

Ask AI

Source code

Loading.PLUGIN_KEY

Returns the plugin key used to identify this plugin in Handsontable settings.

PLUGIN_PRIORITY

Ask AI

Source code

Loading.PLUGIN_PRIORITY

Returns the priority order used to determine the order in which plugins are initialized.

SETTINGS_VALIDATORS

Ask AI

Source code

Loading.SETTINGS_VALIDATORS

Returns an object of validator functions used to type-check each settings property at runtime.

Methods

destroy

Ask AI

Source code

loading.destroy()

Destroy plugin instance.

disablePlugin

Ask AI

Source code

loading.disablePlugin()

Disable plugin for this Handsontable instance.

enablePlugin

Ask AI

Source code

loading.enablePlugin()

Enable plugin for this Handsontable instance.

hide

Ask AI

Source code

loading.hide()

Hide loading dialog.

isEnabled

Ask AI

Source code

loading.isEnabled() ⇒ boolean

Check if the plugin is enabled in the handsontable settings.

isVisible

Ask AI

Source code

loading.isVisible() ⇒ boolean

Check if loading dialog is currently visible.

show

Ask AI

Source code

loading.show(options)

Show loading dialog with optional custom options.

Param	Type	Description
options	object	Custom loading options.
options.icon	string	Custom loading icon.
options.title	string	Custom loading title.
options.description	string	Custom loading description.

update

Ask AI

Source code

loading.update(options)

Update loading description without hiding/showing the dialog.

Param	Type	Description
options	object	Custom loading options.
options.icon	string	Custom loading icon.
options.title	string	Custom loading title.
options.description	string	Custom loading description.

updatePlugin

Ask AI

Source code

loading.updatePlugin()

Update plugin state after Handsontable settings update.