searchPanes.i18n.clearMessage

Since: SearchPanes SearchPanes 1.0.0

Set the message to be displayed in the Clear button.
Please note - this property requires the SearchPanes extension for DataTables.

Description

As standard, SearchPanes will set the message to be displayed in the Clear button to 'Clear All'. This property allows that message to be configured.

This option allows direct configuration on the language options for the SearchPanes instance. At this time using language.searchPanes.clearMessage has the same effect as setting this option. If both are provided, this will take preference, We've made this change for consistency in our APIs moving forward.

Type

string

Description:

Setting the searchPanes.i18n.clearMessage option to a string of your choice allows the Clear All button to have custom text within it.

This property is passed through an i18n() function.

Default

Value: undefined

The default value for the searchPanes.i18n.clearMessage parameter is "Clear All".

Example

Change message for the Clear button:

$(document).ready(function() {
    $('#example').DataTable({
        searchPanes: {
            i18n: {
                clearMessage: 'Obliterate Selections'
            }
        }
    });
});