cli-menu-kit 0.2.0 → 0.2.1

package/dist/page-layout.d.ts

@@ -10,14 +10,34 @@
  */
 export interface HeaderConfig {
     type: 'simple' | 'section' | 'full' | 'none';
+    topBlankLines?: number;
     text?: string;
     width?: number;
     asciiArt?: string[];
+    figletText?: string;
+    figletFont?: string;
+    figletSize?: 'small' | 'medium' | 'large';
+    figletScale?: number;
+    boxWidth?: number;
+    showBoxBorder?: boolean;
+    fillBox?: boolean;
+    fillBoxColor?: string;
+    fillBoxGradientStart?: string;
+    fillBoxGradientEnd?: string;
     title?: string;
+    titleColor?: string;
+    titleGradientStart?: string;
+    titleGradientEnd?: string;
     description?: string;
+    descriptionColor?: string;
+    descriptionGradientStart?: string;
+    descriptionGradientEnd?: string;
+    asciiArtColor?: string;
     version?: string;
     url?: string;
     menuTitle?: string;
+    asciiArtGradientStart?: string;
+    asciiArtGradientEnd?: string;
 }
 /**
  * Main Area configuration
@@ -29,6 +49,8 @@ export interface MainAreaConfig {
         allowLetterKeys?: boolean;
         allowNumberKeys?: boolean;
         preserveOnSelect?: boolean;
+        preserveOnExit?: boolean;
+        onExit?: () => void;
     };
     render?: () => void | Promise<void>;
 }
@@ -41,16 +63,25 @@ export interface FooterConfig {
         allowLetterKeys?: boolean;
         allowNumberKeys?: boolean;
         preserveOnSelect?: boolean;
+        preserveOnExit?: boolean;
+        onExit?: () => void;
     };
     ask?: {
         question: string;
+        helperText?: string;
         defaultValue?: boolean;
         horizontal?: boolean;
+        preserveOnSelect?: boolean;
+        preserveOnExit?: boolean;
+        onExit?: () => void;
     };
     input?: {
         prompt: string;
         defaultValue?: string;
         allowEmpty?: boolean;
+        lang?: 'zh' | 'en';
+        preserveOnExit?: boolean;
+        onExit?: () => void;
     };
     hints?: string[];
 }

package/dist/page-layout.js

@@ -18,6 +18,10 @@ function renderHeaderSection(config) {
     if (!config || config.type === 'none') {
         return;
     }
+    const topBlankLines = Math.max(0, config.topBlankLines ?? 0);
+    for (let i = 0; i < topBlankLines; i += 1) {
+        console.log('');
+    }
     if (config.type === 'simple' && config.text) {
         (0, headers_js_1.renderSimpleHeader)(config.text);
     }
@@ -30,11 +34,30 @@ function renderHeaderSection(config) {
         // Render full header WITHOUT menuTitle
         (0, header_js_1.renderHeader)({
             asciiArt: config.asciiArt || [],
+            figletText: config.figletText,
+            figletFont: config.figletFont,
+            figletSize: config.figletSize,
+            figletScale: config.figletScale,
             title: config.title || '',
+            titleColor: config.titleColor,
+            titleGradientStart: config.titleGradientStart,
+            titleGradientEnd: config.titleGradientEnd,
             description: config.description,
+            descriptionColor: config.descriptionColor,
+            descriptionGradientStart: config.descriptionGradientStart,
+            descriptionGradientEnd: config.descriptionGradientEnd,
             version: config.version,
             url: config.url,
-            menuTitle: undefined // Don't render menuTitle in header
+            menuTitle: undefined, // Don't render menuTitle in header
+            boxWidth: config.boxWidth,
+            showBoxBorder: config.showBoxBorder,
+            fillBox: config.fillBox,
+            fillBoxColor: config.fillBoxColor,
+            fillBoxGradientStart: config.fillBoxGradientStart,
+            fillBoxGradientEnd: config.fillBoxGradientEnd,
+            asciiArtGradientStart: config.asciiArtGradientStart,
+            asciiArtGradientEnd: config.asciiArtGradientEnd,
+            asciiArtColor: config.asciiArtColor
         });
     }
 }
@@ -57,7 +80,9 @@ async function renderMainArea(config, hints) {
             options: config.menu.options,
             allowLetterKeys: config.menu.allowLetterKeys ?? true,
             allowNumberKeys: config.menu.allowNumberKeys ?? true,
-            preserveOnSelect: config.menu.preserveOnSelect ?? true
+            preserveOnSelect: config.menu.preserveOnSelect ?? true,
+            preserveOnExit: config.menu.preserveOnExit ?? config.menu.preserveOnSelect ?? false,
+            onExit: config.menu.onExit
         }, hints); // Pass hints as second parameter
         return result;
     }
@@ -82,7 +107,9 @@ async function renderFooterSection(config, hints) {
             options: config.menu.options,
             allowLetterKeys: config.menu.allowLetterKeys ?? true,
             allowNumberKeys: config.menu.allowNumberKeys ?? true,
-            preserveOnSelect: config.menu.preserveOnSelect ?? true
+            preserveOnSelect: config.menu.preserveOnSelect ?? true,
+            preserveOnExit: config.menu.preserveOnExit ?? config.menu.preserveOnSelect ?? false,
+            onExit: config.menu.onExit
         }, hints || config.hints);
     }
     // 2. Input (if present)
@@ -90,14 +117,23 @@ async function renderFooterSection(config, hints) {
         result = await api_js_1.inputAPI.text({
             prompt: config.input.prompt,
             defaultValue: config.input.defaultValue,
-            allowEmpty: config.input.allowEmpty ?? false
+            allowEmpty: config.input.allowEmpty ?? false,
+            lang: config.input.lang,
+            preserveOnExit: config.input.preserveOnExit,
+            onExit: config.input.onExit
         });
     }
     // 3. Ask (if present)
     else if (config.ask) {
-        const askResult = config.ask.horizontal
-            ? await api_js_1.menuAPI.booleanH(config.ask.question, config.ask.defaultValue ?? false)
-            : await api_js_1.menuAPI.booleanV(config.ask.question, config.ask.defaultValue ?? false);
+        const askResult = await api_js_1.menuAPI.boolean({
+            question: config.ask.question,
+            helperText: config.ask.helperText,
+            defaultValue: config.ask.defaultValue ?? false,
+            orientation: config.ask.horizontal ? 'horizontal' : 'vertical',
+            preserveOnSelect: config.ask.preserveOnSelect ?? false,
+            preserveOnExit: config.ask.preserveOnExit ?? config.ask.preserveOnSelect ?? false,
+            onExit: config.ask.onExit
+        });
         result = askResult;
     }
     return result;
@@ -143,6 +179,9 @@ async function renderPage(config) {
         }
         else if (config.mainArea.render) {
             await config.mainArea.render();
+            // Add newline after custom render to separate from footer menu
+            // This ensures the escape codes from initTerminal don't interfere
+            console.log('');
         }
         // Render footer with hints
         const footerResult = await renderFooterSection(config.footer, config.footer.hints);

package/dist/types/input.types.d.ts

@@ -5,6 +5,8 @@
  * Base input configuration
  */
 export interface BaseInputConfig {
+    /** UI language (default: current i18n language) */
+    lang?: 'zh' | 'en';
     /** Input prompt text */
     prompt: string;
     /** Default value */
@@ -15,6 +17,8 @@ export interface BaseInputConfig {
     errorMessage?: string;
     /** Goodbye message function */
     onExit?: () => void;
+    /** Keep current input rendered on Ctrl+C exit instead of clearing (default: false) */
+    preserveOnExit?: boolean;
 }
 /**
  * Text input configuration
@@ -58,6 +62,8 @@ export interface LanguageSelectorConfig {
     prompt?: string;
     /** Goodbye message function */
     onExit?: () => void;
+    /** Keep current selector rendered on Ctrl+C exit instead of clearing (default: false) */
+    preserveOnExit?: boolean;
 }
 /**
  * Modify field configuration
@@ -75,6 +81,8 @@ export interface ModifyFieldConfig {
     validate?: (value: string) => boolean | string;
     /** Goodbye message function */
     onExit?: () => void;
+    /** Keep current prompt rendered on Ctrl+C exit instead of clearing (default: false) */
+    preserveOnExit?: boolean;
 }
 /**
  * Input result types

package/dist/types/layout.types.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Layout system types for CLI Menu Kit
+ * Defines how components are composed and rendered
+ */
+/**
+ * Layout element types that can be arranged
+ */
+export type LayoutElement = 'header' | 'options' | 'input' | 'hints' | 'progress';
+/**
+ * Visibility configuration for layout elements
+ */
+export interface LayoutVisibility {
+    header?: boolean;
+    input?: boolean;
+    hints?: boolean;
+    progress?: boolean;
+}
+/**
+ * Spacing configuration for layout elements
+ * Values represent number of blank lines
+ */
+export interface LayoutSpacing {
+    beforeHeader?: number;
+    afterHeader?: number;
+    beforeOptions?: number;
+    afterOptions?: number;
+    beforeInput?: number;
+    afterInput?: number;
+    beforeHints?: number;
+    beforeProgress?: number;
+    afterProgress?: number;
+}
+/**
+ * Complete menu layout configuration
+ */
+export interface MenuLayout {
+    /** Order in which elements are rendered */
+    order: LayoutElement[];
+    /** Which elements are visible */
+    visible: LayoutVisibility;
+    /** Spacing between elements */
+    spacing?: LayoutSpacing;
+}
+/**
+ * Preset layout configurations
+ */
+export declare const LAYOUT_PRESETS: {
+    /** Main menu with header */
+    MAIN_MENU: MenuLayout;
+    /** Sub menu without header */
+    SUB_MENU: MenuLayout;
+    /** Wizard step with progress indicator */
+    WIZARD_STEP: MenuLayout;
+    /** Minimal layout (options only) */
+    MINIMAL: MenuLayout;
+};

package/dist/types/layout.types.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * Layout system types for CLI Menu Kit
+ * Defines how components are composed and rendered
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LAYOUT_PRESETS = void 0;
+/**
+ * Preset layout configurations
+ */
+exports.LAYOUT_PRESETS = {
+    /** Main menu with header */
+    MAIN_MENU: {
+        order: ['header', 'options', 'input', 'hints'],
+        visible: { header: true, input: true, hints: true },
+        spacing: { afterHeader: 1, afterOptions: 1, beforeHints: 1 }
+    },
+    /** Sub menu without header */
+    SUB_MENU: {
+        order: ['options', 'input', 'hints'],
+        visible: { header: false, input: true, hints: true },
+        spacing: { afterOptions: 1, beforeHints: 1 }
+    },
+    /** Wizard step with progress indicator */
+    WIZARD_STEP: {
+        order: ['header', 'progress', 'options', 'input', 'hints'],
+        visible: { header: true, progress: true, input: true, hints: true },
+        spacing: { afterHeader: 1, afterProgress: 1, afterOptions: 1, beforeHints: 1 }
+    },
+    /** Minimal layout (options only) */
+    MINIMAL: {
+        order: ['options'],
+        visible: { header: false, input: false, hints: false },
+        spacing: {}
+    }
+};

package/dist/types/menu.types.d.ts

@@ -27,6 +27,8 @@ export interface BaseMenuConfig {
     separatorWidth?: number;
     /** Keep menu rendered after selection instead of clearing (default: false) */
     preserveOnSelect?: boolean;
+    /** Keep current menu rendered on Ctrl+C exit instead of clearing (default: false) */
+    preserveOnExit?: boolean;
 }
 /**
  * Radio menu (single-select) configuration
@@ -64,6 +66,8 @@ export interface CheckboxMenuConfig extends BaseMenuConfig {
 export interface BooleanMenuConfig extends BaseMenuConfig {
     /** Question text */
     question: string;
+    /** Optional helper text rendered on the next line */
+    helperText?: string;
     /** Default value */
     defaultValue?: boolean;
     /** Yes text */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cli-menu-kit",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A lightweight, customizable CLI menu system with keyboard shortcuts and real-time rendering",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -31,5 +31,8 @@
   },
   "engines": {
     "node": ">=14.0.0"
+  },
+  "dependencies": {
+    "figlet": "^1.10.0"
   }
 }