TypeScript icon, indicating that this package has built-in type declarations

4.0.1 • Public • Published


A Vite plugin for developing LeanIX Custom Reports.

Get Started

  1. Install vite and this plugin with your favorite package manager, here use npm as example:
npm install vite vite-plugin-lxr
  1. Create a vite.config.ts file in your project root to config vite to actually use this plugin:
   import { defineConfig } from 'vite'
   import leanix from 'vite-plugin-lxr'
   import { fileURLToPath, URL } from 'node:url'

   export default defineConfig({
     plugins: [leanix()],
     resolve: {
       alias: {
         '@': fileURLToPath(new URL('./src', import.meta.url))
     build: {
       rollupOptions: {
         input: {
           app: './index.html'
  1. Create an ./index.html file that will be the entry point to you app:
<!DOCTYPE html>
<html lang="en">
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Vite App</title>
    <div id="app"></div>
    <script type="module" src="/src/main.js"></script>
  1. Create an ./src/main.js file that you can use to add some behavior to your HTML page and/or import a framework such as Vue, React, etc.

  2. Add the following commands to the "script" section of your package.json file:

  "scripts": {
    "dev": "vite",
    "build": "vite build",
    "upload": "vite build --mode upload"
  1. Create a new section in the package.json file as follows:
  "leanixReport": {
    "id": "<your report id in dot notation, e.g.>",
    "title": "Your Report Title",
    "defaultConfig": {}
  1. Finally add a lxr.json file into your project root folder with the following contents:
  "host": "<your workspace instance here, e.g.>",
  "apitoken": "<your workspace api token here>"
  1. You are now ready to start developing your report by issuing the following command
npm run dev


DownloadsWeekly Downloads






Unpacked Size

5.26 MB

Total Files


Last publish


  • pauloramires