{"__v":0,"_id":"58f7a4c8cbd001190056cc23","category":{"version":"58f7a4c8cbd001190056cbf8","project":"578c4badbd223d2000cc1441","_id":"58f7a4c8cbd001190056cbfe","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-08-01T23:04:12.838Z","from_sync":false,"order":5,"slug":"api-reference","title":"API Reference"},"parentDoc":null,"project":"578c4badbd223d2000cc1441","user":"57bb7defafc18c0e00529cf1","version":{"__v":1,"_id":"58f7a4c8cbd001190056cbf8","project":"578c4badbd223d2000cc1441","createdAt":"2017-04-19T17:56:24.172Z","releaseDate":"2017-04-19T17:56:24.172Z","categories":["58f7a4c8cbd001190056cbf9","58f7a4c8cbd001190056cbfa","58f7a4c8cbd001190056cbfb","58f7a4c8cbd001190056cbfc","58f7a4c8cbd001190056cbfd","58f7a4c8cbd001190056cbfe"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-18T01:00:11.634Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":27,"body":"A component that provides 2D Text functionality. \n\n######Example use:\n```\n<ViroText\n    text=\"Hello World\"\n    textAlign=\"left\"\n    textAlignVertical=\"top\"\n    textLineBreakMode=\"justify\"\n    textClipMode=\"clipToBounds\"\n    color=\"#ff0000\"\n    width={2} height={2}\n    style={{fontFamily:\"Arial\", fontSize:20, color:\"#0000FF\"}}\n    position={[0,0,-5]}\n />\n```\n\n######Typefaces\n\nThe typeface to use for text is determined by the ```fontFamily``` in its ```style``` property. Not all platforms support all font families. If a font family is not supported on a given device, the system will fall back to using that platform's default system font.\n\n######Sizing\n\nUse the ```fontSize``` in the text's ```style``` property to size the text. The actual size of text in a scene is determined by three things:\n\n1. The fontSize property: this determines the size of the font textures used. Increasing fontSize creates bigger, sharper fonts, but uses much more memory. Using too small fontSize will make the text appear blurry.\n\n2. The scale of the text. Scaling the text can increase text size, but will make the fonts more blurry. Try to avoid scaling fonts where possible.\n\n3. The distance of the text from the user. We are in 3D space, so the further away text is from the camera, the smaller it will appear. Use trial and error with your headset to discover the correct font sizes.\n\nIn general, try to use the smallest ```fontSize``` possible that reaches the sharpness desired at the given distance from the camera.\n\n######Bounding Box\n\nText is contained within a bounding box defined by its ```width``` and ```height``` properties. This bounding box is invisible, but determines how the text *wraps*, *aligns*, and *clips*. Note that ```width``` and ```height``` have **no bearing** on the size of the text.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Props\"\n}\n[/block]\n##Optional Props\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**color**\",\n    \"2-0\": \"**maxLines**\",\n    \"7-0\": \"**onHover**\",\n    \"10-0\": \"**onTouch**\",\n    \"11-0\": \"**position**\",\n    \"12-0\": \"**rotation**\",\n    \"13-0\": \"**style**\",\n    \"14-0\": \"**text**\",\n    \"19-0\": \"**transformBehaviors**\",\n    \"21-0\": \"**visible**\",\n    \"20-0\": \"**width**\",\n    \"h-0\": \"PropKey\",\n    \"h-1\": \"PropType\",\n    \"0-1\": \"**ColorPropType**\\n\\nThe color of the text. The default text color is white.\\n\\nValid color formats are:\\n\\n  * '#f0f' (#rgb)\\n  * '#f0fc' (#rgba)\\n  * '#ff00ff' (#rrggbb)\\n  * '#ff00ff00' (#rrggbbaa)\\n  * 'rgb(255, 255, 255)'\\n  * 'rgba(255, 255, 255, 1.0)'\\n  * 'hsl(360, 100%, 100%)'\\n  * 'hsla(360, 100%, 100%, 1.0)'\\n  * 'transparent'\\n  * 'red'\\n  * 0xff00ff00 (0xrrggbbaa)\",\n    \"2-1\": \"**PropTypes.number**\\n\\nThe maximum number of lines the text should take. The text will automatically be truncated if it exceeds the maxLines specified.\",\n    \"7-1\": \"**React.PropTypes.func**\\n\\nCalled when the user hovers on or off the control.\\n\\nFor example:\\n```  \\n_onHover(isHovering, source)  {\\n    if(isHovering) {\\n        // user is hovering over the box\\n    } else {\\n        // user is no longer hovering over the box\\n    }\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\",\n    \"10-1\": \"**React.PropTypes.func**\\n\\nCalled when the user performs a touch action, while hovering on the control. Provides the touch state type, and the x/y coordinate at which this touch event has occurred.\\n\\n|State Value|Description|\\n|:------|:----------:|\\n|1| Touch Down: Triggered when the user  makes physical contact with the touch pad on the controller. |\\n|2| Touch Down Move: Called when the user moves around the touch pad immediately after having performed a Touch Down action. |\\n|3| Touch Up: Triggered after the user is no longer in physical contact with the touch pad after a Touch Down action. |\\n\\nFor example:\\n```  \\n_onTouch(state, touchPos, source)  {\\n   var touchX = touchPos[0];\\n   var touchY = touchPos[1];\\n    if(state == 1) {\\n        // Touch Down\\n    } else if(state == 2) {\\n        // Touch Down Move\\n    } else if(state == 3) { \\n        // Touch Up\\n    }\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\\n\\nUnsupported VR Platforms: Cardboard(Android and iOS).\",\n    \"11-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nCartesian position of the text in 3D world space, specified as [x, y, z].\",\n    \"12-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nThe rotation of the text around it's local axis specified as Euler angles [x, y, z]. Units for each angle are specified in degrees.\",\n    \"13-1\": \"**stylePropType** \\n\\nRefers to style property that is only used if the ViroText is within a ViroFlexView. Style properties determine the position and scale of the button within a ViroText. Please see our guide on styles for more information.\",\n    \"14-1\": \"**PropTypes.string**\\n\\nThe text that should be displayed.\",\n    \"19-1\": \"**PropTypes.arrayOf(PropTypes.string)**\\n\\nAn array of transform constraints that affect the transform of the object. For example, putting the value \\\"billboard\\\" will ensure the box is facing the user as the user rotates their head on any axis. This is useful for icons or text where you'd like the box to always face the user at a particular rotation.\\n\\nAllowed values(values are case sensitive):\\n\\n|Value|Description|\\n|:------|:----------:|\\n|billboard| Billboard object on x,y,z axis |\\n|billboardX| Billboard object on the x axis|\\n|billboardY| Billboard object on the y axis|\",\n    \"20-1\": \"**PropTypes.number**\\n\\nThe width of the the text in 3D world space. If not in a ViroFlexView the default is set to 1.\",\n    \"21-1\": \"**PropTypes.bool**\\n\\nFalse if the text should be hidden. By default the text is visible and this value is true.\",\n    \"1-0\": \"**height**\",\n    \"1-1\": \"**PropTypes.number**\\n\\nThe width of the the text in 3D world space. If not in a ViroFlexView the default is set to 1.\",\n    \"17-0\": \"**textClipMode**\",\n    \"18-0\": \"**textLineBreakMode**\",\n    \"17-1\": \"**PropTypes.oneOf(['none', 'clipToBounds'])**\\n\\nSet to ```clipToBounds``` to clip this text to its bounding box defined by ```width``` and ```height```. If set to ```none```, the text will overrun its bounds if's larger than them.\",\n    \"18-1\": \"**PropTypes.oneOf(['wordwrap','charwrap','justify','none'])**\\n\\nThe line break mode to use for text wrapping. We process line breaks against the ```width``` of the text. \\n\\nSet to ```wordwrap``` to introduce line breaks only at word boundaries, whenever the next word overruns the width. \\n\\nSet to ```charwrap``` to introduce line breaks whenever the next *character* overruns the width. This mode may break words in half across lines.\\n\\nSet to ```justify``` to introduce breaks at word boundaries, and add variable internal spacing between words, at the optimal points in the text to reduce the 'raggedness' of the text edges.\",\n    \"3-0\": \"**onClick**\",\n    \"3-1\": \"**React.PropTypes.func**\\n\\nCalled when an object has been clicked.\\n\\nExample code:\\n```  \\n_onClick(source)  {\\n    // user has clicked the object\\n}\\n```\",\n    \"4-0\": \"**onClickState**\",\n    \"5-0\": \"**onDrag**\",\n    \"8-0\": \"**onScroll**\",\n    \"9-0\": \"**onSwipe**\",\n    \"8-1\": \"**React.PropTypes.func**\\n\\nCalled when the user performs a scroll action, while hovering on the control.\\n\\nFor example:\\n```  \\n_onScroll(scrollPos, source)  {\\n    // scrollPos[0]: x scroll position from 0.0 to 1.0. \\n    // scrollPos[1]: y scroll position from 0.0 to 1.0.\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\\n\\nUnsupported VR Platforms: Cardboard(Android and iOS)\",\n    \"9-1\": \"**React.PropTypes.func**\\n\\nCalled when the user performs a swipe gesture on the physical controller, while hovering on this control. \\n\\nFor example:\\n```  \\n_onSwipe(state, source)  {\\n    if(state == 1) {\\n        // Swiped up\\n    } else if(state == 2) {\\n        // Swiped down\\n    } else if(state == 3) { \\n       // Swiped left\\n    } else if(state == 4) { \\n       // Swiped right\\n    }\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\\n\\nUnsupported VR Platforms: Cardboard(Android and iOS)\",\n    \"4-1\": \"**React.PropTypes.func**\\n\\nCalled for each click state an object goes through as it is clicked. Supported click states and their values are the following:\\n\\n|State Value|Description|\\n|:------|:----------:|\\n|1| Click Down: Triggered when the user has performed a click down action while hovering on this control.|\\n|2| Click Up: Triggered when the user has performed a click up action while hovering on this control.|\\n|3| Clicked: Triggered when the user has performed both a click down and click up action on this control sequentially, thereby having \\\"Clicked\\\" the object.|\\n\\nExample code:\\n```  \\n_onClickState(stateValue, source)  {\\n    if(stateValue == 1) {\\n        // Click Down\\n    } else if(stateValue == 2) {\\n        // Click Up\\n    } else if(stateValue == 3) { \\n        // Clicked\\n    }\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\",\n    \"5-1\": \"**React.PropTypes.func**\\n\\nCalled when the view is currently being dragged. The dragToPos parameter provides the current 3D location of the dragged object. \\n\\nExample code:\\n```  \\n_onDrag(dragToPos, source)  {\\n    // dragtoPos[0]: x position\\n    // dragtoPos[1]: y position\\n    // dragtoPos[2]: z position\\n}\\n``` \\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section. \\n\\nUnsupported VR Platforms: Cardboard iOS\",\n    \"15-0\": \"**textAlign**\",\n    \"16-0\": \"**textAlignVertical**\",\n    \"15-1\": \"**PropTypes.oneOf(['left', 'right', 'center'])**\\n\\nHorizontal alignment of the text. Aligns with respect to the bounding box of this text defined by ```width``` and ```height```. Supported values are ```left```, ```right```, and ```center```.\",\n    \"16-1\": \"**PropTypes.oneOf(['top', 'bottom', 'center'])**\\n\\nVertical alignment of the text. Aligns with respect to the bounding box of this text defined by ```width``` and ```height```. Supported values are ```top```, ```bottom```, and ```center```.\",\n    \"6-0\": \"**onFuse**\",\n    \"6-1\": \"**PropTypes.oneOfType**\\n```  \\nPropTypes.oneOfType([\\n      React.PropTypes.shape({\\n        callback: React.PropTypes.func.isRequired,\\n        timeToFuse: PropTypes.number\\n      }),\\n      React.PropTypes.func,\\n])\\n```  \\nAs shown above, onFuse takes one of the types - either a callback, or a dictionary with a callback and duration. \\n\\nIt is called after the user hovers onto and remains hovered on the control for a certain duration of time, as indicated in timeToFuse that represents the duration of time in milliseconds. \\n\\nWhile hovering, the reticle will display a count down animation while fusing towards timeToFuse.\\n\\nNote that timeToFuse defaults to 2000ms.\\n\\nFor example:\\n```  \\n_onFuse(source){\\n   // User has hovered over object for timeToFuse milliseconds\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\"\n  },\n  \"cols\": 2,\n  \"rows\": 22\n}\n[/block]","excerpt":"","slug":"virotext2","type":"basic","title":"ViroText"}
A component that provides 2D Text functionality. ######Example use: ``` <ViroText text="Hello World" textAlign="left" textAlignVertical="top" textLineBreakMode="justify" textClipMode="clipToBounds" color="#ff0000" width={2} height={2} style={{fontFamily:"Arial", fontSize:20, color:"#0000FF"}} position={[0,0,-5]} /> ``` ######Typefaces The typeface to use for text is determined by the ```fontFamily``` in its ```style``` property. Not all platforms support all font families. If a font family is not supported on a given device, the system will fall back to using that platform's default system font. ######Sizing Use the ```fontSize``` in the text's ```style``` property to size the text. The actual size of text in a scene is determined by three things: 1. The fontSize property: this determines the size of the font textures used. Increasing fontSize creates bigger, sharper fonts, but uses much more memory. Using too small fontSize will make the text appear blurry. 2. The scale of the text. Scaling the text can increase text size, but will make the fonts more blurry. Try to avoid scaling fonts where possible. 3. The distance of the text from the user. We are in 3D space, so the further away text is from the camera, the smaller it will appear. Use trial and error with your headset to discover the correct font sizes. In general, try to use the smallest ```fontSize``` possible that reaches the sharpness desired at the given distance from the camera. ######Bounding Box Text is contained within a bounding box defined by its ```width``` and ```height``` properties. This bounding box is invisible, but determines how the text *wraps*, *aligns*, and *clips*. Note that ```width``` and ```height``` have **no bearing** on the size of the text. [block:api-header] { "type": "basic", "title": "Props" } [/block] ##Optional Props [block:parameters] { "data": { "0-0": "**color**", "2-0": "**maxLines**", "7-0": "**onHover**", "10-0": "**onTouch**", "11-0": "**position**", "12-0": "**rotation**", "13-0": "**style**", "14-0": "**text**", "19-0": "**transformBehaviors**", "21-0": "**visible**", "20-0": "**width**", "h-0": "PropKey", "h-1": "PropType", "0-1": "**ColorPropType**\n\nThe color of the text. The default text color is white.\n\nValid color formats are:\n\n * '#f0f' (#rgb)\n * '#f0fc' (#rgba)\n * '#ff00ff' (#rrggbb)\n * '#ff00ff00' (#rrggbbaa)\n * 'rgb(255, 255, 255)'\n * 'rgba(255, 255, 255, 1.0)'\n * 'hsl(360, 100%, 100%)'\n * 'hsla(360, 100%, 100%, 1.0)'\n * 'transparent'\n * 'red'\n * 0xff00ff00 (0xrrggbbaa)", "2-1": "**PropTypes.number**\n\nThe maximum number of lines the text should take. The text will automatically be truncated if it exceeds the maxLines specified.", "7-1": "**React.PropTypes.func**\n\nCalled when the user hovers on or off the control.\n\nFor example:\n``` \n_onHover(isHovering, source) {\n if(isHovering) {\n // user is hovering over the box\n } else {\n // user is no longer hovering over the box\n }\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.", "10-1": "**React.PropTypes.func**\n\nCalled when the user performs a touch action, while hovering on the control. Provides the touch state type, and the x/y coordinate at which this touch event has occurred.\n\n|State Value|Description|\n|:------|:----------:|\n|1| Touch Down: Triggered when the user makes physical contact with the touch pad on the controller. |\n|2| Touch Down Move: Called when the user moves around the touch pad immediately after having performed a Touch Down action. |\n|3| Touch Up: Triggered after the user is no longer in physical contact with the touch pad after a Touch Down action. |\n\nFor example:\n``` \n_onTouch(state, touchPos, source) {\n var touchX = touchPos[0];\n var touchY = touchPos[1];\n if(state == 1) {\n // Touch Down\n } else if(state == 2) {\n // Touch Down Move\n } else if(state == 3) { \n // Touch Up\n }\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\n\nUnsupported VR Platforms: Cardboard(Android and iOS).", "11-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nCartesian position of the text in 3D world space, specified as [x, y, z].", "12-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nThe rotation of the text around it's local axis specified as Euler angles [x, y, z]. Units for each angle are specified in degrees.", "13-1": "**stylePropType** \n\nRefers to style property that is only used if the ViroText is within a ViroFlexView. Style properties determine the position and scale of the button within a ViroText. Please see our guide on styles for more information.", "14-1": "**PropTypes.string**\n\nThe text that should be displayed.", "19-1": "**PropTypes.arrayOf(PropTypes.string)**\n\nAn array of transform constraints that affect the transform of the object. For example, putting the value \"billboard\" will ensure the box is facing the user as the user rotates their head on any axis. This is useful for icons or text where you'd like the box to always face the user at a particular rotation.\n\nAllowed values(values are case sensitive):\n\n|Value|Description|\n|:------|:----------:|\n|billboard| Billboard object on x,y,z axis |\n|billboardX| Billboard object on the x axis|\n|billboardY| Billboard object on the y axis|", "20-1": "**PropTypes.number**\n\nThe width of the the text in 3D world space. If not in a ViroFlexView the default is set to 1.", "21-1": "**PropTypes.bool**\n\nFalse if the text should be hidden. By default the text is visible and this value is true.", "1-0": "**height**", "1-1": "**PropTypes.number**\n\nThe width of the the text in 3D world space. If not in a ViroFlexView the default is set to 1.", "17-0": "**textClipMode**", "18-0": "**textLineBreakMode**", "17-1": "**PropTypes.oneOf(['none', 'clipToBounds'])**\n\nSet to ```clipToBounds``` to clip this text to its bounding box defined by ```width``` and ```height```. If set to ```none```, the text will overrun its bounds if's larger than them.", "18-1": "**PropTypes.oneOf(['wordwrap','charwrap','justify','none'])**\n\nThe line break mode to use for text wrapping. We process line breaks against the ```width``` of the text. \n\nSet to ```wordwrap``` to introduce line breaks only at word boundaries, whenever the next word overruns the width. \n\nSet to ```charwrap``` to introduce line breaks whenever the next *character* overruns the width. This mode may break words in half across lines.\n\nSet to ```justify``` to introduce breaks at word boundaries, and add variable internal spacing between words, at the optimal points in the text to reduce the 'raggedness' of the text edges.", "3-0": "**onClick**", "3-1": "**React.PropTypes.func**\n\nCalled when an object has been clicked.\n\nExample code:\n``` \n_onClick(source) {\n // user has clicked the object\n}\n```", "4-0": "**onClickState**", "5-0": "**onDrag**", "8-0": "**onScroll**", "9-0": "**onSwipe**", "8-1": "**React.PropTypes.func**\n\nCalled when the user performs a scroll action, while hovering on the control.\n\nFor example:\n``` \n_onScroll(scrollPos, source) {\n // scrollPos[0]: x scroll position from 0.0 to 1.0. \n // scrollPos[1]: y scroll position from 0.0 to 1.0.\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\n\nUnsupported VR Platforms: Cardboard(Android and iOS)", "9-1": "**React.PropTypes.func**\n\nCalled when the user performs a swipe gesture on the physical controller, while hovering on this control. \n\nFor example:\n``` \n_onSwipe(state, source) {\n if(state == 1) {\n // Swiped up\n } else if(state == 2) {\n // Swiped down\n } else if(state == 3) { \n // Swiped left\n } else if(state == 4) { \n // Swiped right\n }\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\n\nUnsupported VR Platforms: Cardboard(Android and iOS)", "4-1": "**React.PropTypes.func**\n\nCalled for each click state an object goes through as it is clicked. Supported click states and their values are the following:\n\n|State Value|Description|\n|:------|:----------:|\n|1| Click Down: Triggered when the user has performed a click down action while hovering on this control.|\n|2| Click Up: Triggered when the user has performed a click up action while hovering on this control.|\n|3| Clicked: Triggered when the user has performed both a click down and click up action on this control sequentially, thereby having \"Clicked\" the object.|\n\nExample code:\n``` \n_onClickState(stateValue, source) {\n if(stateValue == 1) {\n // Click Down\n } else if(stateValue == 2) {\n // Click Up\n } else if(stateValue == 3) { \n // Clicked\n }\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.", "5-1": "**React.PropTypes.func**\n\nCalled when the view is currently being dragged. The dragToPos parameter provides the current 3D location of the dragged object. \n\nExample code:\n``` \n_onDrag(dragToPos, source) {\n // dragtoPos[0]: x position\n // dragtoPos[1]: y position\n // dragtoPos[2]: z position\n}\n``` \nFor the mapping of sources to controller inputs, see the [Events](doc:events) section. \n\nUnsupported VR Platforms: Cardboard iOS", "15-0": "**textAlign**", "16-0": "**textAlignVertical**", "15-1": "**PropTypes.oneOf(['left', 'right', 'center'])**\n\nHorizontal alignment of the text. Aligns with respect to the bounding box of this text defined by ```width``` and ```height```. Supported values are ```left```, ```right```, and ```center```.", "16-1": "**PropTypes.oneOf(['top', 'bottom', 'center'])**\n\nVertical alignment of the text. Aligns with respect to the bounding box of this text defined by ```width``` and ```height```. Supported values are ```top```, ```bottom```, and ```center```.", "6-0": "**onFuse**", "6-1": "**PropTypes.oneOfType**\n``` \nPropTypes.oneOfType([\n React.PropTypes.shape({\n callback: React.PropTypes.func.isRequired,\n timeToFuse: PropTypes.number\n }),\n React.PropTypes.func,\n])\n``` \nAs shown above, onFuse takes one of the types - either a callback, or a dictionary with a callback and duration. \n\nIt is called after the user hovers onto and remains hovered on the control for a certain duration of time, as indicated in timeToFuse that represents the duration of time in milliseconds. \n\nWhile hovering, the reticle will display a count down animation while fusing towards timeToFuse.\n\nNote that timeToFuse defaults to 2000ms.\n\nFor example:\n``` \n_onFuse(source){\n // User has hovered over object for timeToFuse milliseconds\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section." }, "cols": 2, "rows": 22 } [/block]