configureAsStructure

How to get configureAsStructure

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

Type: Function

Structures provide invisible grouping, but do provide context for other elements.

Elements configured as structure are not visible in the document themselves. They are, like all ancestors of the elements that contains the cursor, included in the breadcrumb menu.

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 for elements that are semantically irrelevant for the author and are only used for the grouping of other elements.

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

  • isRemovableIfEmpty

  • defaultTextContainer

The following visualization options are visualized by this family:

  • textAlign

Arguments

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