ink 6.2.3 → 6.3.1

package/build/options.d.ts

@@ -0,0 +1,52 @@
+export type CommonOptions = {
+    /**
+     * Output stream where app will be rendered.
+     *
+     * @default process.stdout
+     */
+    stdout?: NodeJS.WriteStream;
+    /**
+     * Input stream where app will listen for input.
+     *
+     * @default process.stdin
+     */
+    stdin?: NodeJS.ReadStream;
+    /**
+     * Error stream.
+     * @default process.stderr
+     */
+    stderr?: NodeJS.WriteStream;
+    /**
+     * If true, each update will be rendered as a separate output, without replacing the previous one.
+     *
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Configure whether Ink should listen to Ctrl+C keyboard input and exit the app. This is needed in case `process.stdin` is in raw mode, because then Ctrl+C is ignored by default and process is expected to handle it manually.
+     *
+     * @default true
+     */
+    exitOnCtrlC?: boolean;
+    /**
+     * Patch console methods to ensure console output doesn't mix with Ink output.
+     *
+     * @default true
+     */
+    patchConsole?: boolean;
+    /**
+     * Enable screen reader support.
+     * See https://github.com/vadimdemedes/ink/blob/master/readme.md#screen-reader-support
+     *
+     * @default process.env['INK_SCREEN_READER'] === 'true'
+     */
+    isScreenReaderEnabled?: boolean;
+    /**
+     * Maximum frames per second for render updates.
+     * This controls how frequently the UI can update to prevent excessive re-rendering.
+     * Higher values allow more frequent updates but may impact performance.
+     *
+     * @default 30
+     */
+    maxFps?: number;
+};

package/build/options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=options.js.map

package/build/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":""}

package/build/output.d.ts

@@ -1,12 +1,11 @@
 import { type OutputTransformer } from './render-node-to-output.js';
 /**
- * "Virtual" output class
- *
- * Handles the positioning and saving of the output of each node in the tree.
- * Also responsible for applying transformations to each character of the output.
- *
- * Used to generate the final output of all nodes before writing it to actual output stream (e.g. stdout)
- */
+"Virtual" output class
+
+Handles the positioning and saving of the output of each node in the tree. Also responsible for applying transformations to each character of the output.
+
+Used to generate the final output of all nodes before writing it to actual output stream (e.g. stdout)
+*/
 type Options = {
     width: number;
     height: number;

package/build/output.js.map

@@ -1 +1 @@
-{"version":3,"file":"output.js","sourceRoot":"","sources":["../src/output.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,WAAW,MAAM,cAAc,CAAC;AACvC,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,EAEN,qBAAqB,EACrB,mBAAmB,EACnB,QAAQ,GACR,MAAM,0BAA0B,CAAC;AA2ClC,MAAM,CAAC,OAAO,OAAO,MAAM;IAC1B,KAAK,CAAS;IACd,MAAM,CAAS;IAEE,UAAU,GAAgB,EAAE,CAAC;IAE9C,YAAY,OAAgB;QAC3B,MAAM,EAAC,KAAK,EAAE,MAAM,EAAC,GAAG,OAAO,CAAC;QAEhC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED,KAAK,CACJ,CAAS,EACT,CAAS,EACT,IAAY,EACZ,OAA4C;QAE5C,MAAM,EAAC,YAAY,EAAC,GAAG,OAAO,CAAC;QAE/B,IAAI,CAAC,IAAI,EAAE,CAAC;YACX,OAAO;QACR,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACpB,IAAI,EAAE,OAAO;YACb,CAAC;YACD,CAAC;YACD,IAAI;YACJ,YAAY;SACZ,CAAC,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,IAAU;QACd,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACpB,IAAI,EAAE,MAAM;YACZ,IAAI;SACJ,CAAC,CAAC;IACJ,CAAC;IAED,MAAM;QACL,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACpB,IAAI,EAAE,QAAQ;SACd,CAAC,CAAC;IACJ,CAAC;IAED,GAAG;QACF,yGAAyG;QACzG,MAAM,MAAM,GAAmB,EAAE,CAAC;QAElC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,GAAG,GAAiB,EAAE,CAAC;YAE7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;gBACrC,GAAG,CAAC,IAAI,CAAC;oBACR,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE,GAAG;oBACV,SAAS,EAAE,KAAK;oBAChB,MAAM,EAAE,EAAE;iBACV,CAAC,CAAC;YACJ,CAAC;YAED,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;QAED,MAAM,KAAK,GAAW,EAAE,CAAC;QAEzB,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACzC,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBAC/B,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;YAED,IAAI,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACjC,KAAK,CAAC,GAAG,EAAE,CAAC;YACb,CAAC;YAED,IAAI,SAAS,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;gBAChC,MAAM,EAAC,IAAI,EAAE,YAAY,EAAC,GAAG,SAAS,CAAC;gBACvC,IAAI,EAAC,CAAC,EAAE,CAAC,EAAC,GAAG,SAAS,CAAC;gBACvB,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAE7B,MAAM,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE1B,IAAI,IAAI,EAAE,CAAC;oBACV,MAAM,gBAAgB,GACrB,OAAO,IAAI,EAAE,EAAE,KAAK,QAAQ,IAAI,OAAO,IAAI,EAAE,EAAE,KAAK,QAAQ,CAAC;oBAE9D,MAAM,cAAc,GACnB,OAAO,IAAI,EAAE,EAAE,KAAK,QAAQ,IAAI,OAAO,IAAI,EAAE,EAAE,KAAK,QAAQ,CAAC;oBAE9D,6DAA6D;oBAC7D,+DAA+D;oBAC/D,IAAI,gBAAgB,EAAE,CAAC;wBACtB,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;wBAE/B,IAAI,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC,EAAG,IAAI,CAAC,GAAG,IAAI,CAAC,EAAG,EAAE,CAAC;4BAC1C,SAAS;wBACV,CAAC;oBACF,CAAC;oBAED,IAAI,cAAc,EAAE,CAAC;wBACpB,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;wBAE5B,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,EAAG,IAAI,CAAC,GAAG,IAAI,CAAC,EAAG,EAAE,CAAC;4BAC3C,SAAS;wBACV,CAAC;oBACF,CAAC;oBAED,IAAI,gBAAgB,EAAE,CAAC;wBACtB,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;4BACxB,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,EAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;4BAC7C,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;4BAChC,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC,EAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;4BAEvD,OAAO,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;wBAClC,CAAC,CAAC,CAAC;wBAEH,IAAI,CAAC,GAAG,IAAI,CAAC,EAAG,EAAE,CAAC;4BAClB,CAAC,GAAG,IAAI,CAAC,EAAG,CAAC;wBACd,CAAC;oBACF,CAAC;oBAED,IAAI,cAAc,EAAE,CAAC;wBACpB,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,EAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;wBAC7C,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;wBAC5B,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,EAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAG,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;wBAEzD,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;wBAE9B,IAAI,CAAC,GAAG,IAAI,CAAC,EAAG,EAAE,CAAC;4BAClB,CAAC,GAAG,IAAI,CAAC,EAAG,CAAC;wBACd,CAAC;oBACF,CAAC;gBACF,CAAC;gBAED,IAAI,OAAO,GAAG,CAAC,CAAC;gBAEhB,KAAK,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;oBAC3C,MAAM,WAAW,GAAG,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC;oBAExC,uFAAuF;oBACvF,IAAI,CAAC,WAAW,EAAE,CAAC;wBAClB,SAAS;oBACV,CAAC;oBAED,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;wBACxC,IAAI,GAAG,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;oBACjC,CAAC;oBAED,MAAM,UAAU,GAAG,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;oBACzD,IAAI,OAAO,GAAG,CAAC,CAAC;oBAEhB,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;wBACpC,WAAW,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;wBAEjC,uEAAuE;wBACvE,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;wBAEjE,qFAAqF;wBACrF,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;4BACxB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,cAAc,EAAE,KAAK,EAAE,EAAE,CAAC;gCACrD,WAAW,CAAC,OAAO,GAAG,KAAK,CAAC,GAAG;oCAC9B,IAAI,EAAE,MAAM;oCACZ,KAAK,EAAE,EAAE;oCACT,SAAS,EAAE,KAAK;oCAChB,MAAM,EAAE,SAAS,CAAC,MAAM;iCACxB,CAAC;4BACH,CAAC;wBACF,CAAC;wBAED,OAAO,IAAI,cAAc,CAAC;oBAC3B,CAAC;oBAED,OAAO,EAAE,CAAC;gBACX,CAAC;YACF,CAAC;QACF,CAAC;QAED,MAAM,eAAe,GAAG,MAAM;aAC5B,GAAG,CAAC,IAAI,CAAC,EAAE;YACX,2EAA2E;YAC3E,MAAM,qBAAqB,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;YAEtE,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,CAAC,OAAO,EAAE,CAAC;QAC7D,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,OAAO;YACN,MAAM,EAAE,eAAe;YACvB,MAAM,EAAE,MAAM,CAAC,MAAM;SACrB,CAAC;IACH,CAAC;CACD"}
+{"version":3,"file":"output.js","sourceRoot":"","sources":["../src/output.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,WAAW,MAAM,cAAc,CAAC;AACvC,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,EAEN,qBAAqB,EACrB,mBAAmB,EACnB,QAAQ,GACR,MAAM,0BAA0B,CAAC;AA0ClC,MAAM,CAAC,OAAO,OAAO,MAAM;IAC1B,KAAK,CAAS;IACd,MAAM,CAAS;IAEE,UAAU,GAAgB,EAAE,CAAC;IAE9C,YAAY,OAAgB;QAC3B,MAAM,EAAC,KAAK,EAAE,MAAM,EAAC,GAAG,OAAO,CAAC;QAEhC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED,KAAK,CACJ,CAAS,EACT,CAAS,EACT,IAAY,EACZ,OAA4C;QAE5C,MAAM,EAAC,YAAY,EAAC,GAAG,OAAO,CAAC;QAE/B,IAAI,CAAC,IAAI,EAAE,CAAC;YACX,OAAO;QACR,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACpB,IAAI,EAAE,OAAO;YACb,CAAC;YACD,CAAC;YACD,IAAI;YACJ,YAAY;SACZ,CAAC,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,IAAU;QACd,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACpB,IAAI,EAAE,MAAM;YACZ,IAAI;SACJ,CAAC,CAAC;IACJ,CAAC;IAED,MAAM;QACL,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACpB,IAAI,EAAE,QAAQ;SACd,CAAC,CAAC;IACJ,CAAC;IAED,GAAG;QACF,yGAAyG;QACzG,MAAM,MAAM,GAAmB,EAAE,CAAC;QAElC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,GAAG,GAAiB,EAAE,CAAC;YAE7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;gBACrC,GAAG,CAAC,IAAI,CAAC;oBACR,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE,GAAG;oBACV,SAAS,EAAE,KAAK;oBAChB,MAAM,EAAE,EAAE;iBACV,CAAC,CAAC;YACJ,CAAC;YAED,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;QAED,MAAM,KAAK,GAAW,EAAE,CAAC;QAEzB,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACzC,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBAC/B,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;YAED,IAAI,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACjC,KAAK,CAAC,GAAG,EAAE,CAAC;YACb,CAAC;YAED,IAAI,SAAS,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;gBAChC,MAAM,EAAC,IAAI,EAAE,YAAY,EAAC,GAAG,SAAS,CAAC;gBACvC,IAAI,EAAC,CAAC,EAAE,CAAC,EAAC,GAAG,SAAS,CAAC;gBACvB,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAE7B,MAAM,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE1B,IAAI,IAAI,EAAE,CAAC;oBACV,MAAM,gBAAgB,GACrB,OAAO,IAAI,EAAE,EAAE,KAAK,QAAQ,IAAI,OAAO,IAAI,EAAE,EAAE,KAAK,QAAQ,CAAC;oBAE9D,MAAM,cAAc,GACnB,OAAO,IAAI,EAAE,EAAE,KAAK,QAAQ,IAAI,OAAO,IAAI,EAAE,EAAE,KAAK,QAAQ,CAAC;oBAE9D,6DAA6D;oBAC7D,+DAA+D;oBAC/D,IAAI,gBAAgB,EAAE,CAAC;wBACtB,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;wBAE/B,IAAI,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC,EAAG,IAAI,CAAC,GAAG,IAAI,CAAC,EAAG,EAAE,CAAC;4BAC1C,SAAS;wBACV,CAAC;oBACF,CAAC;oBAED,IAAI,cAAc,EAAE,CAAC;wBACpB,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;wBAE5B,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,EAAG,IAAI,CAAC,GAAG,IAAI,CAAC,EAAG,EAAE,CAAC;4BAC3C,SAAS;wBACV,CAAC;oBACF,CAAC;oBAED,IAAI,gBAAgB,EAAE,CAAC;wBACtB,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;4BACxB,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,EAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;4BAC7C,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;4BAChC,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC,EAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;4BAEvD,OAAO,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;wBAClC,CAAC,CAAC,CAAC;wBAEH,IAAI,CAAC,GAAG,IAAI,CAAC,EAAG,EAAE,CAAC;4BAClB,CAAC,GAAG,IAAI,CAAC,EAAG,CAAC;wBACd,CAAC;oBACF,CAAC;oBAED,IAAI,cAAc,EAAE,CAAC;wBACpB,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,EAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;wBAC7C,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;wBAC5B,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,EAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAG,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;wBAEzD,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;wBAE9B,IAAI,CAAC,GAAG,IAAI,CAAC,EAAG,EAAE,CAAC;4BAClB,CAAC,GAAG,IAAI,CAAC,EAAG,CAAC;wBACd,CAAC;oBACF,CAAC;gBACF,CAAC;gBAED,IAAI,OAAO,GAAG,CAAC,CAAC;gBAEhB,KAAK,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;oBAC3C,MAAM,WAAW,GAAG,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC;oBAExC,uFAAuF;oBACvF,IAAI,CAAC,WAAW,EAAE,CAAC;wBAClB,SAAS;oBACV,CAAC;oBAED,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;wBACxC,IAAI,GAAG,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;oBACjC,CAAC;oBAED,MAAM,UAAU,GAAG,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;oBACzD,IAAI,OAAO,GAAG,CAAC,CAAC;oBAEhB,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;wBACpC,WAAW,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;wBAEjC,uEAAuE;wBACvE,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;wBAEjE,qFAAqF;wBACrF,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;4BACxB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,cAAc,EAAE,KAAK,EAAE,EAAE,CAAC;gCACrD,WAAW,CAAC,OAAO,GAAG,KAAK,CAAC,GAAG;oCAC9B,IAAI,EAAE,MAAM;oCACZ,KAAK,EAAE,EAAE;oCACT,SAAS,EAAE,KAAK;oCAChB,MAAM,EAAE,SAAS,CAAC,MAAM;iCACxB,CAAC;4BACH,CAAC;wBACF,CAAC;wBAED,OAAO,IAAI,cAAc,CAAC;oBAC3B,CAAC;oBAED,OAAO,EAAE,CAAC;gBACX,CAAC;YACF,CAAC;QACF,CAAC;QAED,MAAM,eAAe,GAAG,MAAM;aAC5B,GAAG,CAAC,IAAI,CAAC,EAAE;YACX,2EAA2E;YAC3E,MAAM,qBAAqB,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;YAEtE,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,CAAC,OAAO,EAAE,CAAC;QAC7D,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,OAAO;YACN,MAAM,EAAE,eAAe;YACvB,MAAM,EAAE,MAAM,CAAC,MAAM;SACrB,CAAC;IACH,CAAC;CACD"}

package/build/render.d.ts

@@ -2,69 +2,76 @@ import type { ReactNode } from 'react';
 import Ink from './ink.js';
 export type RenderOptions = {
     /**
-     * Output stream where app will be rendered.
-     *
-     * @default process.stdout
-     */
+    Output stream where app will be rendered.
+
+    @default process.stdout
+    */
     stdout?: NodeJS.WriteStream;
     /**
-     * Input stream where app will listen for input.
-     *
-     * @default process.stdin
-     */
+    Input stream where app will listen for input.
+
+    @default process.stdin
+    */
     stdin?: NodeJS.ReadStream;
     /**
-     * Error stream.
-     * @default process.stderr
-     */
+    Error stream.
+    @default process.stderr
+    */
     stderr?: NodeJS.WriteStream;
     /**
-     * If true, each update will be rendered as a separate output, without replacing the previous one.
-     *
-     * @default false
-     */
+    If true, each update will be rendered as separate output, without replacing the previous one.
+
+    @default false
+    */
     debug?: boolean;
     /**
-     * Configure whether Ink should listen to Ctrl+C keyboard input and exit the app. This is needed in case `process.stdin` is in raw mode, because then Ctrl+C is ignored by default and process is expected to handle it manually.
-     *
-     * @default true
-     */
+    Configure whether Ink should listen for Ctrl+C keyboard input and exit the app. This is needed in case `process.stdin` is in raw mode, because then Ctrl+C is ignored by default and the process is expected to handle it manually.
+
+    @default true
+    */
     exitOnCtrlC?: boolean;
     /**
-     * Patch console methods to ensure console output doesn't mix with Ink output.
-     *
-     * @default true
-     */
+    Patch console methods to ensure console output doesn't mix with Ink's output.
+
+    @default true
+    */
     patchConsole?: boolean;
     /**
-     * Enable screen reader support.
-     * See https://github.com/vadimdemedes/ink/blob/master/readme.md#screen-reader-support
-     *
-     * @default process.env['INK_SCREEN_READER'] === 'true'
-     */
+    Enable screen reader support. See https://github.com/vadimdemedes/ink/blob/master/readme.md#screen-reader-support
+
+    @default process.env['INK_SCREEN_READER'] === 'true'
+    */
     isScreenReaderEnabled?: boolean;
+    /**
+    Maximum frames per second for render updates.
+    This controls how frequently the UI can update to prevent excessive re-rendering.
+    Higher values allow more frequent updates but may impact performance.
+
+    @default 30
+    */
+    maxFps?: number;
 };
 export type Instance = {
     /**
-     * Replace previous root node with a new one or update props of the current root node.
-     */
+    Replace the previous root node with a new one or update props of the current root node.
+    */
     rerender: Ink['render'];
     /**
-     * Manually unmount the whole Ink app.
-     */
+    Manually unmount the whole Ink app.
+    */
     unmount: Ink['unmount'];
     /**
-     * Returns a promise, which resolves when app is unmounted.
-     */
+    Returns a promise that resolves when the app is unmounted.
+    */
     waitUntilExit: Ink['waitUntilExit'];
     cleanup: () => void;
     /**
-     * Clear output.
-     */
+    Clear output.
+    */
     clear: () => void;
 };
 /**
- * Mount a component and render the output.
- */
+Mount a component and render the output.
+*/
 declare const render: (node: ReactNode, options?: NodeJS.WriteStream | RenderOptions) => Instance;
 export default render;

package/build/render.js

@@ -3,8 +3,8 @@ import process from 'node:process';
 import Ink from './ink.js';
 import instances from './instances.js';
 /**
- * Mount a component and render the output.
- */
+Mount a component and render the output.
+*/
 const render = (node, options) => {
     const inkOptions = {
         stdout: process.stdout,
@@ -13,6 +13,7 @@ const render = (node, options) => {
         debug: false,
         exitOnCtrlC: true,
         patchConsole: true,
+        maxFps: 30,
         ...getOptions(options),
     };
     const instance = getInstance(inkOptions.stdout, () => new Ink(inkOptions));

package/build/render.js.map

@@ -1 +1 @@
-{"version":3,"file":"render.js","sourceRoot":"","sources":["../src/render.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AACnC,OAAO,OAAO,MAAM,cAAc,CAAC;AAEnC,OAAO,GAAiC,MAAM,UAAU,CAAC;AACzD,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAsEvC;;GAEG;AACH,MAAM,MAAM,GAAG,CACd,IAAe,EACf,OAA4C,EACjC,EAAE;IACb,MAAM,UAAU,GAAe;QAC9B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,KAAK,EAAE,KAAK;QACZ,WAAW,EAAE,IAAI;QACjB,YAAY,EAAE,IAAI;QAClB,GAAG,UAAU,CAAC,OAAO,CAAC;KACtB,CAAC;IAEF,MAAM,QAAQ,GAAQ,WAAW,CAChC,UAAU,CAAC,MAAM,EACjB,GAAG,EAAE,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,CACzB,CAAC;IAEF,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAEtB,OAAO;QACN,QAAQ,EAAE,QAAQ,CAAC,MAAM;QACzB,OAAO;YACN,QAAQ,CAAC,OAAO,EAAE,CAAC;QACpB,CAAC;QACD,aAAa,EAAE,QAAQ,CAAC,aAAa;QACrC,OAAO,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC;QAClD,KAAK,EAAE,QAAQ,CAAC,KAAK;KACrB,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,MAAM,CAAC;AAEtB,MAAM,UAAU,GAAG,CAClB,SAAyD,EAAE,EAC3C,EAAE;IAClB,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;QAC9B,OAAO;YACN,MAAM;YACN,KAAK,EAAE,OAAO,CAAC,KAAK;SACpB,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CACnB,MAA0B,EAC1B,cAAyB,EACnB,EAAE;IACR,IAAI,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAErC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACf,QAAQ,GAAG,cAAc,EAAE,CAAC;QAC5B,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,QAAQ,CAAC;AACjB,CAAC,CAAC"}
+{"version":3,"file":"render.js","sourceRoot":"","sources":["../src/render.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AACnC,OAAO,OAAO,MAAM,cAAc,CAAC;AAEnC,OAAO,GAAiC,MAAM,UAAU,CAAC;AACzD,OAAO,SAAS,MAAM,gBAAgB,CAAC;AA8EvC;;EAEE;AACF,MAAM,MAAM,GAAG,CACd,IAAe,EACf,OAA4C,EACjC,EAAE;IACb,MAAM,UAAU,GAAe;QAC9B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,KAAK,EAAE,KAAK;QACZ,WAAW,EAAE,IAAI;QACjB,YAAY,EAAE,IAAI;QAClB,MAAM,EAAE,EAAE;QACV,GAAG,UAAU,CAAC,OAAO,CAAC;KACtB,CAAC;IAEF,MAAM,QAAQ,GAAQ,WAAW,CAChC,UAAU,CAAC,MAAM,EACjB,GAAG,EAAE,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,CACzB,CAAC;IAEF,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAEtB,OAAO;QACN,QAAQ,EAAE,QAAQ,CAAC,MAAM;QACzB,OAAO;YACN,QAAQ,CAAC,OAAO,EAAE,CAAC;QACpB,CAAC;QACD,aAAa,EAAE,QAAQ,CAAC,aAAa;QACrC,OAAO,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC;QAClD,KAAK,EAAE,QAAQ,CAAC,KAAK;KACrB,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,MAAM,CAAC;AAEtB,MAAM,UAAU,GAAG,CAClB,SAAyD,EAAE,EAC3C,EAAE;IAClB,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;QAC9B,OAAO;YACN,MAAM;YACN,KAAK,EAAE,OAAO,CAAC,KAAK;SACpB,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CACnB,MAA0B,EAC1B,cAAyB,EACnB,EAAE;IACR,IAAI,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAErC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACf,QAAQ,GAAG,cAAc,EAAE,CAAC;QAC5B,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,QAAQ,CAAC;AACjB,CAAC,CAAC"}

package/build/styles.d.ts

@@ -6,243 +6,234 @@ export type Styles = {
     readonly textWrap?: 'wrap' | 'end' | 'middle' | 'truncate-end' | 'truncate' | 'truncate-middle' | 'truncate-start';
     readonly position?: 'absolute' | 'relative';
     /**
-     * Size of the gap between an element's columns.
-     */
+    Size of the gap between an element's columns.
+    */
     readonly columnGap?: number;
     /**
-     * Size of the gap between element's rows.
-     */
+    Size of the gap between an element's rows.
+    */
     readonly rowGap?: number;
     /**
-     * Size of the gap between an element's columns and rows. Shorthand for `columnGap` and `rowGap`.
-     */
+    Size of the gap between an element's columns and rows. A shorthand for `columnGap` and `rowGap`.
+    */
     readonly gap?: number;
     /**
-     * Margin on all sides. Equivalent to setting `marginTop`, `marginBottom`, `marginLeft` and `marginRight`.
-     */
+    Margin on all sides. Equivalent to setting `marginTop`, `marginBottom`, `marginLeft`, and `marginRight`.
+    */
     readonly margin?: number;
     /**
-     * Horizontal margin. Equivalent to setting `marginLeft` and `marginRight`.
-     */
+    Horizontal margin. Equivalent to setting `marginLeft` and `marginRight`.
+    */
     readonly marginX?: number;
     /**
-     * Vertical margin. Equivalent to setting `marginTop` and `marginBottom`.
-     */
+    Vertical margin. Equivalent to setting `marginTop` and `marginBottom`.
+    */
     readonly marginY?: number;
     /**
-     * Top margin.
-     */
+    Top margin.
+    */
     readonly marginTop?: number;
     /**
-     * Bottom margin.
-     */
+    Bottom margin.
+    */
     readonly marginBottom?: number;
     /**
-     * Left margin.
-     */
+    Left margin.
+    */
     readonly marginLeft?: number;
     /**
-     * Right margin.
-     */
+    Right margin.
+    */
     readonly marginRight?: number;
     /**
-     * Padding on all sides. Equivalent to setting `paddingTop`, `paddingBottom`, `paddingLeft` and `paddingRight`.
-     */
+    Padding on all sides. Equivalent to setting `paddingTop`, `paddingBottom`, `paddingLeft`, and `paddingRight`.
+    */
     readonly padding?: number;
     /**
-     * Horizontal padding. Equivalent to setting `paddingLeft` and `paddingRight`.
-     */
+    Horizontal padding. Equivalent to setting `paddingLeft` and `paddingRight`.
+    */
     readonly paddingX?: number;
     /**
-     * Vertical padding. Equivalent to setting `paddingTop` and `paddingBottom`.
-     */
+    Vertical padding. Equivalent to setting `paddingTop` and `paddingBottom`.
+    */
     readonly paddingY?: number;
     /**
-     * Top padding.
-     */
+    Top padding.
+    */
     readonly paddingTop?: number;
     /**
-     * Bottom padding.
-     */
+    Bottom padding.
+    */
     readonly paddingBottom?: number;
     /**
-     * Left padding.
-     */
+    Left padding.
+    */
     readonly paddingLeft?: number;
     /**
-     * Right padding.
-     */
+    Right padding.
+    */
     readonly paddingRight?: number;
     /**
-     * This property defines the ability for a flex item to grow if necessary.
-     * See [flex-grow](https://css-tricks.com/almanac/properties/f/flex-grow/).
-     */
+    This property defines the ability for a flex item to grow if necessary.
+    See [flex-grow](https://css-tricks.com/almanac/properties/f/flex-grow/).
+    */
     readonly flexGrow?: number;
     /**
-     * It specifies the “flex shrink factor”, which determines how much the flex item will shrink relative to the rest of the flex items in the flex container when there isn’t enough space on the row.
-     * See [flex-shrink](https://css-tricks.com/almanac/properties/f/flex-shrink/).
-     */
+    It specifies the “flex shrink factor”, which determines how much the flex item will shrink relative to the rest of the flex items in the flex container when there isn’t enough space on the row.
+    See [flex-shrink](https://css-tricks.com/almanac/properties/f/flex-shrink/).
+    */
     readonly flexShrink?: number;
     /**
-     * It establishes the main-axis, thus defining the direction flex items are placed in the flex container.
-     * See [flex-direction](https://css-tricks.com/almanac/properties/f/flex-direction/).
-     */
+    It establishes the main-axis, thus defining the direction flex items are placed in the flex container.
+    See [flex-direction](https://css-tricks.com/almanac/properties/f/flex-direction/).
+    */
     readonly flexDirection?: 'row' | 'column' | 'row-reverse' | 'column-reverse';
     /**
-     * It specifies the initial size of the flex item, before any available space is distributed according to the flex factors.
-     * See [flex-basis](https://css-tricks.com/almanac/properties/f/flex-basis/).
-     */
+    It specifies the initial size of the flex item, before any available space is distributed according to the flex factors.
+    See [flex-basis](https://css-tricks.com/almanac/properties/f/flex-basis/).
+    */
     readonly flexBasis?: number | string;
     /**
-     * It defines whether the flex items are forced in a single line or can be flowed into multiple lines. If set to multiple lines, it also defines the cross-axis which determines the direction new lines are stacked in.
-     * See [flex-wrap](https://css-tricks.com/almanac/properties/f/flex-wrap/).
-     */
+    It defines whether the flex items are forced in a single line or can be flowed into multiple lines. If set to multiple lines, it also defines the cross-axis which determines the direction new lines are stacked in.
+    See [flex-wrap](https://css-tricks.com/almanac/properties/f/flex-wrap/).
+    */
     readonly flexWrap?: 'nowrap' | 'wrap' | 'wrap-reverse';
     /**
-     * The align-items property defines the default behavior for how items are laid out along the cross axis (perpendicular to the main axis).
-     * See [align-items](https://css-tricks.com/almanac/properties/a/align-items/).
-     */
+    The align-items property defines the default behavior for how items are laid out along the cross axis (perpendicular to the main axis).
+    See [align-items](https://css-tricks.com/almanac/properties/a/align-items/).
+    */
     readonly alignItems?: 'flex-start' | 'center' | 'flex-end' | 'stretch';
     /**
-     * It makes possible to override the align-items value for specific flex items.
-     * See [align-self](https://css-tricks.com/almanac/properties/a/align-self/).
-     */
+    It makes possible to override the align-items value for specific flex items.
+    See [align-self](https://css-tricks.com/almanac/properties/a/align-self/).
+    */
     readonly alignSelf?: 'flex-start' | 'center' | 'flex-end' | 'auto';
     /**
-     * It defines the alignment along the main axis.
-     * See [justify-content](https://css-tricks.com/almanac/properties/j/justify-content/).
-     */
+    It defines the alignment along the main axis.
+    See [justify-content](https://css-tricks.com/almanac/properties/j/justify-content/).
+    */
     readonly justifyContent?: 'flex-start' | 'flex-end' | 'space-between' | 'space-around' | 'space-evenly' | 'center';
     /**
-     * Width of the element in spaces.
-     * You can also set it in percent, which will calculate the width based on the width of parent element.
-     */
+    Width of the element in spaces. You can also set it as a percentage, which will calculate the width based on the width of the parent element.
+    */
     readonly width?: number | string;
     /**
-     * Height of the element in lines (rows).
-     * You can also set it in percent, which will calculate the height based on the height of parent element.
-     */
+    Height of the element in lines (rows). You can also set it as a percentage, which will calculate the height based on the height of the parent element.
+    */
     readonly height?: number | string;
     /**
-     * Sets a minimum width of the element.
-     */
+    Sets a minimum width of the element.
+    */
     readonly minWidth?: number | string;
     /**
-     * Sets a minimum height of the element.
-     */
+    Sets a minimum height of the element.
+    */
     readonly minHeight?: number | string;
     /**
-     * Set this property to `none` to hide the element.
-     */
+    Set this property to `none` to hide the element.
+    */
     readonly display?: 'flex' | 'none';
     /**
-     * Add a border with a specified style.
-     * If `borderStyle` is `undefined` (which it is by default), no border will be added.
-     */
+    Add a border with a specified style. If `borderStyle` is `undefined` (the default), no border will be added.
+    */
     readonly borderStyle?: keyof Boxes | BoxStyle;
     /**
-     * Determines whether top border is visible.
-     *
-     * @default true
-     */
+    Determines whether top border is visible.
+    
+    @default true
+    */
     readonly borderTop?: boolean;
     /**
-     * Determines whether bottom border is visible.
-     *
-     * @default true
-     */
+    Determines whether bottom border is visible.
+    
+    @default true
+    */
     readonly borderBottom?: boolean;
     /**
-     * Determines whether left border is visible.
-     *
-     * @default true
-     */
+    Determines whether left border is visible.
+    
+    @default true
+    */
     readonly borderLeft?: boolean;
     /**
-     * Determines whether right border is visible.
-     *
-     * @default true
-     */
+    Determines whether right border is visible.
+    
+    @default true
+    */
     readonly borderRight?: boolean;
     /**
-     * Change border color.
-     * Shorthand for setting `borderTopColor`, `borderRightColor`, `borderBottomColor` and `borderLeftColor`.
-     */
+    Change border color. A shorthand for setting `borderTopColor`, `borderRightColor`, `borderBottomColor`, and `borderLeftColor`.
+    */
     readonly borderColor?: LiteralUnion<ForegroundColorName, string>;
     /**
-     * Change top border color.
-     * Accepts the same values as `color` in `Text` component.
-     */
+    Change top border color. Accepts the same values as `color` in `Text` component.
+    */
     readonly borderTopColor?: LiteralUnion<ForegroundColorName, string>;
     /**
-     * Change bottom border color.
-     * Accepts the same values as `color` in `Text` component.
-     */
+    Change bottom border color. Accepts the same values as `color` in `Text` component.
+    */
     readonly borderBottomColor?: LiteralUnion<ForegroundColorName, string>;
     /**
-     * Change left border color.
-     * Accepts the same values as `color` in `Text` component.
-     */
+    Change left border color. Accepts the same values as `color` in `Text` component.
+    */
     readonly borderLeftColor?: LiteralUnion<ForegroundColorName, string>;
     /**
-     * Change right border color.
-     * Accepts the same values as `color` in `Text` component.
-     */
+    Change right border color. Accepts the same values as `color` in `Text` component.
+    */
     readonly borderRightColor?: LiteralUnion<ForegroundColorName, string>;
     /**
-     * Dim the border color.
-     * Shorthand for setting `borderTopDimColor`, `borderBottomDimColor`, `borderLeftDimColor` and `borderRightDimColor`.
-     *
-     * @default false
-     */
+    Dim the border color. A shorthand for setting `borderTopDimColor`, `borderBottomDimColor`, `borderLeftDimColor`, and `borderRightDimColor`.
+
+    @default false
+    */
     readonly borderDimColor?: boolean;
     /**
-     * Dim the top border color.
-     *
-     * @default false
-     */
+    Dim the top border color.
+    
+    @default false
+    */
     readonly borderTopDimColor?: boolean;
     /**
-     * Dim the bottom border color.
-     *
-     * @default false
-     */
+    Dim the bottom border color.
+    
+    @default false
+    */
     readonly borderBottomDimColor?: boolean;
     /**
-     * Dim the left border color.
-     *
-     * @default false
-     */
+    Dim the left border color.
+    
+    @default false
+    */
     readonly borderLeftDimColor?: boolean;
     /**
-     * Dim the right border color.
-     *
-     * @default false
-     */
+    Dim the right border color.
+    
+    @default false
+    */
     readonly borderRightDimColor?: boolean;
     /**
-     * Behavior for an element's overflow in both directions.
-     *
-     * @default 'visible'
-     */
+    Behavior for an element's overflow in both directions.
+    
+    @default 'visible'
+    */
     readonly overflow?: 'visible' | 'hidden';
     /**
-     * Behavior for an element's overflow in horizontal direction.
-     *
-     * @default 'visible'
-     */
+    Behavior for an element's overflow in the horizontal direction.
+
+    @default 'visible'
+    */
     readonly overflowX?: 'visible' | 'hidden';
     /**
-     * Behavior for an element's overflow in vertical direction.
-     *
-     * @default 'visible'
-     */
+    Behavior for an element's overflow in the vertical direction.
+
+    @default 'visible'
+    */
     readonly overflowY?: 'visible' | 'hidden';
     /**
-     * Background color for the element.
-     *
-     * Accepts the same values as `color` in the `<Text>` component.
-     */
+    Background color for the element.
+    
+    Accepts the same values as `color` in the `<Text>` component.
+    */
     readonly backgroundColor?: LiteralUnion<ForegroundColorName, string>;
 };
 declare const styles: (node: YogaNode, style?: Styles) => void;