ember-line-clamp

This Ember addon provides a component for truncating/clamping text.

• Note: This component currently does not support block form.

Installation

• npm install ember-line-clamp

Demo

Demo application here

Usage

To get started, place the component in one of your templates and provide a string to the `@text` attribute. The component supports other attributes, for more details you can always look at the source code.

text

The text attribute is not required but would be nice to truncate something.

Default:

lines

This attribute allows you to set the number of lines to clamp the text.

Default: 3

stripText

This attribute allows user to prevent stripping text of <br> tags when clamping.

Default: true

ellipsis

The characters/string to be used as the overflow element.

Default: ...

interactive

Line clamp is not always interactive, in fact if you use -webkit-line-clamp there is not interaction enabled. This attribute allows you to enable see more/see less functionality and overpowers showMoreButton and showLessButton when false. In cases where you do not want any interaction -webkit-line-clamp is used in the background to save work.

Default: true

truncate

Some users might not like our style for the component, and they would like to do some fancy stuff. You can use this attribute to control truncation from outside the component and have a button that controls the truncation.

Default: true

<button class="super-fancy-style">{{buttonText}}</button>

showMoreButton

This attribute enables/disables 'See More' functionality

Default: true

showLessButton

This attribute enables/disables 'See Less' functionality

Default: true

seeMoreText

This component should work in any language, hence this attribute allows you to set the text for the 'See More' button

Default: See More

seeMoreA11yText

This component should have optional support for aria-label in the situation where text alone is not enough to convey context of button to users, hence this attribute allows you to set the aria-label for the 'See More' button. By default this attribute is not used.

Default: false

seeLessText

This component should work in any language, hence this attribute allows you to set the text for the 'See Less' button

Default: See Less

seeLessA11yText

This component should have optional support for aria-label in the situation where text alone is not enough to convey context of button to users, hence this attribute allows you to set the aria-label for the 'See Less' button. By default this attribute is not used.

Default: false

onExpand

This attribute allows you to pass a closure to trigger when text is expanded

onCollapse

This attribute allows you to pass a closure to trigger when text is collapsed

useJsOnly

This attribute allows you to ensure handleTruncate is called all the time. The caveat is the browser native CSS solutions will never be used. Note: When the browser native CSS solutions are used, handleTruncate is never called.

Default: false

handleTruncate

This attribute allows you to pass a closure to trigger every time the text goes through the truncation process, receives a boolean to determine if the text was truncated. Not called when the browser native CSS solutions are used.

Note: Will not execute when the native CSS line-clamp is used because there is no good way currently to tell whether the browser actually truncated the text or not. If you need handleTruncate to run all the time, please enable useJsOnly.

Then create an action that gets notified after the text is truncated. When the text is truncated and ellipsis applied, didTruncate will be true. When the text isn't truncated, didTruncate will be false.

@action
onHandleTruncate(didTruncate) {
  if(didTruncate) {
    this.someProperty = true;
  }
}

Dev TODOs

• [x] tests
• [x] demo page
• [ ] support block form

Thanks

• CSS Line Clamping article
• @nilsynils for his Medium Post
• @One-com for a inspiration