Skip to main content

Types (ui)

Types & Interfaces​

HexaUiCompilerOptions​

import { HexaUiCompilerOptions } from '@hexajs-dev/ui';
interface HexaUiCompilerOptions {
    minify: false | 'esbuild' | 'terser';
    cssMinify: boolean | 'esbuild' | 'lightningcss';
    sourceMap: boolean | 'inline' | 'hidden';
    terserOptions: Record<string, unknown>;
}

HexaUiConfig​

import { HexaUiConfig } from '@hexajs-dev/ui';
interface HexaUiConfig {
    popup?: HexaUiSurfaceConfig;
    devtools?: HexaUiSurfaceConfig;
}

HexaUiSurfaceConfig​

import { HexaUiSurfaceConfig } from '@hexajs-dev/ui';
interface HexaUiSurfaceConfig {
    mode?: HexaUiMode;
    sourceDir?: string;
    distDir?: string;
    indexFile?: string;
    viteConfig?: string;
}

ManifestUiEntries​

Resolved output paths for each UI surface, written into the extension manifest

import { ManifestUiEntries } from '@hexajs-dev/ui';
interface ManifestUiEntries {
    popup?: string;
    devtools?: string;
}

HexaUiMode​

import { HexaUiMode } from '@hexajs-dev/ui';
type HexaUiMode = 'managed' | 'external' | 'none';

HexaUiSurface​

import { HexaUiSurface } from '@hexajs-dev/ui';
type HexaUiSurface = 'popup' | 'devtools';