Ember Truncate
This addon provides a component for truncating text in an Ember application.
Compatibility
- Ember.js v3.16 or above
- Ember CLI v2.13 or above
- Node.js v12 or above
Installation
ember install ember-truncate
Usage
To get started, place the truncate-multiline
component in one of your templates and provide a string to the text
attribute.
The block form offers customization beyond that of the inline form and support for nested DOM nodes. Instead of supplying the text
attribute, render text or elements into the target
component. Use the button
component to customize the more/less button, or exclude it to remove the button entirely. The isTruncated
property provides access to the current state of truncation.
NB: It is recommended that you use the tilde ~
character to omit extra whitespace when using the block form.
Attributes
The truncate-multiline
component offers other functionality via attributes.
lines
The number of lines at which the component truncates can be changed by setting the lines
attribute. The default is 3 lines.
truncate
Programmatically controls expanding/collapsing the text. This attribute is especially useful when the button is omitted.
Actions
The truncate-multiline
component uses actions to signal change in truncation state.
onExpand
The onExpand
action is triggered whenever the text is expanded.
onCollapse
The onCollapse
action is triggered whenever the text is collapsed.
onToggle
The onToggle
action is triggered whenever the text is expanded or collapsed. The new truncation state is passed to the action: true for collapsed, false for expanded.
Contributing
See the Contributing guide for details.
License
This project is licensed under the MIT License.