alfresco-ng2-components/docs/core/services/highlight-transform.service.md
Maurizio Vitale 1fa81962a0
👽 Angular 14 rebase 👽 (#7769)
* 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>
2022-08-25 10:50:30 +01:00

2.1 KiB

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
Highlight Transform service v2.0.0 Active 2018-11-13

Highlight Transform service

Adds HTML to a string to highlight chosen sections.

Class members

Methods

  • highlight(text: string, search: string, wrapperClass: string = "adf-highlight"): HighlightTransformResult
    Searches for search string(s) within text and highlights all occurrences.
    • text: string - Text to search within
    • search: string - Text pattern to search for
    • wrapperClass: string - CSS class used to provide highlighting style
    • Returns HighlightTransformResult - New text along with boolean value to indicate whether anything was highlighted

Details

A typical use case for this service is to display the results from a search engine. An excerpt of a retrieved document can be shown with the matching search terms highlighted to indicate where they were found.

The service works by adding HTML <span> elements around all sections of text that match the search string. You can specify multiple search strings at once by separating them with spaces, so passing "Apple Banana Cherry" in search will highlight any of those words individually. The <span> element includes a class attribute which defaults to "highlight" but you can pass any class name you like using the wrapperClass parameter.

The resulting text with HTML highlighting is returned within a HighlightTransformResult object:

interface HighlightTransformResult {
    text: string;
    changed: boolean;
}

The changed flag will be false if the search string was not found (ie, no highlighting took place) and true otherwise.

See also