alfresco-ng2-components/docs/node-name-tooltip.pipe.md
Andy Stark 4752f3b73e [ADF-2334] Added version and status metadata to doc files (#2974)
* [ADF-2334] Added version and status metadata to doc files

* [ADF-2334] Tidier looking metadata for guide pages
2018-02-22 09:34:21 +00:00

29 lines
824 B
Markdown

---
Added: v2.0.0
Status: Active
---
# Node Name Tooltip pipe
Formats the tooltip for a Node.
## Basic Usage
```html
<data-column
key="name"
title="APP.DOCUMENT_LIST.COLUMNS.NAME">
<ng-template let-value="value" let-context>
<span title="{{ context?.row?.obj | adfNodeNameTooltip }}">{{ value }}</span>
</ng-template>
</data-column>
```
## Details
The tooltip is formatted according to the following rules:
- if the _title_ and _description_ are missing, then the tooltip shows the _name_;
- if the _title_ is missing, then the tooltip shows the _name_ and _description_;
- if the _description_ is missing, then the tooltip shows the _name_ and _title_;
- if _name_ and _title_, _name_ and _description_, or _title_ and _description_ are the same, then only a single line is displayed.