createNumberingWidget

How to get createNumberingWidget

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

Type: Function

This widget is used to display ascending numbers on consecutive elements. This can, for example, be used for numbered list-like structures.

Valid numbering styles are:

  • decimal

  • lowerAlpha

  • upperAlpha

  • lowerGreek

  • upperGreek

  • lowerRoman

  • upperRoman

By default, the numbering is rest per document, but the containerSelectorOrNodeSpec option can set a different scope.

Arguments

# Name Type Description
1. itemSelector XPathTest

An XPathTest returning true for the elements which should be numbered.

2. [options] Object
  Members

Members

Name Type Description
containerSelectorOrNodeSpec XPathTest

An XPathTest returning true for elements which define the scope.


  Default value
"self::document-node()"
numberingStyle String

The numbering style to use.


  Default value
"decimal"
prefix String

When present, the prefix will be added at in front of the number.


  Default value
""
suffix String

When present, the suffix will be added at after the number.


  Default value
"."
[tooltipContent] String

A message which will be displayed in the tooltip.

Returns

Type: Widget

Was this page helpful?