mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
1fa81962a0
* fix after rebase * new release strategy for ng next Signed-off-by: eromano <eugenioromano16@gmail.com> * peer dep Signed-off-by: eromano <eugenioromano16@gmail.com> * Angular 14 fix unit test and storybook Signed-off-by: eromano <eugenioromano16@gmail.com> fix after rebase Signed-off-by: eromano <eugenioromano16@gmail.com> update pkg.json Signed-off-by: eromano <eugenioromano16@gmail.com> missing dep Signed-off-by: eromano <eugenioromano16@gmail.com> Fix mistake and missing code Dream....build only affected libs Add utility run commands * Use nx command to run affected tests * Fix nx test core fix content tests Run unit with watch false core test fixes reduce test warnings Fix process cloud unit Fix adf unit test Fix lint process cloud Disable lint next line Use right core path Fix insights unit fix linting insights Fix process-services unit fix the extensions test report fix test warnings Fix content unit Fix bunch of content unit * Produce an adf alpha of 14 * hopefully fixing the content * Push back the npm publish * Remove flaky unit * Fix linting * Make the branch as root * Get rid of angualar13 * Remove the travis depth * Fixing version for npm * Enabling cache for unit and build * Fix scss for core and paths Copy i18 and asset by using ng-packager Export the theming alias and fix path Use ng-package to copy assets process-services-cloud Use ng-package to copy assets process-services Use ng-package to copy assets content-services Use ng-package to copy assets insights * feat: fix api secondary entry point * fix storybook rebase * Move dist under dist/libs from lib/dist * Fix the webstyle * Use only necessary nrwl deps and improve lint * Fix unit for libs * Convert lint.sh to targets - improve performance * Use latest of angular * Align alfresco-js-api Signed-off-by: eromano <eugenioromano16@gmail.com> Co-authored-by: eromano <eugenioromano16@gmail.com> Co-authored-by: Mikolaj Serwicki <mikolaj.serwicki@hyland.com> Co-authored-by: Tomasz <tomasz.gnyp@hyland.com>
75 lines
2.1 KiB
Markdown
75 lines
2.1 KiB
Markdown
---
|
|
Title: Highlight directive
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-11-20
|
|
---
|
|
|
|
# [Highlight directive](lib/core/src/lib/directives/highlight.directive.ts "Defined in highlight.directive.ts")
|
|
|
|
Adds highlighting to selected sections of an HTML element's content.
|
|
|
|
## Basic Usage
|
|
|
|
```HTML
|
|
<div
|
|
[adf-highlight]="dance"
|
|
adf-highlight-selector=".highlightable"
|
|
adf-highlight-class="greenHighlight"
|
|
>
|
|
<div class="highlightable">You can dance if you want to</div>
|
|
</div>
|
|
```
|
|
|
|
## Class members
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
| ---- | ---- | ------------- | ----------- |
|
|
| classToApply | `string` | "adf-highlight" | CSS class used to apply highlighting. |
|
|
| search | `string` | "" | Text to highlight. |
|
|
| selector | `string` | "" | Class selector for highlightable elements. |
|
|
|
|
## Details
|
|
|
|
Add `adf-highlight` with a search term to an element to highlight occurrences
|
|
of that term in its content. For example:
|
|
|
|
```HTML
|
|
<div [adf-highlight]="'dance'" adf-highlight-selector=".highlightable">
|
|
<div class="highlightable">
|
|
You can dance if you want to
|
|
</div>
|
|
</div>
|
|
```
|
|
|
|
This will result in the word "dance" being highlighted. Note that you must also
|
|
specify `adf-highlight-selector`, a CSS selector that specifies which
|
|
elements can have their contents highlighted.
|
|
|
|
If the search string contain spaces then each section between the spaces will
|
|
be treated as a separate item to highlight. For example, you could use this to
|
|
highlight all occurrences of words in a list.
|
|
|
|
The highlighting works by adding an HTML <span> element around the
|
|
selected text. The <span> includes a CSS class; this defaults to
|
|
"adf-highlight" but you can supply your own class using the `adf-highlight-class`
|
|
property:
|
|
|
|
```HTML
|
|
<div
|
|
[adf-highlight]="'dance'"
|
|
adf-highlight-selector=".highlightable"
|
|
adf-highlight-class="myGreenHighlight">
|
|
<div class="highlightable">
|
|
You can dance if you want to
|
|
</div>
|
|
</div>
|
|
```
|
|
|
|
## See also
|
|
|
|
- [Text highlight pipe](../pipes/text-highlight.pipe.md)
|
|
- [Highlight transform service](../services/highlight-transform.service.md)
|