@kinetis/vector-ui
@kinetis/vector-ui
The Kinetis Vector admin UI, as a Nuxt layer on Vuetify
Part of Kinetis, a non-blocking PHP framework for API-first applications. Vector is developed in the kinetis-dev/vector-dev monorepo, beside its PHP package and a demo application.
The admin UI for kinetis/vector:
a Nuxt 4 layer on Vuetify 4 that renders the descriptor the API
publishes — navigation, lists, forms, relation panels, actions,
dashboards, jobs, settings — and contains no application knowledge. An
application is a Nuxt app that extends the layer, served as a static
site on its own origin with a bearer token (standalone), or installed
into the PHP application and served at /vector/ui behind its session
(hosted).
The package also ships that hosted build, in dist/static with its
vector-bundle.json manifest: kinetis vector:install-ui downloads it
from the registry and installs it, so a PHP deployment needs no Node.
See Deployment.
Installation
pnpm add @kinetis/vector-ui nuxt vuetify vuetify-nuxt-module
// nuxt.config.ts
export default defineNuxtConfig({
extends: ['@kinetis/vector-ui'],
runtimeConfig: { public: { vector: { apiBase: 'https://api.example.com' } } },
})
pnpm nuxt dev for development, pnpm nuxt generate for a static site
any web server hosts. The API allows the UI's origin through
CorsMiddleware and offers the POST /auth/login endpoint the sign-in
page calls; see
Deployment. Keep this
package at the release your kinetis/vector pins: the admin shows a
banner naming both versions when they differ.
Configuration
| Where | Key | Default | Purpose |
|---|---|---|---|
runtimeConfig.public.vector |
apiBase |
http://localhost:8080 |
The API origin in standalone mode (NUXT_PUBLIC_VECTOR_API_BASE). |
extensions |
[] |
ES-module URLs to import after boot, in standalone mode. | |
app.config.vector |
brand.title |
Vector |
The title before the Branding settings load. |
usersResource |
null |
The resource whose records are users, for Impersonate. | |
idleMinutes |
30 |
Minutes without use after which the admin signs the user out; 0 never. |
|
locale |
en |
The language before the descriptor names the user's. |
Every setting, including component overrides, custom pages and messages: kinetis.dev/vector/docs/configuration.html. Cells, inputs, widgets and runtime extensions: Customizing the UI.
License
MIT — see LICENSE.
Related Packages
A minimal portfolio template and layer built with Nuxt 4, Tailwind CSS 4, and GS...
Version History
| Version | Released | Vue | License |
|---|---|---|---|
| 0.11.1 | ^3.5.0 | MIT | |
| 0.11.0 | ^3.5.0 | MIT | |
| 0.10.4 | ^3.5.0 | MIT | |
| 0.10.3 | ^3.5.0 | MIT | |
| 0.10.2 | ^3.5.0 | MIT | |
| 0.10.1 | ^3.5.0 | MIT | |
| 0.10.0 | ^3.5.0 | MIT | |
| 0.9.4 | ^3.5.0 | MIT | |
| 0.9.3 | ^3.5.0 | MIT | |
| 0.9.2 | ^3.5.0 | MIT | |
| 0.9.1 | ^3.5.0 | MIT | |
| 0.9.0 | ^3.5.0 | MIT |
Pre-releases (1)
| Version | Released | License |
|---|---|---|
| 0.0.0-stage |