@termdraw/opentui 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ben Vinegar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,90 @@
+# @termdraw/opentui
+
+`@termdraw/opentui` provides the embeddable OpenTUI components and renderables behind termDRAW for terminal apps that want an in-process drawing surface.
+
+## What it provides
+
+- `TermDrawApp` for the full chrome with header, palette, footer, and splash
+- `TermDrawEditor` for the bare editor surface
+- `TermDraw` as an alias for `TermDrawApp`
+- renderables and helpers for saved output and CLI help text
+
+## Install
+
+```bash
+npm install @termdraw/opentui @opentui/core @opentui/react react
+```
+
+## Quick start
+
+```tsx
+import { createCliRenderer } from "@opentui/core";
+import { createRoot } from "@opentui/react";
+import { TermDrawApp } from "@termdraw/opentui";
+
+const renderer = await createCliRenderer({
+  useMouse: true,
+  enableMouseMovement: true,
+  autoFocus: true,
+  screenMode: "alternate-screen",
+});
+
+createRoot(renderer).render(
+  <TermDrawApp
+    width="100%"
+    height="100%"
+    autoFocus
+    onSave={(art) => {
+      console.log(art);
+    }}
+    onCancel={() => {
+      renderer.destroy();
+    }}
+  />,
+);
+```
+
+## Also exported
+
+- `TermDrawAppRenderable`
+- `TermDrawEditorRenderable`
+- `TermDrawRenderable`
+- `formatSavedOutput`
+- `buildHelpText`
+- `registerTermDrawComponent`
+- `registerTermDrawComponents`
+
+## Standalone app
+
+If you want the packaged terminal app instead of the embeddable OpenTUI surface:
+
+```bash
+npm install --global @termdraw/app
+```
+
+Then run:
+
+```bash
+termdraw
+```
+
+## Contributing
+
+Contributions are welcome.
+
+Before opening a PR:
+
+- keep the change focused
+- run `bun run check`
+- add or update tests when editor behavior changes
+- open an issue first for larger UX or API changes
+
+## Security
+
+Please report security issues privately through GitHub Security Advisories:
+
+- <https://github.com/benvinegar/termdraw/security/advisories/new>
+
+## License
+
+MIT. See [LICENSE](LICENSE).

package/dist/app.d.ts

@@ -0,0 +1,71 @@
+import { FrameBufferRenderable, type KeyEvent, type MouseEvent, type OptimizedBuffer, type RenderContext, type RenderableOptions } from "@opentui/core";
+type ChromeMode = "full" | "editor";
+export interface TermDrawRenderableOptions extends RenderableOptions<FrameBufferRenderable> {
+    width?: number | "auto" | `${number}%`;
+    height?: number | "auto" | `${number}%`;
+    respectAlpha?: boolean;
+    onSave?: (art: string) => void;
+    onCancel?: () => void;
+    autoFocus?: boolean;
+    showStartupLogo?: boolean;
+    cancelOnCtrlC?: boolean;
+    footerText?: string;
+    chromeMode?: ChromeMode;
+}
+export declare class TermDrawRenderable extends FrameBufferRenderable {
+    private readonly state;
+    private readonly chromeMode;
+    private onSaveCallback;
+    private onCancelCallback;
+    private autoFocusEnabled;
+    private startupLogoEnabled;
+    private startupLogoDismissed;
+    private cancelOnCtrlCEnabled;
+    private footerTextOverride;
+    constructor(ctx: RenderContext, options?: TermDrawRenderableOptions);
+    set onSave(handler: ((art: string) => void) | undefined);
+    set onCancel(handler: (() => void) | undefined);
+    set autoFocus(value: boolean | undefined);
+    set showStartupLogo(value: boolean | undefined);
+    set cancelOnCtrlC(value: boolean | undefined);
+    set footerText(value: string | undefined);
+    exportArt(): string;
+    protected onResize(width: number, height: number): void;
+    protected onMouseEvent(event: MouseEvent): void;
+    protected renderSelf(buffer: OptimizedBuffer): void;
+    handleKeyPress(key: KeyEvent): boolean;
+    private dismissStartupLogo;
+    private syncCanvasLayout;
+    private getLayout;
+    private getPaletteButtonLeft;
+    private getToolButtons;
+    private getBoxStyleButtons;
+    private getColorSwatches;
+    private isCanvasChromeEvent;
+    private drawTooSmallMessage;
+    private drawChrome;
+    private drawHeaderRow;
+    private drawHeaderDivider;
+    private drawFooterRow;
+    private drawToolPalette;
+    private drawToolButton;
+    private drawBoxStyleButton;
+    private drawColorPicker;
+    private drawColorSwatch;
+    private drawCanvas;
+    private drawStartupLogo;
+    private drawOuterSideBorders;
+    private drawHorizontalBorder;
+}
+export type TermDrawAppRenderableOptions = Omit<TermDrawRenderableOptions, "chromeMode">;
+export type TermDrawEditorRenderableOptions = Omit<TermDrawRenderableOptions, "chromeMode">;
+export declare class TermDrawAppRenderable extends TermDrawRenderable {
+    constructor(ctx: RenderContext, options?: TermDrawAppRenderableOptions);
+}
+export declare class TermDrawEditorRenderable extends TermDrawRenderable {
+    constructor(ctx: RenderContext, options?: TermDrawEditorRenderableOptions);
+}
+export declare function formatSavedOutput(art: string, fenced: boolean): string;
+export declare function buildHelpText(binaryName?: string): string;
+export {};
+//# sourceMappingURL=app.d.ts.map

package/dist/app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EAIrB,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACvB,MAAM,eAAe,CAAC;AAsDvB,KAAK,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAC;AAyIpC,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB,CAAC,qBAAqB,CAAC;IACzF,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC;IACvC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC;IACxC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED,qBAAa,kBAAmB,SAAQ,qBAAqB;IAC3D,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAY;IAClC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,cAAc,CAAwC;IAC9D,OAAO,CAAC,gBAAgB,CAA6B;IACrD,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,kBAAkB,CAAQ;IAClC,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,kBAAkB,CAAuB;gBAErC,GAAG,EAAE,aAAa,EAAE,OAAO,GAAE,yBAA8B;IA2CvE,IAAW,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC,GAAG,SAAS,EAE7D;IAED,IAAW,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,EAEpD;IAED,IAAW,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS,EAS9C;IAED,IAAW,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS,EAMpD;IAED,IAAW,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS,EAElD;IAED,IAAW,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAG9C;IAEM,SAAS,IAAI,MAAM;cAIP,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;cAK7C,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;cA0ErC,UAAU,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI;IAoB5C,cAAc,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO;IAmMtD,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,gBAAgB;IAWxB,OAAO,CAAC,SAAS;IAiBjB,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,cAAc;IA8DtB,OAAO,CAAC,kBAAkB;IAgB1B,OAAO,CAAC,gBAAgB;IAiBxB,OAAO,CAAC,mBAAmB;IAS3B,OAAO,CAAC,mBAAmB;IAwB3B,OAAO,CAAC,UAAU;IAiBlB,OAAO,CAAC,aAAa;IA8FrB,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,eAAe;IAmBvB,OAAO,CAAC,cAAc;IA4CtB,OAAO,CAAC,kBAAkB;IAe1B,OAAO,CAAC,eAAe;IAgBvB,OAAO,CAAC,eAAe;IAevB,OAAO,CAAC,UAAU;IAiDlB,OAAO,CAAC,eAAe;IAkDvB,OAAO,CAAC,oBAAoB;IAK5B,OAAO,CAAC,oBAAoB;CAO7B;AAED,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,yBAAyB,EAAE,YAAY,CAAC,CAAC;AACzF,MAAM,MAAM,+BAA+B,GAAG,IAAI,CAAC,yBAAyB,EAAE,YAAY,CAAC,CAAC;AAE5F,qBAAa,qBAAsB,SAAQ,kBAAkB;gBAC/C,GAAG,EAAE,aAAa,EAAE,OAAO,GAAE,4BAAiC;CAG3E;AAED,qBAAa,wBAAyB,SAAQ,kBAAkB;gBAClD,GAAG,EAAE,aAAa,EAAE,OAAO,GAAE,+BAAoC;CAO9E;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,CAItE;AAED,wBAAgB,aAAa,CAAC,UAAU,SAAa,GAAG,MAAM,CA0B7D"}