Text Overflow - ZoboUI Docs

The Text Overflow utility is used to specify how overflowed text content that is not displayed should be signaled to the user. This can be particularly useful for elements with constrained space where the full text content cannot be displayed.

Utility Class	USS Properties
text-overflow-clip	text-overflow: clip;
text-overflow-ellipsis	text-overflow: ellipsis;

Usage in UXML

To use the Text Overflow utility, simply apply the desired class to your UI elements.

Clipping Overflowed Text

Use text-overflow-clip to clip the text without indicating the presence of additional content.

<ui:Label class="text-overflow-clip">
  This is a long text that will be clipped at the edge of the container without displaying an ellipsis.
</ui:Label>

Displaying Ellipsis for Overflowed Text

Apply text-overflow-ellipsis to show an ellipsis where the text is cut off.

<ui:Label class="text-overflow-ellipsis">
  This is a long text that will display an ellipsis to indicate more content.
</ui:Label>

Customize

Modifier Variations

You can customize which modifier variations of the Text Overflow utility are generated, such as pseudo-classes (e.g., hover, focus) and custom modifiers.

By default, no modifier variations are defined for the Text Overflow utility.

By fine-tuning the utility variations, you maintain control over your stylesheet's size and complexity, ensuring that only necessary styles are included. To update these values:

Open the Theme Config Asset: Find the asset within your Unity project.
Navigate to the 'Utilities' Section: Locate the Text Overflow utility.
Adjust Modifier Variations: Select which modifiers you want to be generated for the utility. Keep in mind that the order of the modifiers will affect the order and specificity of the generated USS classes.

Class Tags and Properties

The Text Overflow utility generates classes based on predefined tags and their associated USS properties. While we recommend keeping these defaults for consistency and ease of reference in our documentation, you have the option to customize them to suit your project's specific needs.

These values are prepended to the defined values in this format tag-{value}. If a tag is empty, the generated class will simply be the value by itself.

Here are the default tags and the USS properties they set for the Text Overflow utility:

text-overflow : text-overflow

To customize these tags and properties, you can edit the Tag Property Map field for the Text Overflow utility in the Theme Config asset. This allows you to define new tags or modify existing ones, thus tailoring the generated classes to your preferences.

Extending Core Fields

The Text Overflow utility does not extend any fields from the Core section of the Theme Config asset. Before you try to extend any fields, we recommend checking Unity's documentation to verify which types of values are expected by the relevant USS properties.

To customize or define these extended fields:

Open the Theme Config Asset: Locate the asset within your Unity project.
Navigate to the 'Utilities' Section: Find the Text Overflow utility.
Customize Extend Fields: Modify or add fields in the Extend Fields array to change the core configuration values that are extended. You'll only be able to extend fields of the same type.

Disable Utility

The Text Overflow utility is enabled by default. You can disable it by unchecking the Enabled option in the Theme Config asset. This will prevent the generation of the utility's styles.