configureAsFrameWithBreakableBlock

How to get configureAsFrameWithBreakableBlock

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

Type: Function

Use this family for block level elements that apply a semantic connotation to their content, may directly contain text and/or inlines, and can contain break tokens or break elements to delimit blocks within that text.

As this family indicates a semantic structure, it is visualized through a border and optionally a background color to delimit the content to which the semantics apply.

Elements belonging to this family cannot be split in two by pressing Enter, and two adjacent elements will not be merged into one. Either would defeat the purpose of semantics.

Use this family for elements that may directly contain break tokens or break elements as well as text and/or inline elements, but also represent certain semantic units.

The following visualization options are visualized by the frameWithBreakableBlock family:

  • backgroundColor

  • showWhen

  • textAlign

Use the withNewlineBreakToken to indicate a new line is used as a break token

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