Flex Wrap - ZoboUI Docs

The Flex Wrap utility is crucial for managing the layout of children in a flex container, especially when there isn't enough space on a single line. It determines how children are placed over multiple lines in such scenarios.

Utility Class	USS Properties
flex-wrap	flex-wrap: wrap;
flex-wrap-reverse	flex-wrap: wrap-reverse;
flex-nowrap	flex-wrap: nowrap;

Implementing Flex Wrap in UXML

Enabling Wrap

This class makes items wrap onto multiple lines when necessary.

<ui:VisualElement class="flex-wrap">
    <!-- Child elements will wrap onto multiple lines as needed -->
</ui:VisualElement>

Enabling Wrap Reverse

This causes items to wrap onto multiple lines in reverse order.

<ui:VisualElement class="flex-wrap-reverse">
    <!-- Child elements will wrap onto multiple lines in reverse order -->
</ui:VisualElement>

Disabling Wrap

This prevents wrapping, keeping all items in a single line.

<ui:VisualElement class="flex-nowrap">
    <!-- Child elements will not wrap onto multiple lines -->
</ui:VisualElement>

Customize

Modifier Variations

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

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

flex : flex-wrap

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