Truncate Title :scissors:

Custom Element for shortening text. Extends abbr tag.

:book: Documentation

:white_check_mark: Verbose Test Coverage

Usage

Add full text to title attribute.

<abbr is="truncate-title" title="Lorem ipsum dolor amet typewriter pickled iPhone hella occupy neutra tattooed vinyl drinking vinegar ennui."></abbr>

The text will be truncated to fit the parent element. Any text that flows outside of the parent element will be removed. The default seporator is ….

<abbr is="truncate-title" title="Lorem ipsum dolor amet typewriter pickled iPhone hella occupy neutra tattooed vinyl drinking vinegar ennui.">Medium Lorem ipsum dolor amet typewriter pickled iPho …</abbr>

To truncate in the middle of the text set title-break to center. The default break is tail which will break at the end of the line.

<abbr is="truncate-title" title="Lorem ipsum dolor amet typewriter pickled iPhone hella occupy neutra tattooed vinyl drinking vinegar ennui." title-break="tail">Medium Lorem ipsum dolor a … yl drinking vinegar ennui.</abbr>

Modules

The default module is not registered using customElements.define. This allows you to extend and modify before registering as you own Custom Element.

For a registered version (compiled as ESM) use { "browser": "dist/truncate-title.registered.js" }.

Example of registration function registerCustomElement is in dist/truncate-title.registered.js.

{ "main": "dist/truncate-title.registered.js" } module will register the Custom Element using customElements.define.

For the

Custom Event

CustomEvent truncate-complete is emmited everytime a truncation event is complete.

detail contains the following <Object>:

detail: { 
  before: <string>, // title before augmentation
  after: <string>, // title after augmentation
  width: <number> // width title was truncated to be less than
}

Demo

npm run serve

Todo

• [ ] Use CSS Property to set default animation styles.