Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

Other versions
Version 19.0Version 18.0 (current version)Version 17.0

On this page

You are viewing an incomplete pre-release version of this documentation. Click here to open the current version, 18.0.

WordBreakerSpec interface

Home > @keymanapp/kmc-model > WordBreakerSpec

WordBreakerSpec interface

Keyman 14.0+ word breaker specification:

Can support all old word breaking specification, but can also be extended with options.

Signature:

export interface WordBreakerSpec 

Properties

Property Modifiers Type Description
[joinWordsAt?](./kmc-model.wordbreakerspec.joinwordsat.md) `readonly` string\[\] _(Optional)_ If present, joins words that were split by the word breaker together at the given strings. e.g., joinWordsAt: \['-'\] // to keep hyphenated items together
[overrideScriptDefaults?](./kmc-model.wordbreakerspec.overridescriptdefaults.md) `readonly` OverrideScriptDefaults _(Optional)_ Overrides word splitting behaviour for certain scripts. For example, specifing that spaces break words in certain South-East Asian scripts that otherwise do not use spaces.
[use](./kmc-model.wordbreakerspec.use.md) `readonly` [SimpleWordBreakerSpec](./kmc-model.simplewordbreakerspec.md)