Neura UI

Loading…

Logo
Neura UI
All pages 99

Installation

Add the package, register the Vite plugin, then load the runtime in your layout.

Prerequisites

Neura runs in a Laravel app that already compiles with Vite. Vite+ is optional: it replaces the Vite CLI, it does not replace Laravel, Livewire, or Tailwind.
Laravel 11 or later Livewire 3.7.0 or later Tailwind CSS 4.0 or later Vite 7 or later Vite+ Optional

Install

Four steps, for either toolchain. If you want Vite+, migrate first so the installer writes into vite.config.ts.
01

Require the package

Neura Kit is MIT licensed. No license key.

composer 
composer require neura-ui/neura-kit:^3.0
02

Register the plugin

The command patches the first config it finds: vite.config.js, .mjs, .ts, or .mts. It then adds the Tailwind source line. app.js stays untouched.

artisan 
php artisan neura-kit:install
vite.config.js 
import neuraKit from './vendor/neura-ui/neura-kit/resources/js/index.ts';

plugins: [
    neuraKit(),
    laravel({
        input: ['resources/css/app.css', 'resources/js/app.js'],
        refresh: true,
    }),
    tailwindcss(),
]
app.css 
@source '../../vendor/neura-ui/neura-kit/**/*.{js,ts,vue,blade.php,php}';
03

Load the runtime

Place @neuraKit just before </body>. It renders the modal, toast, and overlay managers.

layout.blade.php 
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="csrf-token" content="{{ csrf_token() }}">

    @vite(['resources/css/app.css', 'resources/js/app.js'])
</head>
<body>
    @yield('content')
    @neuraKit
</body>
</html>
04

Compile

Use the command that matches the toolchain you kept.

Vite.js

npm 
npm run dev

Vite+

vp 
vp dev
vp build

Vite+

Skip this when the project stays on Vite.js. Migrate before neura-kit:install , so the plugin is written into the new config.
01

Install the CLI

On Windows, run irm https://vite.plus/ps1 | iex.

macOS / Linux 
curl -fsSL https://vite.plus | bash
02

Migrate the app

This writes vite.config.ts for an existing Laravel project.

vp 
vp migrate
03

Register the plugin

Same command as Install, step 02. Then compile with vp dev.

artisan 
php artisan neura-kit:install

After install

Chart, editor, flow, and orb are native and need no extra npm packages. This command only checks, and reports when nothing is missing.
artisan 
php artisan neura-kit:install-deps
composer 
composer update neura-ui/neura-kit
If you published component views, read the changelog before updating. Colors, tokens, and published views are covered in Theming.
Usage Call a component from a Blade view. Theming Colors, tokens, and published views.