\n\nA tool for embedding OneSchema into your application with Vue. This library contains a Vue plugin which will allow you to add an iframe to your application which can open OneSchema and import data into your application.\n\n## Getting Started\n\n### Installation\n\nYou can install this package with npm:\n\n```bash\nnpm i --save @oneschema/vue\n```\n\nWith pnpm, install `eventemitter3` alongside it:\n\n```bash\npnpm add @oneschema/vue eventemitter3@^4.0.7\n```\n\nThe importer class this component wraps extends `EventEmitter` from `eventemitter3`, so that type is part of the published declarations. pnpm keeps each package's dependencies isolated instead of hoisting them, so your build cannot resolve `eventemitter3` unless it is declared in your project too. npm and yarn hoist it for you.\n\n### Configure the SDK\n\nCreate an instance of the `OneSchemaPlugin` by calling `createOneSchemaImporter` and passing it to Vue's `app.use()`\n\n```javascript\nimport { createApp } from \"vue\"\nimport { createOneSchemaImporter } from \"@oneschema/vue\"\nimport App from \"./App.vue\"\n\nconst app = createApp(App)\n\napp.use(\n createOneSchemaImporter({\n clientId: \"\",\n ...initParams,\n }),\n)\n\napp.mount(\"#app\")\n```\n\n### Sample usage\n\nOnce the OneSchema plugin has been registered, you can call the `useOneSchemaImporter` function to obtain the `OneSchemaImporterClass` instance.\n\n```vue\n\n\n \n\n\n\n```\n\n## Documentation\n\nPlease see [📚 OneSchema's documentation](https://docs.oneschema.co/) for [📒 API reference](https://docs.oneschema.co/docs/vue#api-reference) and other helpful guides.\n","readmeFilename":"README.md"}
![](\"https://uploads-ssl.webflow.com/62902d243ad8aef519be0d3e/62902d243ad8ae4014be0e97_oneschema-256.png\")
\n