configureAsOutOfOrderStructure

How to get configureAsOutOfOrderStructure

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

Type: Function

The out of order structure family is used to display elements in a separate area at the bottom of a sheet frame.

Out of order structures are displayed as a gray area at the bottom of the sheet frame. Visualizing a clear distinction between the main content and the out of order structure.

Structures don’t affect keyboard flow. Empty structures will be removed automatically. A structure carries no semantic meaning and is also not splittable by pressing Enter. Often, structure elements cannot contain text. A default text container should then be configured to be automatically inserted as soon as the author starts typing in it.

Use this family to visually distinguish an element from the rest of the content when for example it has a vastly different user experience or is disconnected from the content itself while still being relevant. When configuring elements to use this family, make sure to include a corresponding relatedNodesWidget at the bottom of the sheet frame to ensure that matching nodes are actually shown there.

Use the createInnerJsonMl callback to render the object to HTML.

The following visualization options are visualized by this family:

  • showWhen

The following widget areas are available:

  • blockHeaderLeft

  • blockHeaderRight

  • blockBefore

  • blockAfter

  • blockFooter

  • blockOutsideBefore

  • blockOutsideAfter

This family has a number of additional options which affect how it behaves:

  • isAutoremovableIfEmpty

  • defaultTextContainer

Arguments

# Name Type Description
1. sxModule SxModule
2. selector XPathTest
3. markupLabel String
4. options CvkOptions