Note

This documentation describes the BoundDocumentationButton Vue component for native UI views for Xml templates see documentation-button.

BoundDocumentationButton

Renders a DocumentationButton for a specific ViewModel property, using the property's caption and documentation text.

Import

import { BoundDocumentationButton } from '@neos/app'

Props

Prop	Type	Default	Description
`propertyName`	`string`	—	Required. The ViewModel property name whose documentation to display

Usage Examples

Next to a field label

<HorizontalLayout space="small" vertical-align="center">
  <Text>Order Number</Text>
  <BoundDocumentationButton property-name="orderNumber" />
</HorizontalLayout>

In a custom label layout

<HorizontalLayout space="extrasmall" vertical-align="center">
  <label property-name="description" />
  <BoundDocumentationButton property-name="description" />
</HorizontalLayout>

Table of Contents