Note

This documentation describes the Label Vue component for native UI views for Xml templates see label.

Label

Displays the caption of a ViewModel property with optional documentation popover, required indicator, and AI suggestion support.

Import

import { Label } from '@neos/app'

Props

Inherits ViewModelPropertyProps and TextProps plus:

Prop	Type	Default	Description
propertyName	string	—	Required. The ViewModel property name
item	Model	undefined	Data item owning the property
displayPropertyValue	boolean	false	Show the property value next to the caption
requiredIndicator	boolean	true	Show a * indicator when the property is required
size	Size	undefined	Text size
weight	'normal' \| 'strong'	undefined	Font weight

Usage Examples

Basic label

<label property-name="firstName" />

Label with value

<label property-name="status" :display-property-value="true" />

Without required indicator

<label property-name="notes" :required-indicator="false" />

Custom label + field layout

<VerticalLayout space="extrasmall">
  <label property-name="email" size="small" weight="strong" />
  <Textbox property-name="email" :label-position="'hidden'" />
</VerticalLayout>