Text Shadow - ZoboUI Docs

The Text Shadow utility allows you to add shadow effects to text, enhancing legibility or creating a stylistic text appearance.

Utility Class	USS Properties
text-shadow-none	text-shadow: 0 0 #000;
text-shadow-sm	text-shadow: 0 1px 2px var(--zb-text-shadow-color);
text-shadow	text-shadow: 0 2px 4px var(--zb-text-shadow-color);
text-shadow-md	text-shadow: 0 4px 8px var(--zb-text-shadow-color);
text-shadow-lg	text-shadow: 0 8px 16px var(--zb-text-shadow-color);

Basic Usage in UXML

To add a text shadow to an element, add one of the text-shadow classes to the element's class attribute.

<ui:Label class="text-shadow">
  <!-- Text with default shadow -->
</ui:Label>
<ui:Label class="text-shadow-none">
  <!-- Text with no shadow -->
</ui:Label>

Customize

Modifier Variations

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

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

text-shadow : text-shadow

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