Component:VirtualKeyboard: Difference between revisions

Latest revision as of 19:40, 2 February 2025

Component image

The Virtual Keyboard is a component that groups many Keys, Modifier Keys, and Multi Keys together.

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. Some components stop their functionality when this field is disabled, but some don't.
`ShiftActive`	Bool	Whether the Virtual Shift key is toggled to pressed.
`HoldShift`	Bool	Whether the Virtual Shift key is held.
`TextPreviewActive`	field drive of Bool	drives the visibility of the preview text display.
`TextPreview`	IText	The text preview object that shows what the user is typing.

Used in the default keyboard every user comes with, and

@@ Line 5: / Line 5: @@
 The Virtual Keyboard is a component that groups many [[Component:VirtualKey|Keys]], [[Component:VirtualModifierKey|Modifier Keys]], and [[Component:VirtualMultiKey|Multi Keys]] together.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|ShiftActive|Bool| Whether the Shift modifier key is active.
+|ShiftActive|Bool| Whether the [[Component:VirtualShift|Virtual Shift]] key is toggled to pressed.
-|HoldShift|Bool| Whether the Shift key is held.
+|HoldShift|Bool| Whether the [[Component:VirtualShift|Virtual Shift]] key is held.
 |TextPreviewActive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv2=true| drives the visibility of the preview text display.
 |TextPreview|IText| The text preview object that shows what the user is typing.
@@ Line 17: / Line 17: @@
 == See Also ==
-* [[Component:VirtualKey|Virtual Key]]
+{{Template:KeyBoardTypes_SeeAlso}}
-* [[Component:VirtualModifierKey|Virtual Modifier Key]]
-* [[Component:VirtualMultiKey|Virtual Multi Key]]
 [[Category:Components:Userspace:Virtual Keyboard{{#translation:}}|Virtual Keyboard]]
 [[Category:Components{{#translation:}}|Virtual Keyboard]]