configureAsFrame

How to get configureAsFrame

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

Type: Function

The ‘frame’ family is for block level elements that apply a semantic connotation to their content.

The meaning that this family indicates 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.

Examples of frame elements are block quotes, figures, labels, and notes.

The following visualization options are visualized by the frame family:

  • backgroundColor

  • showWhen

  • textAlign

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:

  • isRemovableIfEmpty

  • defaultTextContainer

Arguments

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