Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

diacritics-neutralise plugin enabled only for string columns. What about html ones? #569

Open
ra00l opened this issue Aug 11, 2023 · 8 comments

Comments

@ra00l
Copy link

ra00l commented Aug 11, 2023

First of all, I am discovering the benefits of dataTables and you guys did an amazing job.
I recently needed the search to ignore diacritics, so I found the diacritics-neutralize plugin. At first sight, it didn't work.
After diving into the code, I realised it's only enabled for string columns. But the column I wanted to filter were html ones.
So I fixed this by adding the snippet below, at the end of the diacritics-neutralise.js file:

jQuery.fn.DataTable.ext.type.search.html = function (s) {
    return removeDiacritics(s)
};

It seems to be working fine with HTML columns now. Maybe you can provide an option to search there are well? Not really familiar with the plugin framework to be able to post a PR, hence opened an issue for your consideration.

@AllanJard
Copy link
Contributor

Thanks! Yes, I'll look into this. Having some form of diacritic support built into DataTables is something I want to add, so I'll look into this when I do that. Can't be certain when that will be though...

@toxpal
Copy link

toxpal commented Mar 8, 2024

The same applies for sorting plugin - if diacritics sort plugin is used, it only works fro string columns. If column contains any HTML data, diacritics sorting doesn't work.

@AllanJard
Copy link
Contributor

DataTables 2 effectively has this ability built in. This plug-in is no longer useful. If you are having problems with that ability, please link to a test case showing the issue.

@toxpal
Copy link

toxpal commented Mar 9, 2024

Yes, DT 2.0 has diacritics filtering built-in, and it works perfectly! Unfortunately, that doesn't apply to sorting, so I still have to use this plugin - https://datatables.net/plug-ins/sorting/diacritics-sort. Unfortunately, plugin doesn't work if column contains HTML data.

Here's an example using DT2 - https://live.datatables.net/dayodoli/1/edit

See "Name" column, which contains names with diacritics. In default state, names are sorted alphabetically. However, when names get sorted alphabetically by DT, sorting is wrong because DT orders names without diacritics first, and moves names with diacritics to the bottom.

If I add sorting plugin, it works as long as column with names doesn't have any HTML tags. Once HTML is added to some rows, ordering doesn't work again.

@AllanJard
Copy link
Contributor

AllanJard commented Mar 10, 2024

Thank you for the test case! The fix is fairly straight forward - we need to tell DataTables to use localeCompare rather than straight character number sorting. That can be done with the new DataTable.type() method:

DataTable.type('string', 'order', {
  asc: function (a, b) {
    return a.localeCompare(b);
  },
  desc: function (a, b) {
    return b.localeCompare(a);
  }
});

Example here: https://live.datatables.net/dayodoli/3/edit .

You'd need to do similar for html data type as well if you needed that.

Should DataTables do that by default? Very possibly. I didn't include it a while back because of the impact on performance. That might have changed with updates to the Javascript engines. I'll look into it again.

edited Fix from below.

@toxpal
Copy link

toxpal commented Mar 12, 2024

Thanks for the example. I just want to let you know that code for desc contains a small typo and should be return b.localeCompare(a); (otherwise sorting descending will change nothing and items will be sorted ascending)

@AllanJard
Copy link
Contributor

Doh - good point! I've updated my post in case anyone else gets caught by that.

@toxpal
Copy link

toxpal commented Mar 13, 2024

By the way, I'm not sure if you are aware that adding data-order tag prevents diacritics filter from working. See example here - https://live.datatables.net/dayodoli/4/edit - I just added data-order attribute to names, and diacritics filter doesn't work. In fact, even if you enter whole name correctly (with or without diacritics) into search field, DT2 can't find it.

I use a workaround now: add some random string to data-order attribute. For example, if I change data-order="1" to data-order="random-1", filtering starts working again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants