createLabelQueryWidget

How to get createLabelQueryWidget

import createLabelQueryWidget from 'fontoxml-families/src/createLabelQueryWidget.js'

Type: Function

This widget is used to display the result of the given XPathQuery. The given XPathQuery will be evaluated to a string with the source node bound to its context.

Use the inline option to select whether this widget will be used in an inline widget area.

Optionally, you can provide a prefixQuery and a suffixQuery. When set, these queries will be evaluated to strings with the source node bound to their context.

Arguments

# Name Type Description
1. labelQuery XPathQuery

The XPathQuery to evaluate. This should evaluate to a string value.

2. [options] Object
  Members

Members

Name Type Description
inline Boolean

When passed true, this widget will be suitable for use in inline widget areas.


  Default value
false
prefixQuery XPathQuery

The XPathQuery to evaluate for the prefix.


  Default value
""
styles Array<String>

If passed, bound to the $styles variable in the xpath. Used for widgets extending this widget.


  Default value
[]
suffixQuery XPathQuery

The XPathQuery to evaluate for the suffix.


  Default value
""
tooltipQuery XPathQuery

The XPathQuery to evaluate for the tooltip.


  Default value
""

Returns

Type: Widget

Was this page helpful?