You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _auto_docs/rish/01-installation.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -113,4 +113,4 @@ public partial class App : IApp
113
113
{% endhighlight %}
114
114
115
115
## Next Steps
116
-
Now that you have the library installed, we recommend installing [**Roots**](/docs/roots/1.0.0/quick-start) and importing its samples to see working code in action.
116
+
Now that you have the library installed, we recommend installing [**Roots**](/docs/roots/quick-start) and importing its samples to see working code in action.
<p>Favor <strong>USS stylesheets</strong> (via <code>className</code>) over inline styles. Unity optimizes stylesheets better (and supports live reloading of USS assets) and it keeps your style and layout logic separate from your code.</p>
71
+
<p>Favor <strong>USS style sheets</strong> (via <code>className</code>) over inline styles. Unity optimizes style sheets better (and supports live reloading of USS assets) and it keeps your style and layout logic separate from your code.</p>
72
72
<p>Use <strong>Inline Styles</strong> only when the style depends on dynamic data from Props or State.</p>
Copy file name to clipboardExpand all lines: _docs/rish/3.0.0/01-installation.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,9 +7,9 @@ sections:
7
7
icon: download
8
8
---
9
9
10
-
Installing Rish is simple. You can add the package via the Unity Package Manager using the Git URL, or by modifying your manifest.json file directly.
10
+
Installing Rish is simple. You can add the package via the Unity Package Manager using the Git URL, or by modifying your `manifest.json` file directly.
11
11
12
-
Add the following package URL: `https://github.com/clockworklabs/rish#[target-version]`
12
+
Add the following package URL: `https://github.com/clockworklabs/rish#[target-version]`.
13
13
14
14
#### Dependencies
15
15
Rish requires the following dependencies to function correctly:
@@ -52,6 +52,7 @@ To set up a Rish App in your scene:
52
52
2. Add the `RishRoot` component to it. This will automatically add a `UIDocument` component if one is missing.
53
53
3. Assign your **Panel Settings** to the `UIDocument`.
54
54
4. Create a class that implements `IApp` and assign it to the `RishRoot`.
55
+
5. Assign all the USS style sheets your app will need to the `RishRoot`.
55
56
56
57
### Defining an App
57
58
A Rish App is the entry point for your UI. It is not an Element itself; rather, it defines the root element for the entire tree.
@@ -113,4 +114,4 @@ public partial class App : IApp
113
114
{% endhighlight %}
114
115
115
116
## Next Steps
116
-
Now that you have the library installed, we recommend installing [**Roots**](/docs/roots/1.0.0/quick-start) and importing its samples to see working code in action.
117
+
Now that you have the library installed, we recommend installing [**Roots**](/docs/roots/quick-start) and importing its samples to see working code in action.
<p>Favor <strong>USS stylesheets</strong> (via <code>className</code>) over inline styles. Unity optimizes stylesheets better (and supports live reloading of USS assets) and it keeps your style and layout logic separate from your code.</p>
71
+
<p>Favor <strong>USS style sheets</strong> (via <code>className</code>) over inline styles. Unity optimizes style sheets better (and supports live reloading of USS assets) and it keeps your style and layout logic separate from your code.</p>
72
72
<p>Use <strong>Inline Styles</strong> only when the style depends on dynamic data from Props or State.</p>
Copy file name to clipboardExpand all lines: _docs/roots/1.0.0/00-quick-start.md
+13-1Lines changed: 13 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,19 @@
2
2
title: Quick Start
3
3
slug: quick-start
4
4
sections:
5
+
- Why Roots?
5
6
icon: handshake
6
7
---
7
8
8
-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque finibus condimentum nisl id vulputate. Praesent aliquet varius eros interdum suscipit. Donec eu purus sed nibh convallis bibendum quis vitae turpis. Duis vestibulum diam lorem, vitae dapibus nibh facilisis a. Fusce in malesuada odio.
9
+
Roots is a UI toolkit built on top of [Rish](/docs/rish/quick-start). Rish is very thin and provides no elements out of the box. Roots is a great foundation for your UI app.
10
+
11
+
## Setup
12
+
13
+
14
+
15
+
16
+
It provides
17
+
- Unity Components to structure and setup your Rish App.
18
+
- Low-level abstract elements.
19
+
- High-level reference or starting-point elements.
Copy file name to clipboardExpand all lines: _docs/roots/1.0.0/01-installation.md
+28-1Lines changed: 28 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,4 +8,31 @@ sections:
8
8
icon: download
9
9
---
10
10
11
-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque finibus condimentum nisl id vulputate. Praesent aliquet varius eros interdum suscipit. Donec eu purus sed nibh convallis bibendum quis vitae turpis. Duis vestibulum diam lorem, vitae dapibus nibh facilisis a. Fusce in malesuada odio.
11
+
Installing Roots is simple. You can add the package via the Unity Package Manager using the Git URL, or by modifying your `manifest.json` file directly.
12
+
13
+
Add the following package URL: `https://github.com/clockworklabs/roots#[target-version]`.
14
+
15
+
#### Dependencies
16
+
Roots requires the following dependencies to function correctly:
Roots requires minimal setup for all of its moving parts to work:
22
+
1. Add `RootsSetup` component to the GameObject that contains your App's `RishRoot`.
23
+
- This component is only needed to use the more advanced `ResponsiveStyleSheets`.
24
+
2. Add an `AssetsLoader` component to bridge between your app's assets pipeline and your UI app.
25
+
-`AssetsLoader` is an abstract class. Roots provides a `ResourcesLoader` implementation that loads assets from Resources. You can implement your own loader that works for your app.
26
+
3. Animated elements use [Motion](https://github.com/clockworklabs/motion). For your motions to be stepped, add a `MotionAutoUpdate` component (in more advanced scenarios, you may want to manually call `DoMotion.Step`).
27
+
28
+
## Samples
29
+
Roots comes with samples showing a wide range of UI Elements (from simple buttons to complex scroll views or responsive layouts).
30
+
31
+
1. Open the **Package Manager**.
32
+
2. Select the **Roots** package.
33
+
3. Go to the **Samples** tab and import **Rootstrap** and **Samples**.
34
+
4. Open the newly imported `Samples` scene and enter Play Mode.
35
+
36
+
The Samples scene supports changing the dimensions of the samples container to interact with responsive elements. It also has a button to see the relevant code for each sample.
0 commit comments