New Option: `clipByLength` about highlight-words

[tricinel]

Alright, cool, got it. Will investigate 👍 Thanks!

[tricinel]

Hey @karlhorky,

To make this clear, let's use an example.

const text = 'My dog is a very good boy and is always eating his lunch.';
const chunks = highlightWords({
  text,
  query: 'is',
  clipBy: 3
});

By default, you'd get chunks like:

[
  {
    "text": "... My dog ",
    "match": false
  },
  {
    "text": "is",
    "match": true
  },
  {
    "text": " a very ... boy and ",
    "match": false
  },
  {
    "text": "is",
    "match": true
  },
  {
    "text": " always eating h",
    "match": false
  },
  {
    "text": "is",
    "match": true
  },
  {
    "text": " lunch",
    "match": false
  }
]

And this will clip whole words. If you introduce a new option to clip by characters, then you'll get something like:

[
  {
    "text": "... My ",
    "match": false
  },
  {
    "text": "is",
    "match": true
  },
  {
    "text": " a ve ...",
    "match": false
  },
  {
    "text": "is",
    "match": true
  },
  {
    "text": "... g h",
    "match": false
  },
  {
    "text": "is",
    "match": true
  },
  {
    "text": " lu ...",
    "match": false
  }
]

Just want to be sure I got this right and I will investigate the implications.

[karlhorky]

Ah, not quite - it would count the 3 characters from the edge closest to the match, just like your algorithm counts the number of words from the matching edge.

I've added an example to the original description above, with 7 characters instead of 3.

[karlhorky]

@tricinel any news on this?

[tricinel]

Nothing, no. I doubt this will make it in to be honest, as I see less use cases for having cut-up characters rather than words. Also from an accessibility stand point, I can imagine a screen reader just reciting letters and it pains me 😢