Element: <oj-c-highlight-text>

CORE PACK

Oracle® JavaScript Extension Toolkit (JET)
16.0.0
F83701-01

Since:
  • 15.0.0
Module:
  • highlight-text

Note: This component supersedes the following component: <oj-highlight-text>. Migration info available at preceding link.

QuickNav

Attributes

Methods


JET Highlight Text

Description: JET Highlight Text renders text with highlighting applied.

JET Highlight Text renders a text string with highlighting applied to the given text to match.

A Highlight Text can be created with the following markup.


<oj-c-highlight-text
  text='My text to apply highlighting to.'
  match-text='igh'>
</oj-c-highlight-text>


Usage

Signature:

interface CHighlightTextElement

Typescript Import Format
//To typecheck the element APIs, import as below.
import { CHighlightTextElement } from "oj-c/highlight-text";

//For the transpiled javascript to load the element's module, import as below
import "oj-c/highlight-text";

For additional information visit:

Note: Application logic should not interact with the component's properties or invoke its methods until the BusyContext indicates that the component is ready for interaction.


Attributes

match-text :string

The text string to match.
Names
Item Name
Property matchText
Property change event matchTextChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-match-text-changed

text :string

The text string to apply highlighting to.
Names
Item Name
Property text
Property change event textChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-text-changed

Methods

getProperty(property) : {any}

Retrieves the value of a property or a subproperty.
Parameters:
Name Type Description
property The property name to get. Supports dot notation for subproperty access.
Returns:
Type
any

setProperties(properties) : {void}

Performs a batch set of properties.
Parameters:
Name Type Description
properties An object containing the property and value pairs to set.
Returns:
Type
void

setProperty(property, value) : {void}

Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.
Parameters:
Name Type Description
property The property name to set. Supports dot notation for subproperty access.
value The new value to set the property to.
Returns:
Type
void