configureAsInlineFrame

How to get configureAsInlineFrame

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

Type: Function

These are for elements describing the meaning of text phrases.

Their semantic unity is visualised through a colored border and a background.

Just like block frames, inline frames can’t be split in two and adjacent ones will not merge. Inline frames can be deleted by pressing Backspace or Delete twice: the first press selects the frame to help the author understand what will happen.

Some examples are short quotes, abbreviations, dates, personal or locational information, and keywords.

Use the available array of background colors to clearly group related inline frames together. For example, assign all elements that refer to personal information the same color, or all that refer to dates or events one other. This helps the author infer what kind of markup is present, or verify its correctness.

The following visualization options are visualized by this family:

  • backgroundColor

  • baseline

  • case

  • endDelimiter

  • fontStack

  • isMonospaced

  • lineThroughStyle

  • overlineStyle

  • slant

  • startDelimiter

  • underlineStyle

  • weight

The following widget areas are available:

  • inlineBefore

  • inlineAfter

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