@neanic/io-vue
v9.0.1
Published
The Neanic IO Vue library
Downloads
73
Readme
Vue Toolkit for Neanic IO
The Vue Toolkit for Neanic IO library provides VueJs components and utilities designed to work seamlessly with the Neanic IO ecosystem.
Features
- Data querying component
Installation
To install the library, use the following npm command:
npm install @neanic/io-vuePeer Dependencies
Ensure you have the following peer dependencies installed:
@neanic/io(version ^9.0.0 or higher)vue(version ^3.2.0 or higher)
Usage
To get started with @neanic/io-vue, you'll need to create a Neanic Vue instance and register the provided components. Here's an example of how to bootstrap your application:
import { createApp } from 'vue';
import { createNeanicVue } from '@neanic/io-vue';
import App from './App.vue'; // Your root Vue component
const { client, app } = createIOVue({
rootComponent: App,
ioOptions: {
// ... Your Neanic IO client options
},
componentPrefix: 'n', // Optional prefix for components - defaults to 'n'
});
app.mount('#app');Once set up, you can use the various hooks and components provided by the library in your Vue components:
<template>
<n-query />
</template>Not that the prefix 'n' can be overriden at creteIOVue intialization, by providing a componentPrefix. Defaults to 'n'
Components
<n-query>: Data querying component also exported as QueryComponent.
Development
To develop and build the library locally, you can use the following npm scripts:
# Start development server
npm run dev
# Build library for production
npm run build
# Serve the production build
npm run serveLicense
This project is licensed under the ISC License – see the LICENSE file for details. Developed by Neanic.
