Component:Hyperlink: Difference between revisions

Latest revision as of 18:06, 13 November 2024

Component image

The Hyperlink component allows you to turn an object with a collider into a clickable link that will prompt the user in Userspace to open the provided link in their default web browser.

This component requires the start to contain http://, ws://, or something similar at the beginning of the URL, or this component will not prompt for a connection.

Example for connecting to the local host of the device: http://localhost:5000

Fields

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled.
`URL`	Uri	The hyperlink to open.
`OpenOnce`	Bool	Prevents the user from clicking on the URL more than once and bringing up multiple confirmation dialouges
`Reason`	String	The reason that the hyperlink is being opened. Displayed to the user when they click it in the security dialog.

Sync Delegates

Triggers
Method Name	Method type and Arguments.	Description
`Open()`	Func`1	When called, this function will bring up the confirmation dialogue for the user that is executing the function (local user).

Usage

It can be triggered or activated in the following ways:

Using a collider and physically touching the object to prompt for a connection.
Attaching a UIX button component along with this component on the same slot, then clicking on the UIX button will prompt for a connection.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
+{{Infobox Component
-[[File:Hyperlink Component.webp|thumb|The Hyperlink as seen in the [[Scene Inspector]]]]
+|Image=Hyperlink Component.webp
-The '''Hyperlink''' component allows you to turn an object with a collider into a clickable link that will prompt the user in [[Userspace]] to open the provided link in their web browser.
+|Name=Hyperlink
+}}
+The '''Hyperlink''' component allows you to turn an object with a collider into a clickable link that will prompt the user in [[Userspace]] to open the provided link in their default web browser.
+{{Note|This component requires the start to contain <code>http://</code>, <code>ws://</code>, or something similar at the beginning of the URL, or this component will not prompt for a connection.
+Example for connecting to the local host of the device: <code>http://localhost:5000</code>|warning}}
 <!--T:2-->
@@ Line 10: / Line 16: @@
 {{Table ComponentFields
 |URL|Uri|The hyperlink to open.
+|OpenOnce|Bool| Prevents the user from clicking on the URL more than once and bringing up multiple confirmation dialouges
 |Reason|String|The reason that the hyperlink is being opened. Displayed to the user when they click it in the security dialog.
-|OpenOnce|Bool|
+}}
+== Sync Delegates ==
+{{Table ComponentTriggers
+|Open()|[[Type:Func`1|Func`1]]| When called, this function will bring up the confirmation dialogue for the user that is executing the function (local user).
 }}
 <!--T:3-->
 == Usage ==
+It can be triggered or activated in the following ways:
+* Using a collider and physically touching the object to prompt for a connection.
+* Attaching a [[UIX]] [[Component:Button|button]] component along with this component on the same [[Slot|slot]], then clicking on the UIX button will prompt for a connection.
 <!--T:4-->
 == Examples ==
+{{stub}}
 <!--T:5-->
-== Related Components ==
+== See Also ==
 </translate>
-[[Category:ComponentStubs]]
-[[Category:Components{{#translation:}}|Hyperlink]]
 [[Category:Components:Utility{{#translation:}}|Hyperlink]]