Overflow - ZoboUI Docs

The Overflow utility allows you to manage how elements handle content that surpasses their dimensions.

Utility Class	USS Properties
overflow-hidden	overflow: hidden;
overflow-visible	overflow: visible;

Basic Usage in UXML

To use the Overflow utility, add the desired class to your UI element. For instance, to hide overflowing content, you would add the overflow-hidden class to your element. This can be particularly useful in containers where the overflow should not disrupt the layout or design, such as in scroll views or panels with fixed dimensions.

Conversely, overflow-visible might be used in scenarios where you want to ensure that no content is clipped, such as with dropdown menus or tooltips that might extend beyond their parent containers.

<ui:VisualElement class="overflow-hidden">
    <!-- Content that exceeds the size of this element will be clipped and not visible -->
</ui:VisualElement>
<ui:VisualElement class="overflow-visible">
    <!-- Content that exceeds the size of this element will be visible -->
</ui:VisualElement>

Customize

Modifier Variations

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

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

overflow : overflow

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