The '''ScrollRect''' component is for making the contents of this [[Slot]] (such as child objects with [[Component:RectTransform|RectTransforms]]) scrollable.
'''ScrollRect''' is a component for making a child with a [[RectTransform (Component)|RectTransform]] scroll.
The scrollRect will not do any clipping on its own. If it is a child of an object with a [[Component:Mask|Mask]] component, it effectively becomes a window into the scrolled content.
ScrollRect will not do any clipping on its own. If it is a child of an object with a [[Mask (Component)|Mask]] component, it effectively becomes a window into the scrolled content.
{{Note|It is recommended to use a [[Component:ContentSizeFitter|ContentSizeFitter]] component and setting the <code>VerticalFit</code> to <code>MinSize</code> when combined with a scrollrect to help fit it within a [[Component:RectTransform|RectTransform]].|suggestion}}
<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|NormalizedPosition|Float2|The scroll position between (0,0) and (1,1) with (0,0) being the lower left corner.
|NormalizedPosition|Float2|The scroll position between (0,0) and (1,1) with (0,0) being the lower left corner.
|HorizontalAlign|LayoutHorizontalAlignment|
|HorizontalAlign|LayoutHorizontalAlignment|Aligns the scrollrect's contents horizontal.
|VerticalAlign|LayoutVerticalAlignment|
|VerticalAlign|LayoutVerticalAlignment|Aligns the scrollrect's contents vertically.
|ViewportOverride|RectTransform|
|ViewportOverride|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv3=true|Overrides the viewport of this scrollrect.
|__legacyContent|RectTransform|
|__legacyContent|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv4=true|Internal - Used for the content of the scrollrect.
}}
== Sync Delegates ==
{{Table ComponentTriggers
|MoveToTop:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Moves the scroll view to the top.
|MoveToBottom:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Mobes the scroll view to the bottom.
|MoveToLeft:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Moves the scroll view to the left.
|MoveToRight:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Moves the scroll view to the right.
}}
}}
<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
This is useful when you have a lot of text or other [[UIX]] elements that you want to be scrollable, much like how a webpage has a lot of content that can't fit in just one screen.
<!--T:5-->
<!--T:5-->
== Examples ==
== Examples ==
=== Videos ===
[[User:ProbablePrime|ProbablePrime]]'s tutorial video on the scrollrect component:
The ScrollRect component is for making the contents of this Slot (such as child objects with RectTransforms) scrollable.
The scrollRect will not do any clipping on its own. If it is a child of an object with a Mask component, it effectively becomes a window into the scrolled content.
It is recommended to use a ContentSizeFitter component and setting the VerticalFit to MinSize when combined with a scrollrect to help fit it within a RectTransform.
This is useful when you have a lot of text or other UIX elements that you want to be scrollable, much like how a webpage has a lot of content that can't fit in just one screen.
Examples
Videos
ProbablePrime's tutorial video on the scrollrect component:
