Utilities

Whitespace

The Whitespace utility offers control over how text is wrapped and spaced within an element, affecting readability and text layout. It is particularly useful for adjusting how text content responds to space constraints within an element.

Utility Class
USS Properties
whitespace-normal
white-space: normal;
whitespace-nowrap
white-space: nowrap;

Basic Usage in UXML

Normal

This default setting allows text to wrap naturally onto the next line when it exceeds the width of its container. Sequential white space characters are consolidated, and new lines in the content behave like any other white space.

<ui:Label class="whitespace-normal">
    <!-- Text within this label wraps normally -->
</ui:Label>

No Wrap

Disables text wrapping. Content will extend in a single line regardless of the element's width, potentially overflowing its container if too long. White space is still collapsed to a single character, but line breaks are ignored.

<ui:Label class="whitespace-nowrap">
  <!-- Text within this label does not wrap -->
</ui:Label>

Customize

Modifier Variations

Modifier Variations

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

By default, no modifier variations are defined for the Whitespace 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:

  1. Open the Theme Config Asset: Find the asset within your Unity project.
  2. Navigate to the 'Utilities' Section: Locate the Whitespace utility.
  3. 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

Class Tags and Properties

The Whitespace 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 Whitespace utility:

  • whitespace : white-space

To customize these tags and properties, you can edit the Tag Property Map field for the Whitespace 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 Whitespace 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:

  1. Open the Theme Config Asset: Locate the asset within your Unity project.
  2. Navigate to the 'Utilities' Section: Find the Whitespace utility.
  3. 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 Whitespace 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.

Previous
Visibility
Next
Width