UNPKG

research-cli

Version:

AI-powered research assistant with web search capabilities and beautiful terminal UI

114 lines 3.49 kB
import { type Options as BoxenOptions } from "boxen"; /** * Box configuration interface extending boxen options */ export interface BoxConfig extends BoxenOptions { /** Text content to display in the box */ content: string; } /** * Predefined box styles for consistent branding */ export declare const BoxStyles: { /** Clean single border box */ readonly default: { readonly borderStyle: "single"; readonly padding: 1; readonly margin: 0; }; /** Emphasized double border box */ readonly emphasized: { readonly borderStyle: "double"; readonly padding: 1; readonly margin: { readonly top: 1; readonly bottom: 1; readonly left: 0; readonly right: 0; }; }; /** Rounded modern box */ readonly modern: { readonly borderStyle: "round"; readonly padding: 1; readonly margin: 0; }; /** Minimal box with no border */ readonly minimal: { readonly borderStyle: "none"; readonly padding: 1; readonly margin: 0; }; /** Error/warning box with bold border */ readonly alert: { readonly borderStyle: "bold"; readonly padding: 1; readonly margin: { readonly top: 1; readonly bottom: 1; readonly left: 0; readonly right: 0; }; readonly borderColor: "red"; }; /** Success box with green border */ readonly success: { readonly borderStyle: "single"; readonly padding: 1; readonly margin: { readonly top: 1; readonly bottom: 1; readonly left: 0; readonly right: 0; }; readonly borderColor: "green"; }; /** Info box with blue border */ readonly info: { readonly borderStyle: "single"; readonly padding: 1; readonly margin: 0; readonly borderColor: "blue"; }; }; /** * Color palette for consistent theming */ export declare const BoxColors: { readonly primary: "blue"; readonly success: "green"; readonly warning: "yellow"; readonly error: "red"; readonly info: "cyan"; readonly muted: "gray"; readonly accent: "magenta"; }; /** * Create a box with specified content and configuration */ export declare function createBox(content: string, config?: Partial<BoxConfig>): string; /** * Create a styled box using predefined styles */ export declare function createStyledBox(content: string, style: keyof typeof BoxStyles, overrides?: Partial<BoxenOptions>): string; /** * Create a titled box with consistent title styling */ export declare function createTitledBox(title: string, content: string, config?: Partial<BoxConfig>): string; /** * Create a centered box that spans available terminal width */ export declare function createCenteredBox(content: string, config?: Partial<BoxConfig>): string; /** * Create a full-width box that spans the terminal */ export declare function createFullWidthBox(content: string, config?: Partial<BoxConfig>): string; /** * Create a compact inline box with minimal spacing */ export declare function createCompactBox(content: string, config?: Partial<BoxConfig>): string; /** * Create a box with dynamic width based on content */ export declare function createAutoWidthBox(content: string, maxWidth: number, config?: Partial<BoxConfig>): string; //# sourceMappingURL=boxes.d.ts.map