Type: Function

How to get configureAsInlineImageInFrame?


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

Use this family when inline images can contain other elements which should be rendered.

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.

Use this family for inline images which can contain other elements which should be rendered. For example an desc element, which contains a description of the image. These images may be represented by a permanent id or a non-permanent id. By setting the option options.isPermanentId to true, the result of the query is interpreted as a permanent id, which will be resolved.

The following visualization options are visualized by this family:

  • backgroundColor

  • showWhen

The following widget areas are available:

  • inlineBefore

  • inlineAfter

This family has a number of additional options which affect how it behaves:

  • defaultTextContainer

  • referenceQuery

  • isPermanentId

Note that this family supports the doubleClickOperation option, being the operation which is executed on double-click.


// Configure HTML images without permanent ids
configureAsInlineImageInFrame(sxModule, 'self::img', 'image', { referenceQuery: '@src', isPermanentId: false });

// Configure HTML images with permanent ids
configureAsInlineImageInFrame(sxModule, 'self::img', 'image', { referenceQuery: '@src', isPermanentId: true });

// Configure an other kind of image with the url as its text content
configureAsInlineImageInFrame(sxModule, 'self::img', 'image', { referenceQuery: 'string(.)', isPermanentId: true });


  1. sxModule


    Type: SxModule

  2. selector


    Type: XPathTest

  3. markupLabel


    Type: String

  4. options


    The options, or the name of the attribute in which the permanent id referencing this image is located. The generic CvkOptions are expanded with two properties: