Ooko
Playground

Installation ​

Ooko UI is installed from its GitHub repository, at a release tag. It is not published to npm.

1. Install it in your application ​

Run this command from the consuming Vue application:

sh
npm install github:jbmaisner/ooko#0.8.0

npm clones the repository and builds the package, so it only needs git access to the repository. Available versions and their release notes are listed on the releases page.

To try unreleased changes instead, run ./scripts/build-local.sh in the Ooko UI repository and install the .tgz file it prints the path of.

Ooko UI requires Vue 3.5 or later. Vue remains a peer dependency so the application and Ooko UI share the same Vue runtime.

2. Register Ooko and its styles ​

Register the complete plugin once in the application entry:

ts
import { createApp } from "vue";
import Ooko from "ooko-ui";
import "ooko-ui/style.css";

import App from "./App.vue";

createApp(App).use(Ooko).mount("#app");

All Ooko components are now available in templates. Continue with First steps to render a component and choose between plugin and individual imports.

TypeScript ​

Ooko ships its declarations with the package. No separate @types dependency or TypeScript configuration is required.