Browse Source

add EllipsisDirective document

resolves #3188
pull/7380/head
mehmet-erim 6 years ago
parent
commit
566b1afdd5
  1. 83
      docs/en/UI/Angular/Ellipsis-Directive.md
  2. BIN
      docs/en/UI/Angular/images/ellipsis-directive-before.jpg
  3. BIN
      docs/en/UI/Angular/images/ellipsis-directive-result1.jpg
  4. BIN
      docs/en/UI/Angular/images/ellipsis-directive-result2.jpg
  5. 4
      docs/en/docs-nav.json

83
docs/en/UI/Angular/Ellipsis-Directive.md

@ -0,0 +1,83 @@
# Ellipsis
Text inside an HTML element can be truncated easily with an ellipsis by using CSS. To make this even easier, you can use the `EllipsisDirective` which has been exposed from the `@abp/ng.theme.shared` package.
## Getting Started
In order to use the `EllipsisDirective` in an HTML template, the **`ThemeSharedModule`** should be imported into your module like this:
```js
// ...
import { ThemeSharedModule } from '@abp/ng.theme.shared';
@NgModule({
//...
imports: [..., ThemeSharedModule],
})
export class MyFeatureModule {}
```
or **if you would not like to import** the `ThemeSharedModule`, you can import the **`EllipsisModule`** as shown below:
```js
// ...
import { EllipsisModule } from '@abp/ng.theme.shared';
@NgModule({
//...
imports: [..., EllipsisModule],
})
export class MyFeatureModule {}
```
## Usage
The `EllipsisDirective` is very easy to use. The directive's selector is **`abpEllipsis`**. By adding the `abpEllipsis` attribute to an HTML element, you can activate the `EllipsisDirective` for the HTML element.
See an example usage:
```html
<p abpEllipsis>
Lorem ipsum dolor sit, amet consectetur adipisicing elit. Laboriosam commodi quae aspernatur,
corporis velit et suscipit id consequuntur amet minima expedita cum reiciendis dolorum
cupiditate? Voluptas eaque voluptatum odio deleniti quo vel illum nemo accusamus nulla ratione
impedit dolorum expedita necessitatibus fugiat ullam beatae, optio eum cupiditate ducimus
architecto.
</p>
```
The `abpEllipsis` attribute has been added to the `<p>` element that containing very long text inside to activate the `EllipsisDirective`.
See the result:
![Ellipsis directive result](./images/ellipsis-directive-result1.jpg)
The long text has been truncated by using the directive.
The UI before using the directive looks like this:
![Before using the EllipsisDirective](./images/ellipsis-directive-before.jpg)
### Specifying Max Width of an HTML Element
An HTML element max width can be specified as shown below:
```html
<div [abpEllipsis]="'100px'">
Lorem ipsum dolor sit amet consectetur adipisicing elit. Cumque, optio!
</div>
<div [abpEllipsis]="'15vw'">
Lorem ipsum dolor sit amet consectetur adipisicing elit. Cumque, optio!
</div>
<div [abpEllipsis]="'50%'">
Lorem ipsum dolor sit amet consectetur adipisicing elit. Cumque, optio!
</div>
```
See the result:
![Ellipsis directive result 2](./images/ellipsis-directive-result2.jpg)

BIN
docs/en/UI/Angular/images/ellipsis-directive-before.jpg

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

BIN
docs/en/UI/Angular/images/ellipsis-directive-result1.jpg

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

BIN
docs/en/UI/Angular/images/ellipsis-directive-result2.jpg

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

4
docs/en/docs-nav.json

@ -830,6 +830,10 @@
{
"text": "Page Alerts",
"path": "UI/Angular/Page-Alerts.md"
},
{
"text": "Ellipsis",
"path": "UI/Angular/Ellipsis-Directive.md"
}
]
},

Loading…
Cancel
Save