{"__v":0,"_id":"58f7a4c8cbd001190056cc13","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-18T04:13:48.413Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":11,"body":"A ViroFlexView is a powerful component that allows you to combine many 2D components to create powerful layouts in 3D space. This is achieved by using the power of the flexbox algorithm. More information on flexbox is [here](https://css-tricks.com/snippets/css/a-guide-to-flexbox/). The ViroFlexView supports a subset of flexbox, which can be found [here](https://facebook.github.io/react-native/docs/flexbox.html). \n\nPlease see our [UI Controls & Flexbox](doc:flexbox-ui-layouts) guide for more information on using this component.\n\nLayout styles supported for ViroFlexViews can be found [here](doc:styles).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Props\"\n}\n[/block]\n\n##Optional Props\n[block:parameters]\n{\n  \"data\": {\n    \"7-0\": \"**onHover**\",\n    \"12-0\": \"**position**\",\n    \"13-0\": \"**rotation**\",\n    \"14-0\": \"**scale**\",\n    \"16-0\": \"**transformBehaviors**\",\n    \"17-0\": \"**width**\",\n    \"19-0\": \"**rotation**\",\n    \"20-0\": \"**scale**\",\n    \"21-0\": \"**transformBehaviors**\",\n    \"23-0\": \"**volume**\",\n    \"24-0\": \"**visible**\",\n    \"22-0\": \"**width**\",\n    \"h-0\": \"PropKey\",\n    \"h-1\": \"PropType\",\n    \"7-1\": \"**React.PropTypes.func**\\nFunction to be invoked when the user hovers on or off the container view. If defined, this is only invoked if the child hovered upon doesn't have onHover defined. \\n\\nFor instance, let's say you have a <ViroFlexView> that contains a few buttons and text. If none of them have a onHover handler defined, and they get hovered upon, then this function will invoke, effectively capturing the onHover event from it's children.\\n\\nFor example:\\n```  \\n_onHover(isHovering)  {\\n    if(isHovering) {\\n        // user is hovering on the container view.\\n    } else {\\n        // user is no longer hovering on the container view.\\n    }\\n}\\n```\",\n    \"12-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nCartesian position of the container in 3D world space, specified as [x, y, z].\",\n    \"13-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nThe rotation of the transform in world space stored as Euler angles [x, y, z]. Units for each angle are specified in degrees.\",\n    \"14-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nThe scale of the <ViroFlexView> in 3D space, specified as [x,y,z]. A scale of 1 represents the current size of the <ViroFlexView>. A scale value of < 1 will make the <ViroFlexView> proportionally smaller while a value >1 will make the <ViroFlexView> proportionally bigger along the specified axis.\",\n    \"16-1\": \"**PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string])**\\n\\nAn array of transform constraints that affect the transform of the ViroFlexView. For example, putting the value \\\"billboard\\\" will ensure the ViroFlexView is facing the user as the user rotates their head on any axis. This is useful for having the ViroFlexView always face the user on a particular axis, which especially useful for menus other 2D UI.\\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    \"17-1\": \"**PropTypes.number**\\n\\nThe width of the ViroFlexView in 3D space. Default is 1.\",\n    \"19-1\": \"PropTypes.arrayOf(PropTypes.number)\\n\\nPut the PropType Description here.\",\n    \"20-1\": \"PropTypes.arrayOf(PropTypes.number)\\n\\nPut the PropType Description here.\",\n    \"21-1\": \"PropTypes.arrayOf(PropTypes.string)\\n\\nPut the PropType Description here.\",\n    \"22-1\": \"PropTypes.number\\n\\nPut the PropType Description here.\",\n    \"23-1\": \"PropTypes.number\\n\\nPut the PropType Description here.\",\n    \"24-1\": \"PropTypes.bool\\n\\nPut the PropType Description here.\",\n    \"0-0\": \"**backgroundColor**\",\n    \"0-1\": \"**ColorPropType**\\n\\n\\nThe background color for the flexbox. The default background color is transparent.\\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-0\": \"**materials**\",\n    \"2-1\": \"**PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string])**\\n\\nSince ViroFlexView is a 2D container, it can take an array of 1 material that can serve as a background to the entire ViroFlexView.\",\n    \"15-0\": \"**style**\",\n    \"15-1\": \"**stylePropType**\\n\\nPlease see [Styles](doc:styles) for more details\",\n    \"18-0\": \"**visible**\",\n    \"18-1\": \"**PropTypes.bool**\\n\\nFalse if the ViroFlexView and it's children should be hidden. By default the ViroFlexView is visible and this value is true.\",\n    \"1-0\": \"**height**\",\n    \"1-1\": \"**PropTypes.number**\\n\\nThe width of the ViroFlexView in 3D space. Default is 1.\",\n    \"3-0\": \"**onClick**\",\n    \"3-1\": \"**React.PropTypes.func**\\n\\nCalled when an objeect has been clicked.\\n\\nExample code:\\n```  \\n_onClick(source)  {\\n    // user has clicked the object\\n}\\n```\",\n    \"4-0\": \"**onClickState**\",\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-0\": \"**onDrag**\",\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    \"8-0\": \"**onScroll**\",\n    \"9-0\": \"**onSwipe**\",\n    \"10-0\": \"**onTouch**\",\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    \"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-0\": \"**opacity**\",\n    \"11-1\": \"**PropTypes.number** \\n\\nA number from 0 to 1 that specifies the opacity of the container. A value of 1 translates into a fully opaque view while 0 represents full transparency.\",\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\": 19\n}\n[/block]","excerpt":"","slug":"viroflexview","type":"basic","title":"ViroFlexView"}
A ViroFlexView is a powerful component that allows you to combine many 2D components to create powerful layouts in 3D space. This is achieved by using the power of the flexbox algorithm. More information on flexbox is [here](https://css-tricks.com/snippets/css/a-guide-to-flexbox/). The ViroFlexView supports a subset of flexbox, which can be found [here](https://facebook.github.io/react-native/docs/flexbox.html). Please see our [UI Controls & Flexbox](doc:flexbox-ui-layouts) guide for more information on using this component. Layout styles supported for ViroFlexViews can be found [here](doc:styles). [block:api-header] { "type": "basic", "title": "Props" } [/block] ##Optional Props [block:parameters] { "data": { "7-0": "**onHover**", "12-0": "**position**", "13-0": "**rotation**", "14-0": "**scale**", "16-0": "**transformBehaviors**", "17-0": "**width**", "19-0": "**rotation**", "20-0": "**scale**", "21-0": "**transformBehaviors**", "23-0": "**volume**", "24-0": "**visible**", "22-0": "**width**", "h-0": "PropKey", "h-1": "PropType", "7-1": "**React.PropTypes.func**\nFunction to be invoked when the user hovers on or off the container view. If defined, this is only invoked if the child hovered upon doesn't have onHover defined. \n\nFor instance, let's say you have a <ViroFlexView> that contains a few buttons and text. If none of them have a onHover handler defined, and they get hovered upon, then this function will invoke, effectively capturing the onHover event from it's children.\n\nFor example:\n``` \n_onHover(isHovering) {\n if(isHovering) {\n // user is hovering on the container view.\n } else {\n // user is no longer hovering on the container view.\n }\n}\n```", "12-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nCartesian position of the container in 3D world space, specified as [x, y, z].", "13-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nThe rotation of the transform in world space stored as Euler angles [x, y, z]. Units for each angle are specified in degrees.", "14-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nThe scale of the <ViroFlexView> in 3D space, specified as [x,y,z]. A scale of 1 represents the current size of the <ViroFlexView>. A scale value of < 1 will make the <ViroFlexView> proportionally smaller while a value >1 will make the <ViroFlexView> proportionally bigger along the specified axis.", "16-1": "**PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string])**\n\nAn array of transform constraints that affect the transform of the ViroFlexView. For example, putting the value \"billboard\" will ensure the ViroFlexView is facing the user as the user rotates their head on any axis. This is useful for having the ViroFlexView always face the user on a particular axis, which especially useful for menus other 2D UI.\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|", "17-1": "**PropTypes.number**\n\nThe width of the ViroFlexView in 3D space. Default is 1.", "19-1": "PropTypes.arrayOf(PropTypes.number)\n\nPut the PropType Description here.", "20-1": "PropTypes.arrayOf(PropTypes.number)\n\nPut the PropType Description here.", "21-1": "PropTypes.arrayOf(PropTypes.string)\n\nPut the PropType Description here.", "22-1": "PropTypes.number\n\nPut the PropType Description here.", "23-1": "PropTypes.number\n\nPut the PropType Description here.", "24-1": "PropTypes.bool\n\nPut the PropType Description here.", "0-0": "**backgroundColor**", "0-1": "**ColorPropType**\n\n\nThe background color for the flexbox. The default background color is transparent.\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-0": "**materials**", "2-1": "**PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string])**\n\nSince ViroFlexView is a 2D container, it can take an array of 1 material that can serve as a background to the entire ViroFlexView.", "15-0": "**style**", "15-1": "**stylePropType**\n\nPlease see [Styles](doc:styles) for more details", "18-0": "**visible**", "18-1": "**PropTypes.bool**\n\nFalse if the ViroFlexView and it's children should be hidden. By default the ViroFlexView is visible and this value is true.", "1-0": "**height**", "1-1": "**PropTypes.number**\n\nThe width of the ViroFlexView in 3D space. Default is 1.", "3-0": "**onClick**", "3-1": "**React.PropTypes.func**\n\nCalled when an objeect has been clicked.\n\nExample code:\n``` \n_onClick(source) {\n // user has clicked the object\n}\n```", "4-0": "**onClickState**", "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-0": "**onDrag**", "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", "8-0": "**onScroll**", "9-0": "**onSwipe**", "10-0": "**onTouch**", "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)", "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-0": "**opacity**", "11-1": "**PropTypes.number** \n\nA number from 0 to 1 that specifies the opacity of the container. A value of 1 translates into a fully opaque view while 0 represents full transparency.", "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": 19 } [/block]