Visibility - ZoboUI Docs

The Visibility utility allows you to control whether elements within your UI are visible or hidden. This utility is particularly useful for toggling the visibility of elements without removing them from the document flow, meaning they still occupy their designated space in the layout even when not visible.

Utility Class	USS Properties
visible	visibility: visible;
invisible	visibility: hidden;

Making an Element Visible

To ensure an element is visible, use the visible class. This class sets the element's visibility to visible, making it appear in the UI.

<ui:VisualElement class="visible">
  <!-- This element is explicitly set to be visible -->
</ui:VisualElement>

Making an Element Invisible

To hide an element, apply the invisible class. This sets the element's visibility to hidden, rendering it invisible in the UI, yet it continues to occupy space in the layout.

<ui:VisualElement class="invisible">
  <!-- This element is hidden, but still occupies space in the layout -->
</ui:VisualElement>

Customize

Modifier Variations

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

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

No Tag : visibility

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