{"id":13716075,"url":"https://github.com/danielbuechele/react-360-keyboard","last_synced_at":"2026-01-22T01:30:53.087Z","repository":{"id":142092249,"uuid":"147932626","full_name":"danielbuechele/react-360-keyboard","owner":"danielbuechele","description":"VR keyboard for react-360","archived":false,"fork":false,"pushed_at":"2018-11-22T22:40:23.000Z","size":6408,"stargazers_count":35,"open_issues_count":4,"forks_count":10,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-14T04:34:36.313Z","etag":null,"topics":["javascript","react","react-360","vr"],"latest_commit_sha":null,"homepage":"https://danielbuechele.github.io/react-360-keyboard/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/danielbuechele.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2018-09-08T12:46:33.000Z","updated_at":"2024-08-19T12:46:47.000Z","dependencies_parsed_at":"2023-07-22T21:18:46.279Z","dependency_job_id":null,"html_url":"https://github.com/danielbuechele/react-360-keyboard","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbuechele%2Freact-360-keyboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbuechele%2Freact-360-keyboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbuechele%2Freact-360-keyboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbuechele%2Freact-360-keyboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danielbuechele","download_url":"https://codeload.github.com/danielbuechele/react-360-keyboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252823138,"owners_count":21809700,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","react","react-360","vr"],"created_at":"2024-08-03T00:01:06.791Z","updated_at":"2026-01-22T01:30:53.032Z","avatar_url":"https://github.com/danielbuechele.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-360-keyboard\n\nA react-360 keyboard for VR text input. With emoji-support and dictation for speech input.\n\n![alt text](https://raw.githubusercontent.com/danielbuechele/react-360-keyboard/master/demo.gif)\n\nBecause react-360 itself doesn't offer any text inputs, I created this keyboard. The keyboard can be triggered via a [NativeModule](https://facebook.github.io/react-360/docs/native-modules.html) and is shown on a flat surface that is added on top of the scene. The user can type using any controller supported by `\u003cVrButton\u003e`. Emoji input is possible using [twemoji](https://github.com/twitter/twemoji). In browsers supporting the [Web Speech API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) dictation allows the user to enter the text via speech.\n\n## Try\n\nCheck out the [demo](https://danielbuechele.github.io/react-360-keyboard/) of the keyboard.\n\n## Usage\n\nIn your `client.js` file you need to add the NativeModules and pass the instance to the module.\n\n```js\nimport KeyboardModule from 'react-360-keyboard/KeyboardModule';\n\nfunction init(bundle, parent, options = {}) {\n  const r360 = new ReactInstance(bundle, parent, {\n    fullScreen: true,\n\n    // 1.) add the NativeModule to your instance\n    nativeModules: [KeyboardModule.addModule],\n\n    ...options,\n  });\n\n  // 2.) pass the instance to the NativeModule, do this after creating your main\n  //     surface to ensure the keyboard is rendered on top of your scene\n  KeyboardModule.setInstance(r360);\n}\n```\n\nIn your react-360 code, add the keyboard to the AppRegistry and call `NativeModules.Keyboard.startInput` to show it. A promise is returned that resolves with the text entered by the user.\n\n```js\nimport {VrButton, NativeModules, AppRegistry} from 'react-360';\n\n// 3.) register the Keyboard in your AppRegistry\nimport {registerKeyboard} from 'react-360-keyboard';\nAppRegistry.registerComponent(...registerKeyboard);\n\nexport default class MyVRApp extends React.Component {\n  onClick() {\n    // 4.) show the keyboard\n    NativeModules.Keyboard.startInput({\n      placeholder: 'Enter your name',\n    }).then(input =\u003e console.log(input));\n  }\n  render() {\n    return (\n      \u003cVrButton onClick={this.onClick}\u003e\n        \u003cText\u003eShow Keyboard\u003c/Text\u003e\n      \u003c/VrButton\u003e\n    );\n  }\n}\n```\n\n## Configuration\n\nThe keyboard can be configured by passing an object when starting the input.\n\n```js\nNativeModules.Keyboard.startInput(config?: {\n  initialValue?: string,\n  placeholder?: string,\n  sound?: boolean,\n  emoji?: boolean,\n  dictation?: boolean,\n  returnKeyLabel?: string,\n  tintColor?: string,\n}): Promise\u003c?string\u003e\n```\n\n| Property       | Type      | default     | Description                                                                              |\n| :------------- | :-------- | :---------- | :--------------------------------------------------------------------------------------- |\n| initialValue   | `string`  | `null`      | Initial value of the text field. This is useful for editing texts.                       |\n| placeholder    | `string`  | `null`      | Placeholder text that is shown while no text is entered                                  |\n| sound          | `boolean` | `true`      | Enable keyboard UI sound (e.g. keyboard clicks)                                          |\n| emoji          | `boolean` | `true`      | Allow emoji input                                                                        |\n| dictation      | `boolean` | `true`      | Allow speech to text input. Not available in all clients. Works with Chrome and Firefox. |\n| returnKeyLabel | `string`  | `'Return'`  | Label for the button that submits the input and hides the keyboard                       |\n| tintColor      | `string`  | `'#81D9FD'` | Color of the letters on the keyboard                                                     |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielbuechele%2Freact-360-keyboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanielbuechele%2Freact-360-keyboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielbuechele%2Freact-360-keyboard/lists"}