yLabel

Description

The yLabel component serves as a powerful tool primarily designed for displaying short text information within your application. It's an adaptable element that allows both static and dynamic content.

With the yLabel you can display user instructions, show real-time data updates, provide context for other components, or present calculated values within a form, among other applications.

Some uses for the yLabel are:

• Linking input elements
• Displaying table data

tip

Use yTextarea or yTextbox for handling longer texts.

Basic Structure

The basic structure of the yLabel shall be explained in the following. For the general structure of a yComponent please visit the YBase-components basic-structure.

Properties

Through its various properties the yLabel can be configured to suit your needs. The display below provides you with an overview of all the yLabel properties.

Properties can be changed directly through three methods:

• Inside the Toolbar, which is positioned in your workarea next to your component right where you need it. It shows the most important properties, thus providing a fast and efficient way to configure your component in the most basic way.
• It may also occur in the Toolbar Extension, which is a seamless extension accesible as a dropdown item of the Toolbar. It extends the functionality of the Toolbar by providing advanced pickers for the most used properties.
• Inside the Detail Panel, which is located in the righthand drawer. Every property of a component can be configured here.

Generic

METAread more

Name: componentId

Not Editable

Number Property

--y-label__component-id

The identifier of the component that is unique within a page.

Name: componentType

Not Editable

String Property

--y-label__component-type

The type of the component. For this component it is -label.

Name: name

String Property

--y-label__name

The custom name of the component. It serves for better identification of the component.

Name: version

String Property

--y-label__version

The custom version of the Label-component. This can be used to ensure that all components work well together.

Name: coreTheme

String Property

--y-label__core-theme

The CoreTheme, which will be apllied to the Label. For further information on themes visit the themes page.

Name: subTheme

String Property

--y-label__sub-theme

The subtheme subordinated to the previously specified CoreTheme, which will be apllied to the Label. For further information on themes visit the themes page.

Name: groupTheme

String Property

--y-label__group-theme

The group theme is a further variation of the subtheme which is specified especially for variations of a component inside the subtheme. For further information on themes visit the Theme-Manager page.

DISPLAYread more

Name: display

String Property

--y-label__display

This property specifies the display behavior of the component. This can be be set to:

• none
• block
• flex
• inline

Name: position

Not Editable

String Property

--y-label__position

This property specifies the type of positioning method used for the component. This can be be set to:

• static
• relative
• absolute
• sticky
• fixed

Name: visible

String Property

--y-label__visible

This property can toggle the visibility of the component. The two modes are completely hidden and fully shown.

SIZEread more

Name: minWidth

Injectable

UnitNumber Property

--y-label__min-width

The minimum value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %

Name: minHeight

Injectable

UnitNumber Property

--y-label__min-height

The minimum value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %

Name: width

Injectable

UnitNumber Property

--y-label__width

The value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• auto

Name: height

Injectable

UnitNumber Property

--y-label__height

The value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• auto

Name: maxWidth

Injectable

UnitNumber Property

--y-label__max-width

The maximum value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• none

Name: maxHeight

Injectable

UnitNumber Property

--y-label__max-height

The maximum value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• none

Name: flex

String Property

--y-label__flex

The flex property sets the length on flexible items. This sets the value in n-fold shares extrapolated to all other components with the flex display within the same container.

PLACEMENTread more

Name: marginTop

Injectable

UnitNumber Property

--y-label__margin-top

This property creates a space around the component, outside of the top border. This can be set in percent or pixels.

Name: marginRight

Injectable

UnitNumber Property

--y-label__margin-right

This property creates a space around the component, outside of the right border. This can be set in percent or pixels.

Name: marginBottom

Injectable

UnitNumber Property

--y-label__margin-bottom

This property creates a space around the component, outside of the bottom border. This can be set in percent or pixels.

Name: marginLeft

Injectable

UnitNumber Property

--y-label__margin-left

This property creates a space around the component, outside of the left border. This can be set in percent or pixels.

Name: paddingTop

Injectable

UnitNumber Property

--y-label__padding-top

This property creates a space within the component, inside of the top border. This can be set in percent or pixels.

Name: paddingRight

Injectable

UnitNumber Property

--y-label__padding-right

This property creates a space within the component, inside of the right border. This can be set in percent or pixels.

Name: paddingBottom

Injectable

UnitNumber Property

--y-label__padding-bottom

This property creates a space within the component, inside of the bottom border. This can be set in percent or pixels.

Name: paddingLeft

Injectable

UnitNumber Property

--y-label__padding-left

This property creates a space within the component, inside of the top border. This can be set in percent or pixels.

Style

BACKGROUNDread more

Name: bgColor

Injectable

Color Property

--y-label__bg-color

--y-label__bg-color__normal

--y-label__bg-color__hover

--y-label__bg-color__focus

--y-label__bg-color__disabled

The color of the background. This can be set as a color from a palette or a custom hex color.

BORDERread more

Name: borderTopColor

Injectable

Color Property

--y-label__border-top-color

--y-label__border-top-color__normal

--y-label__border-top-color__hover

--y-label__border-top-color__focus

--y-label__border-top-color__disabled

The color of the top border. This can be set as a color from a palette or a custom hex color.

Name: borderTopStyle

Injectable

String Property

--y-label__border-top-style

--y-label__border-top-style__normal

--y-label__border-top-style__hover

--y-label__border-top-style__focus

--y-label__border-top-style__disabled

The style of the top border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderTopWidth

Injectable

UnitNumber Property

--y-label__border-top-width

--y-label__border-top-width__normal

--y-label__border-top-width__hover

--y-label__border-top-width__focus

--y-label__border-top-width__disabled

The width of the top border. This can be set in percent or pixels.

Name: borderRightColor

Injectable

Color Property

--y-label__border-right-color

--y-label__border-right-color__normal

--y-label__border-right-color__hover

--y-label__border-right-color__focus

--y-label__border-right-color__disabled

The color of the right border. This can be set as a color from a palette or a custom hex color.

Name: borderRightStyle

Injectable

String Property

--y-label__border-right-style

--y-label__border-right-style__normal

--y-label__border-right-style__hover

--y-label__border-right-style__focus

--y-label__border-right-style__disabled

The style of the right border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderRightWidth

Injectable

UnitNumber Property

--y-label__border-right-width

--y-label__border-right-width__normal

--y-label__border-right-width__hover

--y-label__border-right-width__focus

--y-label__border-right-width__disabled

The width of the right border. This can be set in percent or pixels.

Name: borderBottomColor

Injectable

Color Property

--y-label__border-bottom-color

--y-label__border-bottom-color__normal

--y-label__border-bottom-color__hover

--y-label__border-bottom-color__focus

--y-label__border-bottom-color__disabled

The color of the bottom border. This can be set as a color from a palette or a custom hex color.

Name: borderBottomStyle

Injectable

String Property

--y-label__border-bottom-style

--y-label__border-bottom-style__normal

--y-label__border-bottom-style__hover

--y-label__border-bottom-style__focus

--y-label__border-bottom-style__disabled

The style of the bottom border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderBottomWidth

Injectable

UnitNumber Property

--y-label__border-bottom-width

--y-label__border-bottom-width__normal

--y-label__border-bottom-width__hover

--y-label__border-bottom-width__focus

--y-label__border-bottom-width__disabled

The width of the bottom border. This can be set in percent or pixels.

Name: borderLeftColor

Injectable

Color Property

--y-label__border-left-color

--y-label__border-left-color__normal

--y-label__border-left-color__hover

--y-label__border-left-color__focus

--y-label__border-left-color__disabled

The color of the left border. This can be set as a color from a palette or a custom hex color.

Name: borderLeftStyle

Injectable

String Property

--y-label__border-left-style

--y-label__border-left-style__normal

--y-label__border-left-style__hover

--y-label__border-left-style__focus

--y-label__border-left-style__disabled

The style of the left border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderLeftWidth

Injectable

UnitNumber Property

--y-label__border-left-width

--y-label__border-left-width__normal

--y-label__border-left-width__hover

--y-label__border-left-width__focus

--y-label__border-left-width__disabled

The width of the left border. This can be set in percent or pixels.

Name: borderRadius

Injectable

UnitNumber Property

--y-label__border-radius

The radius of the corners of all the borders. This can be set in percent or pixels.

SHADOWread more

Name: boxShadow

Injectable

String Property

--y-label__box-shadow

--y-label__box-shadow__normal

--y-label__box-shadow__hover

--y-label__box-shadow__focus

--y-label__box-shadow__disabled

The shadow of the component. This is set by the 4 sub-properties x, y, blur and spread of the shadow-property, which can be further read about in the shadow-property section.

OPACITYread more

Name: opacity

Injectable

Number Property

--y-label__opacity

--y-label__opacity__normal

--y-label__opacity__hover

--y-label__opacity__focus

--y-label__opacity__disabled

The opacity of all colored parts of the component. This value is set in percent.

LABELread more

Name: label__fontColor

Injectable

Color Property

--y-label__label__font-color

--y-label__label__font-color__normal

--y-label__label__font-color__hover

--y-label__label__font-color__focus

--y-label__label__font-color__disabled

The color of the label text. This can be set as a color from a palette or a custom hex color.

Name: label__fontFamily

Injectable

String Property

--y-label__label__font-family

--y-label__label__font-family__normal

--y-label__label__font-family__hover

--y-label__label__font-family__focus

--y-label__label__font-family__disabled

The font-family of the label text. This can be picked from a large list of provided fonts.

Name: label__fontWeight

Injectable

Number Property

--y-label__label__font-weight

--y-label__label__font-weight__normal

--y-label__label__font-weight__hover

--y-label__label__font-weight__focus

--y-label__label__font-weight__disabled

The font-weight of the label text. This can be set in a custom number, as example:

• 400 = normal(regular)
• 500 = medium
• 600 = semi bold
• 700 = bold

Name: label__fontStyle

Injectable

String Property

--y-label__label__font-style

--y-label__label__font-style__normal

--y-label__label__font-style__hover

--y-label__label__font-style__focus

--y-label__label__font-style__disabled

The font-style of the label text. This can be set to normal, italic or oblique.

Name: label__textTransform

Injectable

String Property

--y-label__label__text-transform

--y-label__label__text-transform__normal

--y-label__label__text-transform__hover

--y-label__label__text-transform__focus

--y-label__label__text-transform__disabled

The text-transformation of the label text. This can be set to:

• capitalize
• uppercase
• lowercase
• none
• full-width

Name: label__textDecoration

Injectable

String Property

--y-label__label__text-decoration

--y-label__label__text-decoration__normal

--y-label__label__text-decoration__hover

--y-label__label__text-decoration__focus

--y-label__label__text-decoration__disabled

The text-decoration of the label text. This can be set to:

• strikethrough
• underline

Name: label__fontSize

Injectable

UnitNumber Property

--y-label__label__font-size

The font-size of the label text. This can be set in: -cm

• mm
• in
• px
• em
• ex
• ch
• rem

Name: label__fontAlign

Injectable

String Property

--y-label__label__font-align

The font-align of the label text. This property moves the label text to the desired position, it can be set to left, center or right.

Name: label__whiteSpace

String Property

--y-label__label__white-space

The whitespaces of the label text. This can be set to:

• normal
• nowrap
• pre
• pre-wrap
• pre-line
• break-spaces

Name: label

String Property

--y-label__label

The actual written text in the label. There is no limit to the number of characters.

Label

STATEread more

Name: disabled

Boolean Property

--y-label__disabled

This property can disable or enable the disabled-state of the Label-component.

Links

LABELread more

Name: sourceLabel

String Property

--y-label__source-label

This property defines a link to another component by specifying the componentId or componentName, Page, Component, ID, Event. The data from the link will represent the label to be displayed.

Events

LIFECYCLEread more

Name: EvtInit

String Property

--y-label__-evt-init

This specifies the function to be called, when the Label is initialized.

INPUTread more

Name: EvtClicked

String Property

--y-label__-evt-clicked

The event that is triggered when clicking inside the input field.

Usage

In this section you will find a collection of application scenarios and examples that illustrate how to leverage the yLabel in ways that deviate from its standard behavior, as defined by yBase. This section aims to inspire and guide you through various possibilities, helping you to implement more complex or unique functionalities tailored to your specific needs. General properties that are universally applicable can be found in the yBase usage section.

Variations

Elevated

Flat

Outlined

Rounded

Plain

Elevated

genericarrow_forward_iossizearrow_forward_iosminWidth95px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normal#44ddbb

stylearrow_forward_iosshadowarrow_forward_iosboxShadow__normal0 3px 6px 0 rgba(16, 18, 24, 0.2)

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#FFFFFF

Flat

genericarrow_forward_iossizearrow_forward_iosminWidth95px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#FFFFFF

Outlined

genericarrow_forward_iossizearrow_forward_iosminWidth95px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normaltransparent

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderStyleTop__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderStyleRight__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderStyleBottom__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderStyleLeft__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderWidthTop__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderWidthRight__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderWidthBottom__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderWidthLeft__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderColorTop__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderColorRight__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderColorBottom__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderColorLeft__normal#44ddbb

Rounded

genericarrow_forward_iossizearrow_forward_iosminWidth95px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normal#44ddbb

stylearrow_forward_iosshadowarrow_forward_iosboxShadow__normal0 3px 6px 0 rgba(16, 18, 24, 0.2)

stylearrow_forward_iosborderarrow_forward_iosborderRadius20px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#FFFFFF

Plain

genericarrow_forward_iossizearrow_forward_iosminWidth95px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normaltransparent

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#44ddbb

Linking Input Elements

You can establish a connection between the yLabel component and another component using a SourceLink Picker. In this example, the yLabel component is linked to a yInput component. Whenever the value in the yInput is changed, the connected yLabel component will update accordingly.

How to:

1. Open the Detail Panel and go to the Links tab to unfold the Label section.
2. Select the previously created yInput and create a new SourceLink, which should look something like: y-page:1:y-input:2:input-string.

That's it! You can now test this functionality by entering the preview mode and typing the desired text into the yInput component. The yLabel component should update accordingly.

Before

info

If you want to include text before or after the input value, you can add it in Style > Label > Label. To display the input value, use {value} as a placeholder.

After

Displaying Table Data

You can also establish a connection between the yLabel component and the yTable via SourceLink. In this example, the yLabel component is linked to specific column of the yTable. Whenever the selected row changes, the yLabel will update accordingly.

How to:

1. Create a yTable in your application.
2. Open the Detail Panel of the yLabel and navigate to Links to unfold the Label group to edit Source-Label. Now, there are two options:
   1. Select the previously created yTable and select a specific row in Collection/Buffer Property.
   2. Or select the previously created yTable, leave the Collection/Buffer Property empty.
3. Change Style > Label > Label. Here, you also have the option to include custom text, like this template-string: Hello {value}!".

Now, in the preview mode, when you click on a row in the yTable, the yLabel component will update accordingly.