intl

Sort string data using the Intl Javascript API

• Author: Allan Jardine

This sorting type will replace DataTables' default string sort with one that will use a locale aware collator. This is supported by IE11, Edge, Chrome, Firefox and Safari 10+. Any browser that does not support the Intl will simply fall back to UTF8 string sorting.

This method simply needs to be called prior to the DataTables' initialisation to replace the default string sort with locale aware sorting. The method optionally takes two arguments:

1. [Optional] Locale or array of locales
2. [Optional] Collator options

For the supported options please see the MDN Intl documentation.

Use

This plug-in can be obtained and used in multiple different ways.

Browser

This plug-in is available on the DataTables CDN:

The plug-in will then automatically register itself against a global DataTables instance. This file can also be used if you are using an AMD loader such as Require.js.

Note that if you are using multiple plug-ins, it can be beneficial in terms of performance to combine the plug-ins into a single file and host it on your own server, rather than making multiple requests to the DataTables CDN.

NPM

The plug-ins are all available on NPM (which can also be used with Yarn or any other Javascript package manager) as part of the datatables.net-plugins package. To use this plug-in, first install the plug-ins package:

npm install datatables.net-plugins

ES modules

Then, if you are using ES modules, import datatables.net, any other DataTables extensions you need, and the plug-in:

import DataTable from 'datatables.net';
import 'datatables.net-plugins/sorting/intl.mjs';

CommonJS

If you are using a CommonJS loader for Node (e.g. with older versions of Webpack, or non-module Node code) use the following method to require the plug-in:

var $ = require('jquery');
var DataTable = require('datatables.net');
require('datatables.net-plugins/sorting/intl.js');

Examples

// Host's current locale
  DataTable.intlOrder();

// Explicit locale
  DataTable.intlOrder('de-u-co-phonebk');

// Locale with configuration options
  DataTable.intlOrder('fr', {
    sensitivity: 'base'
  } );

Version control

If you have any ideas for how this plug-in can be improved, or spot anything that is in error, it is available on GitHub and pull requests are very welcome!

• This plug-in: intl.js
• Full DataTables plug-ins repository: DataTables/Plugins