configureAsInclusionInFrame

Type: Function

How to get configureAsInclusionInFrame?

JavaScript

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

Configure nodes to include external content via a reference to another node. A single call to this function configures both block and inline visualization of the referencing node. The target node determines the visualization based on where it originally came from.

The included content is not editable and selections can not be made.

As the included content can not be edited we define no keyboard flow inside them.

The family can contain the normal widget areas for the block variant:

  • blockHeaderLeft

  • blockHeaderRight

  • blockBefore

  • blockAfter

  • blockFooter

  • blockOutsideBefore

  • blockOutsideAfter

and for the inline variant:

  • inlineBefore

  • inlineAfter

If you want to contain these widgets without a frame, try using configureAsInclusion instead.

A clickOperation may be used to execute something on click, like so the doubleClickOperation may be used to excute an operation on double-click.

Two examples of when this family is used are DITA conrefs and the XInclude schema.”

Please refer to the guide of configure inclusions to learn how to use this family to implement the xinclude element or similar inclusions.

The following visualization options are visualized by this family:

  • backgroundColor

  • showWhen

Arguments

  1. sxModule

    (Required)

    Type: SxModule

  2. selector

    (Required)

    Type: XPathTest

  3. markupLabel

    (Required)

    Type: String

  4. resolveReferenceFunction

    (Required)

  5. options

    (Required)