View source for Label control

<section begin="main content" />
The label control is used for displaying text in Kodi. You can choose the font, size, colour, location and contents of the text to be displayed.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
  <control type="label" id="1">
        <description>My First label</description>
        <left>80</left>
        <top>60</top>
        <width>250</width>
        <visible>true</visible>
        <align>center</align>
        <aligny>center</aligny>
        <scroll>false</scroll>
        <label fallback="$LOCALIZE[123]">$INFO[MusicPlayer.Artist]</label>
        <angle>30</angle>
        <haspath>false</haspath>
        <font>font14</font>
        <textcolor>FFB2D4F5</textcolor>
        <shadowcolor>ff000000</shadowcolor>
        <wrapmultiline>false</wrapmultiline>
        <scrollspeed>50</scrollspeed>
        <scrollsuffix> - </scrollsuffix>
  </control>
</syntaxhighlight>

=== Auto size labels ===

Wrapping your label in a grouplist with the auto width and appropriate minimum and maximum values, allows the labels width to dynamically change relevant to how long the label text is. This allows an image or other control to be aligned to the right of the actual label text no matter how wide the label is.

<syntaxhighlight lang="XML" enclose="div">
   <width min="29" max="200">auto</width>
</syntaxhighlight>

Also, simply specifying <width>auto</width> is also supported.

=== Multi-line labels ===
If you want your label control to span multiple lines, you can insert a new line character in your label. For example:

<syntaxhighlight lang="XML" enclose="div">
   <label>This will be on the first line[CR]And this will be on the second line</label>
</syntaxhighlight>

Also, if you want your label control to conform to the <width> parameter, but still want to be able to give it more content than will fit on one line, then setting:

<syntaxhighlight lang="XML" enclose="div">
   <wrapmultiline>true</wrapmultiline>
</syntaxhighlight>
will cause the text to be cut up (at the spaces in the text) onto multiple lines. Note that if a single word is larger than <width> then it will not be cut, and will still overflow.

=== Available tags ===
In addition to the '''[[Default Control Tags]]''' the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case'''-'''sensitive.

{| class="prettytable"
! Tag
! Description
|-
! align
| Can be left, right, or center. Aligns the text within the given label <code><width></code>. Defaults to left
|-
! aligny
| Can be top or center. Aligns the text within its given label <code><height></code>. Defaults to  top
|-
! scroll
| When true, the text will scroll if longer than the label's <code><width></code>. If false, the text will be truncated. Defaults to false.
|-
! label
| Specifies the text which should be drawn. You should specify an entry from the strings.po here (either the Kodi strings.po or your skin's strings.po file). The fallback attribute will be used when the infolabel returns empty. You can use the full [[Label Formatting|label formatting syntax]] and [[Label Parsing|you may also specify more than one piece of information here by using the $INFO and $LOCALIZE formats.]]
|-
! info
| Specifies the information that should be presented. Kodi will <span class="nobr">auto-fill</span> in this info in place of the <code><label></code>. [[InfoLabels|See here for more information.]]
|-
! number
| Specifies a number that should be presented. This is just here to allow a skinner to use a number rather than a text label (as any number given to <code><label></code> will be used to lookup in strings.po)
|-
! angle
| The angle the text should be rendered at, in degrees. A value of 0 is horizontal.
|-
! haspath
| Specifies whether or not this label is filled with a path. Long paths are shortened by compressing the file path while keeping the actual filename full length.
|-
! font
| Specifies the font to use from the font.xml file.
|-
! textcolor
| Specifies the color the text should be, in hex AARRGGBB format, or a name from the [[Colour themes|colour theme.]]
|-
! shadowcolor
| Specifies the color of the drop shadow on the text, in AARRGGBB format, or a name from the [[Colour themes|colour theme.]]
|-
! wrapmultiline
| If true, any text that doesn't fit on one line will be wrapped onto multiple lines.
|-
! scrollspeed
| Scroll speed of text in pixels per second. Defaults to 60.
|-
! scrollsuffix
| Specifies the suffix used in scrolling labels. Defaults to " <nowiki>|</nowiki> ".
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]