You can instantiate existing UXML Documents as Templates inside your UXML Documents as Template Instances, similar to how Prefabs work in Unity.
To use an existing UXML Document in your project as a template, do the following:
.uxml
) you wish to instantiate.A Template Instance appears in the Hierarchy like a normal element of type TemplateContainer
. The name of the .uxml
file displays as greyed font to the right of its name. If you expand the Template Instance, you can see the internal hierarchy of the instance. This internal hierarchy, as explained in Working with elements, is read-only and only for reference.
You can make a Sub-Document within a UXML Document as a Template Instance, so you can reuse it.
This also instantiates the Sub-Document as Template Instances in the existing document.
To edit an original UXML Document used as a Template Instance, right-click on a Template Instance, and select one of the following options:
Open in UI Builder: Unload the current UXML Document, and load the Template Instance:
Open Instance in Isolation: Keep the current UXML Document loaded in the background while loading Template Instance. The Hierarchy and the Canvas only display the contents of the Template Instance, and the StyleSheets pane includes the style sheet of the background parent UXML Document in a read-only state. This is because the style sheets are still being applied to the Template Instance:
Open Instance in Context: Keep the current UXML Document loaded while making all its elements read-only and appear dimmed in the Hierarchy and the Canvas. You can edit the contents of the Template Instance within the context of the parent UXML Document. Use this option to update Template Instance content without losing the context of the host document:
Show in Project: Show the location of the Template Instance file in the Project window.
For the second and third options, a breadcrumb appears above the Viewport. You can use the breadcrumb to go back to a parent UXML Document.
To unpack a single Template Instance, right-click on a Template Instance and select Unpack Instance. This changes Template Instance to a normal UXML Document.
To unpack all the Template Instances, right-click on a Template Instance and select Unpack Instance Completely. This changes all the Template Instances to normal UXML Documents.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.