Skip to content

Commit 7c84c58

Browse files
GridRawImage control documentation
Updated formatting for sections
1 parent 0b6a161 commit 7c84c58

24 files changed

+846
-14
lines changed

Controls.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ This page lists all the available controls within the UI Extensions project. To
3131
|**[Stepper](/Controls/Stepper.md)** | A stepper control, like those found in iOS. It's basically two buttons side by side, and can step its numeric value up and down || UI / Extensions / Stepper ||| David Gileadi|
3232
|**[Range Slider](/Controls/RangeSlider.md)** | A slider control that can support range values with min/max | UI / Extensions / Range Slider | UI / Extensions / Range Slider|[Demo video](/Controls/Images/RangeSliderDemo.mp4)|| Ben MacKinnon @Dover8|
3333
|**[MinMaxSlider](/Controls/MinMaxSlider.md)** | An alternative slider control that can support range values with min/max | UI / Extensions / MinMax Slider | UI / Extensions / MinMax Slider||| brogan89|
34+
|**[Extensions Toggle](/Controls/ExtensionsToggle.md)** | Enhanced Toggle component with unique IDs and dual event system || UI / Extensions / Extensions Toggle ||| Unity UI Extensions Contributors|
35+
|**[Extensions Toggle Group](/Controls/ExtensionsToggleGroup.md)** | Enhanced ToggleGroup managing ExtensionsToggle components || UI / Extensions / Extensions Toggle Group ||| Unity UI Extensions Contributors|
36+
|**[Segment](/Controls/Segment.md)** | Individual segment component within SegmentedControl || UI / Extensions / Segmented Control / Segment ||| David Gileadi|
3437

3538
## Primitives
3639

@@ -41,6 +44,7 @@ This page lists all the available controls within the UI Extensions project. To
4144
|**[UILineRenderer](/Controls/UILineRenderer.md)** | Graphic control for drawing lines in the UI System | UI / Extensions / Primitives / UI Line Renderer | UI / Extensions / Primitives / UI Line Renderer |[tutorial video](https://www.youtube.com/watch?v=OElcWAZGHi0)|| jack.sydorenko|
4245
|**[UILineTextureRenderer](/Controls/UILineTextureRenderer.md)** | Graphic control for drawing lines in the UI System | UI / Extensions / Primitives / UI Line Texture Renderer | UI / Extensions / Primitives / UI Line Texture Renderer |[tutorial video](https://www.youtube.com/watch?v=OElcWAZGHi0)|| jack.sydorenko, jonbro5556|
4346
|**[UILineRendererFIFO](/Controls/UILineRendererFIFO.md)** | High Performant version of the Graphic control for drawing lines in the UI System | UI / Extensions / Primitives / UILineRendererFIFO | UI / Extensions / Primitives / UILineRendererFIFO ||| Steve Westhoff|
47+
|**[UILineRendererList](/Controls/UILineRendererList.md)** | Advanced line renderer with Bezier curves, configurable joins, and line caps | UI / Extensions / Primitives / UI Line Renderer List | UI / Extensions / Primitives / UILineRendererList ||| jack.sydorenko, firagon|
4448
|**[UICircle](/Controls/UICircle.md)** | Graphic control for drawing circles in the UI System | UI / Extensions / Primitives / UI Circle | UI / Extensions / Primitives / UI Circle |[tutorial video](https://www.youtube.com/watch?v=2KOnEKAVua0)|| zge|
4549
|**[DiamondGraph](/Controls/DiamondGraph.md)** | Graphic control for drawing a diamond in the UI System | UI / Extensions / Primitives / DiamondGraph | UI / Extensions / Primitives / DiamondGraph |5.2+ only [tutorial video](https://www.youtube.com/watch?v=2KOnEKAVua0)|| koohddang|
4650
|**[UICornerCut](/Controls/UICornerCut.md)** | Graphic control for drawing a diamond in the UI System | UI/Extensions/Primitives/Cut Corners | UI/Extensions/Primitives/Cut Corners ||| Freezy|
@@ -93,6 +97,7 @@ This page lists all the available controls within the UI Extensions project. To
9397
|**[UIFlippable](/Controls/UIFlippable.md)** | Image component effect to flip the graphic | UI / Effects / Extensions / UI Flippable ||| ChoMPHi|
9498
|**[UIImageCrop](/Controls/UIImageCrop.md)** | Shader based mask system which clips to specific ranges X&Y | UI / Effects / Extensions / UI Image Crop ||| 00christian00|
9599
|**[SoftAlphaMask](/Controls/SoftAlphaMask.md)** | Shader based mask able to clip images using an alpha mask | UI / Effects / Extensions / Soft Mask Script ||[Donate](https://www.assetstore.unity3d.com/en/#!/content/50339)| NemoKrad|
100+
|**[Shader Effects Suite](/Controls/ShaderEffects.md)** | Collection of shader-based effects (Additive, Soft Additive, Multiply, Linear Dodge, Screen, Shine) | UI / Effects / Extensions / UI*Effect | UI / Effects / Extensions / UI*Effect and Shining Effect || 00christian00, ömer faruk sayılır|
96101
|**[UIParticleSystem](/Controls/UIParticleSystem.md)** | Implementation of a particle system on a canvas | UI / Effects / Extensions / UI Particle System |5.3+ only|| Glennpow|
97102
|**[CurlyUI](/Controls/CurlyUI.md)** | A UI Effect that will make your UI Curly | UI / Effects / Extensions / CUI*** ||| Titinious|
98103

@@ -119,7 +124,6 @@ The following components have been deprecated for Unity 6 (Version 3.0.0) and ar
119124
|**[LetterSpacing](/Controls/LetterSpacing.md)**|Text component deprecated by Unity|Use TextMeshPro character spacing|Deeperbeige|
120125
|**[MonoSpacing](/Controls/MonoSpacing.md)**|Text component deprecated by Unity|Use TextMeshPro character spacing|Herbst|
121126
|**[NicerOutline](/Controls/NicerOutline.md)**|Text component deprecated by Unity|Use TextMeshPro outline|Melang|
122-
|**[BestFitOutline](/Controls/BestFitOutline.md)**|Text component deprecated by Unity|Use TextMeshPro outline|Melang|
123127
|**[VRInputModule](/Controls/VRInputModule.md)**|Obsolete VR input system|Use Unity's XR Interaction Toolkit|N/A|
124128
|**[VRCursor](/Controls/VRCursor.md)**|Obsolete VR input system|Use Unity's XR Interaction Toolkit|N/A|
125129
|**[AimerInputModule](/Controls/AimerInputModule.md)**|Obsolete input system|Use Unity's new Input System|N/A|
@@ -135,6 +139,7 @@ The following components have been deprecated for Unity 6 (Version 3.0.0) and ar
135139

136140
|Component | Description | Component Command | Notes | Donate | Credits
137141
|-|-|-|-|-|-|
142+
|**[InputFieldEnterSubmit](/Controls/InputFieldEnterSubmit.md)** | Automatically submits InputField when Enter key is pressed | UI / Extensions / Input Field Submit ||| Vicente Russo|
138143
|**[ReturnKeyTrigger](/Controls/ReturnKeyTrigger.md)** | Enables you to bind the return key within an InputField control to a button | UI / Extensions / ReturnKey Trigger ||| Melang|
139144
|**[TabNavigation](/Controls/TabNavigation.md)** | An example Tab navigation script, updated to add manual navigation | UI / Extensions / Tab Navigation ||| Melang, omatase|
140145
|**[uGUITools](/Controls/uGUITools.md)** | | Menu / uGUI ||| Senshi|

Controls/Accordion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ A menu style control with pop-out sub elements like a hover bar.
3737
The Accordion setup uses two components:
3838

3939
Property | Description
40-
|-|-|
40+
-|-
4141
*Transition*|Tween type used when expanding/collapsing elements.
4242
*Transition Duration*|Time (seconds) for expand/collapse.
4343
*Allow Multiple*|If true, multiple accordion elements can stay open simultaneously.

Controls/AutoCompleteComboBox.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ A specialised text field that allows a vocabulary to be added to guide or restri
3939
The properties of the AutoComplete Combobox control are as follows:
4040

4141
Property | Description
42-
|-|-|
42+
-|-
4343
*Available Options*|Array of text based options for the dropdown/selection.
4444
*Is Active*|Can the autocomplete combo box be activated by the user (dropped down) or is it disabled?
4545
*Scroll Bar Width*|The width of the scrollbar when displayed.

Controls/BestFitOutline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Provides a simple way to add an outline to your UI component, be it an image or
4242
The properties of the Best Fit Outline component are as follows:
4343

4444
Property | Description
45-
|-|-|
45+
-|-
4646
*Status*|Deprecated and removed in Unity 6; no configurable properties remain
4747
*Recommended Alternative*|Use TextMeshPro materials/shaders for outline effects in modern projects
4848

Controls/BoundToolTip.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ A tooltip implementation which uses a manager to control the tooltip appearance,
3939
The properties of the Bound Tooltip Item control are as follows:
4040

4141
Property | Description
42-
|-|-|
42+
-|-
4343
*Tooltip Text*|The TextMeshPro text component that will display the tooltip content
4444
*Tool Tip Offset*|Vector3 offset from the trigger position where the tooltip will appear
4545

@@ -48,7 +48,7 @@ Property | Description
4848
The properties of the Bound Tooltip Trigger control are as follows:
4949

5050
Property | Description
51-
|-|-|
51+
-|-
5252
*Text*|The tooltip text to display when this trigger is activated
5353
*Use Mouse Position*|When enabled, tooltip appears at mouse position instead of trigger position
5454
*Offset*|Vector3 offset from the trigger position (used when Use Mouse Position is false)

Controls/BoxSlider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Like the Slider, it also includes an OnValueChanged event which updates as the h
4444
The properties of the Box Slider control are as follows:
4545

4646
Property | Description
47-
|-|-|
47+
-|-
4848
*Handle Rect*|The Rect Transform of the child handle, position used to derive values for control
4949
*Min Value*|The minimum value for the sliders
5050
*Max Value*|The maximum value for the sliders

Controls/CardUI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The range of Card UI controls give you several options for creating card like UI
5555
The Card UI suite includes several prefabs and behaviours. Key shared inspector settings include:
5656

5757
Property | Description
58-
|-|-|
58+
-|-
5959
*Card Prefab(s)*|Prefabs for the chosen card style (2D popup, 2D stacked, 3D superellipse, etc.).
6060
*Animation Duration*|Time (seconds) for expand/collapse or popup animations.
6161
*Spacing / Stack Offset*|Gap or depth offset between cards in a stack.

Controls/ColorPicker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Manages saving/loading presets to a JSON file or player prefs.
6161
Example found on the *Picker 2.0* prefab.
6262

6363
Property | Description
64-
|-|-|
64+
-|-
6565
*Sampler* (button) |The cursor's button component.
6666
*Sampler Outline* (outline) |The outline of the cursor to make it easier to see what's being sampled.
6767
***On Color Selected*** (event) |Callback for when the cursor is clicked on a color. This should connect to the ColorPickerControl.CurrentColor at minimum.
@@ -72,7 +72,7 @@ Example found on the *Picker 2.0* prefab.
7272
The properties of the Box Slider control are as follows:
7373

7474
Property | Description
75-
|-|-|
75+
-|-
7676
***On Value Changed*** (event) |The Event fired when the color within the picker is changed
7777
*HSV sliders on* (bool) |Shows / hides the HSV sliders in te UI prefab.
7878
*HSV Sliders* (GameObject array) |Contains references to the components that are part of the HSV sliders display.
@@ -85,7 +85,7 @@ Property | Description
8585
Example found on the *Picker 2.0 / Presets* prefab.
8686

8787
Property | Description
88-
|-|-|
88+
-|-
8989
*Picker* (ColorPickerControl)| Reference to the color picker control.
9090
*Preset Prefab* (GameObject)| UI component for displaying the preset(s).
9191
*Max Presets* (int)| The max number of presets allowed (to control the UI size).

Controls/ComboBox.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Similar to the new built in Unity Dropdown control
4040
The properties of the Combo Box control are as follows:
4141

4242
Property | Description
43-
|-|-|
43+
-|-
4444
*Available Options*|Array of text based options for the dropdown/selection
4545
*Is Active*|Can the autocomplete combo box be activated by the user (dropped down) or is it disabled?
4646
*Scroll Bar Width*|The width of the scrollbar when displayed

Controls/ContentScrollSnapHorizontal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ the scroll snap has finished snapping.
4747
The properties of the Horizontal Scroll Snap control are as follows:
4848

4949
Property | Description
50-
|-|-|
50+
-|-
5151
*Ignore Inactive Items*|When enabled the scroll snap ignores inactive items, when disabled the scroll snap will snap to inactive items.
5252
*Start Info*|All information about where the scroll snap should start when it is enabled, and how it should get there.
5353
*Index Type*|A property of Start Info which describes whether the Index is associated with the child at that index, or the position at that index. A higher Index where the Index Type is Position Index means it will be further to the right.

0 commit comments

Comments
 (0)