{{stub}}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. {{Infobox Component
{{Infobox Component
|Image=Hyperlink_Component.webp
|Image=Hyperlink Component.webp
|Name=Hyperlink
|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-->
<!--T:2-->
Line 11:
Line 16:
{{Table ComponentFields
{{Table ComponentFields
|URL|Uri|The hyperlink to open.
|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.
|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]]<[[Type:Bool|Bool]]>|[[Type:Func`1|Func`1]]<[[Type:Bool|Bool]]>|false| When called, this function will bring up the confirmation dialogue for the user that is executing the function (local user).
}}
}}
<!--T:3-->
<!--T:3-->
== Usage ==
== 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.
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.