Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nzambello/ellipsed
A JavaScript library for multilined ellipsis
https://github.com/nzambello/ellipsed
ellipsis frontend javascript javascript-library text-ellipsis
Last synced: 3 days ago
JSON representation
A JavaScript library for multilined ellipsis
- Host: GitHub
- URL: https://github.com/nzambello/ellipsed
- Owner: nzambello
- License: mit
- Created: 2017-06-21T19:26:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T03:27:16.000Z (almost 2 years ago)
- Last Synced: 2024-04-26T15:01:54.247Z (8 months ago)
- Topics: ellipsis, frontend, javascript, javascript-library, text-ellipsis
- Language: JavaScript
- Homepage: https://nzambello.github.io/ellipsed/
- Size: 1.1 MB
- Stars: 267
- Watchers: 4
- Forks: 20
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://nzambello.github.io/ellipsed/)
[](https://github.com/nzambello/ellipsed/blob/master/LICENSE)
[](https://github.com/nzambello/ellipsed)
[](https://github.com/nzambello/ellipsed)
[](https://www.npmjs.com/package/ellipsed)
[](https://www.npmjs.com/package/ellipsed)
[](https://github.com/nzambello/ellipsed/issues)
[](https://github.com/nzambello/ellipsed/issues)
[](https://gitter.im/ellipsed/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://nzambello.github.io/ellipsed/)
## What is Ellipsed?
Ellipsed is a JavaScript library for generating multi-lined ellipsed text.
Indicating the number of visible lines, it will truncate the text at the correct position in targeted elements.
## Demo
You can see the demo here: https://nzambello.github.io/ellipsed/
The [example/](https://github.com/nzambello/ellipsed/tree/master/example) directory of this repo contains the demo showed above.
To start it on your local machine, clone the repository and install it by following the installation instructions below, then start it with `npm start` (or with `yarn start`).
## Install
```sh
# Yarn
yarn add ellipsed
# NPM
npm install --save ellipsed
# Bower
bower install ellipsed
```
## Usage
Call the ellipsis method with three parameters:
````javascript
ellipsis(selector, rows, options);
````
- `selector` - A CSS selector string or the DOM Node or Node List used to target the element for truncation
- `rows` - An integer value used as the number of rows that should be visible, following words will be trucated with the `replaceStr` (default is `'...'`).
- `options` - Allows an options object to be passed to further customise the functionality. See options section below for details.
If `responsive` option is set, the function returns the ID of the listener returned by `setTimeout`. It can be useful to clear resize handler timeout.
### Options
Options can be passed through the method using the third parameter, which provides greater control.
Name | Type | Default | Description
---- | ---- | ------- | -----------
replaceStr | string | `'...'` | The string that substituted following the trucated string.
responsive | boolean | `false` | If true, the method is re-called on resize event, so the number of rows is preserved.
debounceDelay | integer | `250` | If `responsive` option is set, it's the delay value for resizing events debouncing.
delimiter | string | `' '` | Use '' for text written in languages such as Japanese, Chinese, etc. since there's usually no space break in such languages; or for text contains long word (word that is longer than the width of the container).
### Import
Ellipsed is provided as a UMD module.
You can use it as a ES6 module:
```javascript
import { ellipsis } from 'ellipsed';
```
As a CommonJS module:
```javascript
var { ellipsis } = require('ellipsed');
```
As an AMD module:
```javascript
require([
'ellipsed'
], function(ellipsed) {
var ellipsis = ellipsed.ellipsis;
});
```
Or as a global module in the browser:
```javascript
var ellipsis = window.ellipsed.ellipsis;
```
## Performance
It seems that having multiple calls of ellipsis with `responsive` option enabled would add multiple event listeners and would be recommended to use a single call with a multiple selector.
A single event listener should be more efficient and events handling more fluid.
## Browser support
The library has been tested on:
- Google Chrome 60+
- Firefox 55+
- Safari 10+
- Edge 14+
- IE 9+
## Contributing
New contributors are warmly welcome, see the [CONTRIBUTING.md](https://github.com/nzambello/ellipsed/blob/master/CONTRIBUTING.md) file for other information.
Many thanks to [@nekorina](https://github.com/nekorina) for project's logo.