DitaCrossReferencePopover

Type: Component

A popover used for cross references in dita editors.

Is registered under the name DitaCrossReferencePopover.

Use the popover in the family configuration by adding visualization.popoverComponentName and visualization.popoverData.

Props

# Name Type Description
1. data Object

The popoverData that should be provided in the family configuration.

  Members

Members

Name Type Description
contextNodeId NodeId

A property that comes from the popover method self, contains the node ID of the node that is configured. Does not need to be added in the popoverData.

[deleteOperationName] String

The operation for removing the reference. Is by default reference-delete.

[editOperationName] String

Only when an editOperationName is used, a edit button is made. The edit operation should provide a way to edit the reference.

[referenceMarkupLabel] String

Provide an alternative label for this reference, provided as REFERENCE_MARKUP_LABEL to the MessageFormat for the popover's description. If omitted, the configured markup label for the reference node is used instead.

[targetIsPermanentId] Boolean

Determines wether the reference contains permanentId's.

targetQuery XPathQuery

Determines the reference content with a xpath query, starting from the context node. Often this is just an attribute, for example @href.

Example

configureAsInlineLink(sxModule, 'self::xref[@format="dita"]', 'link', href, {
	emptyElementPlaceholderText: 'type the link text',
		popoverComponentName: 'DitaCrossReferencePopover',
		popoverData: {
			editOperationName: 'dita-reference-document-edit',
			targetIsPermanentId: true,
			targetQuery: '@href'
		}
});