configureAsTitleFrame

Type: Function

How to get configureAsTitleFrame?

JavaScript

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

Use this family for titles on all levels.

This is a subclass of the frame family from which the background and border have been removed. Because of their larger type and block layout, it is clear where titles start and end, making other visual indications unnecessary.

Four levels of titles are available: collection title, document title, section title (the default), and figure title. Use the fontVariation visualization option to set one of these.

As with all frame families, the enter key has no effect. Authors will generally understand why this is, as allowing it would create two headings for one document.

Use this for titles of collections, documents, sections, and figures.

The following visualization options are visualized by this family:

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

The following visualization options are visualized by this family:

  • textAlign

Arguments

  1. sxModule

    (Required)

    Type: SxModule

  2. selector

    (Required)

    Type: XPathTest

  3. markupLabel

    (Required)

    Type: String

  4. options

    (Required)