configureAsGroupWithBlock

How to get configureAsGroupWithBlock

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

Type: Function

This general family provides flexible grouping, for example to support presenting its children more compactly, without whitespace between them and will create a new Block when pressing Enter.

Groups are not visible by default. Displaying its children next to each other, without whitelines between them, indicates the group. Use expression: 'compact' to accomplish this.

Pressing Enter will first split the Block found within the Group, pressing Enter again will split the Group.

If pressing Enter should create a new block, use this family.

The following visualization options are visualized by the group with block family:

  • expression

  • textAlign

Set withNewlineBreakToken to true to indicate a newline character should be used to break blocks. This will automatically set whitespace to 'preserve'. Alternatively, set breakElements to an array of the qualified names of elements that are used to define boundaries between blocks inside this element. Make sure to configure these elements themselves using configureAsBreakElement. Using break elements has no effect on whitespace handling.

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:

  • defaultTextContainer

Arguments

# Name Type Description
1. sxModule SxModule
2. selector XPathTest
3. markupLabel String
4. options CvkOptions
Was this page helpful?