https://github.com/thisissoon/angular-ellipsis
A simple lightweight library for Angular which removes excess text and add ellipsis symbol to end of text before text overflows container
https://github.com/thisissoon/angular-ellipsis
angular directive ellipsis multiline-ellipsis ngx ngx-ellipsis ngx-library ngx-multiline-ellipsis text-overflow
Last synced: 11 months ago
JSON representation
A simple lightweight library for Angular which removes excess text and add ellipsis symbol to end of text before text overflows container
- Host: GitHub
- URL: https://github.com/thisissoon/angular-ellipsis
- Owner: thisissoon
- License: mit
- Created: 2016-05-25T14:46:36.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-02-06T16:20:31.000Z (about 7 years ago)
- Last Synced: 2025-04-10T07:03:17.579Z (12 months ago)
- Topics: angular, directive, ellipsis, multiline-ellipsis, ngx, ngx-ellipsis, ngx-library, ngx-multiline-ellipsis, text-overflow
- Language: TypeScript
- Homepage:
- Size: 633 KB
- Stars: 16
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Angular Ellipsis
[![Build Status][circle-badge]][circle-badge-url]
[![Coverage Status][coveralls-badge]][coveralls-badge-url]
[![Commitizen friendly][commitizen-badge]][commitizen]
[![code style: prettier][prettier-badge]][prettier-badge-url]
A simple lightweight library for [Angular][angular] which removes excess text and add ellipsis symbol to end of text before text overflows container.
This is a simple library for [Angular][angular], implemented in the [Angular Package Format v5.0](https://docs.google.com/document/d/1CZC2rcpxffTDfRDs6p1cfbmKNLA6x5O-NtkJglDaBVs/edit#heading=h.k0mh3o8u5hx).
## Install
`npm i @thisissoon/angular-ellipsis --save`
`app.module.ts`
```ts
import { EllipsisModule } from '@thisissoon/angular-ellipsis';
@NgModule({
imports: [EllipsisModule],
})
export class AppModule {}
```
## Example
`app.component.html`
```html
...
```
## Development server
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
## Code scaffolding
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
## Build
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
## Running unit tests
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
## Running end-to-end tests
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
## Making Commits
This repo uses [Commitizen CLI][commitizen] and [Conventional Changelog][conventional-changelog] to create commits and generate changelogs. Instead of running `git commit` run `git cz` and follow the prompts. Changelogs will then be generated when creating new releases by running `npm run release`.
## Making Releases
Run `npm run release` to create a new release. This will use [Standard Version][standard-version] to create a new release. [Standard Version][standard-version] will generate / update the changelog based on commits generated using [Commitizen CLI][commitizen], update the version number following semantic versioning rules and then commit and tag the commit for the release. Simply run `git push --follow-tags origin master`.
## Further help
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
[circle-badge]: https://circleci.com/gh/thisissoon/angular-ellipsis.svg?style=shield
[circle-badge-url]: https://circleci.com/gh/thisissoon/angular-ellipsis
[coveralls-badge]: https://coveralls.io/repos/github/thisissoon/angular-ellipsis/badge.svg?branch=master
[coveralls-badge-url]: https://coveralls.io/github/thisissoon/angular-ellipsis?branch=master
[prettier-badge]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=shield
[prettier-badge-url]: https://github.com/prettier/prettier
[angular]: https://angular.io/
[commitizen]: http://commitizen.github.io/cz-cli/
[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[conventional-changelog]: https://github.com/conventional-changelog/conventional-changelog
[standard-version]: https://github.com/conventional-changelog/standard-version