@fairyhunter13/opentui-spinner 0.0.1

package/dist/index-CSHLsh12.d.mts

@@ -0,0 +1,80 @@
+import { ColorInput, LayoutOptions, OptimizedBuffer, RenderContext, Renderable, RenderableOptions } from "@fairyhunter13/opentui-core";
+import spinners from "cli-spinners";
+
+//#region src/utils.d.ts
+
+/**
+ * Function that generates a color for a specific character at a specific frame
+ * @param frameIndex - Current frame index (0 to totalFrames-1)
+ * @param charIndex - Current character index (0 to totalChars-1)
+ * @param totalFrames - Total number of frames in the animation
+ * @param totalChars - Total number of characters in the current frame
+ * @returns Color for this specific character at this specific frame
+ */
+type ColorGenerator = (frameIndex: number, charIndex: number, totalFrames: number, totalChars: number) => ColorInput;
+/**
+ * Creates a pulsing color effect that cycles through colors
+ * @example
+ * ```typescript
+ * const colorGen = createPulse(["red", "orange", "yellow"], 0.5);
+ * ```
+ */
+declare function createPulse(colors: ColorInput[], speed?: number): ColorGenerator;
+/**
+ * Creates a wave pattern that moves across characters
+ * @example
+ * ```typescript
+ * const colorGen = createWave(["#ff0000", "#00ff00", "#0000ff"]);
+ * ```
+ */
+declare function createWave(colors: ColorInput[]): ColorGenerator;
+//#endregion
+//#region src/index.d.ts
+type SpinnerName = keyof typeof spinners;
+interface SpinnerOptions extends Omit<RenderableOptions<SpinnerRenderable>, "width" | "height" | "buffered" | "live" | keyof LayoutOptions> {
+  name?: SpinnerName;
+  frames?: string[];
+  interval?: number;
+  autoplay?: boolean;
+  backgroundColor?: ColorInput;
+  color?: ColorInput | ColorGenerator;
+}
+declare class SpinnerRenderable extends Renderable {
+  private _name;
+  private _frames;
+  private _interval;
+  private _autoplay;
+  private _backgroundColor;
+  private _color;
+  private _currentFrameIndex;
+  private _encodedFrames;
+  private _lib;
+  private _intervalId;
+  protected _defaultOptions: {
+    name: "dots";
+    frames: string[];
+    interval: number;
+    autoplay: true;
+    backgroundColor: string;
+    color: string;
+  };
+  constructor(ctx: RenderContext, options: SpinnerOptions);
+  private _encodeFrames;
+  private _freeFrames;
+  get interval(): number;
+  set interval(value: number);
+  get name(): SpinnerName | undefined;
+  set name(value: SpinnerName | undefined);
+  get frames(): string[];
+  set frames(value: string[]);
+  get color(): ColorInput | ColorGenerator;
+  set color(value: ColorInput | ColorGenerator);
+  get backgroundColor(): ColorInput;
+  set backgroundColor(value: ColorInput);
+  start(): void;
+  stop(): void;
+  protected renderSelf(buffer: OptimizedBuffer): void;
+  protected destroySelf(): void;
+}
+//#endregion
+export { createWave as a, createPulse as i, SpinnerRenderable as n, ColorGenerator as r, SpinnerOptions as t };

package/dist/index.d.mts

@@ -0,0 +1,2 @@
+import { a as createWave, i as createPulse, n as SpinnerRenderable, r as ColorGenerator, t as SpinnerOptions } from "./index-CSHLsh12.mjs";
+export { ColorGenerator, SpinnerOptions, SpinnerRenderable, createPulse, createWave };

package/dist/index.mjs

@@ -0,0 +1 @@
+import{n as e,r as t,t as n}from"./src-DJPZjJMl.mjs";export{n as SpinnerRenderable,e as createPulse,t as createWave};

package/dist/solid.d.mts

@@ -0,0 +1,8 @@
+import { n as SpinnerRenderable } from "./index-CSHLsh12.mjs";
+
+//#region src/solid.d.ts
+declare module "@fairyhunter13/opentui-solid" {
+  interface OpenTUIComponents {
+    spinner: typeof SpinnerRenderable;
+  }
+}

package/dist/solid.mjs

@@ -0,0 +1 @@
+import{t as e}from"./src-DJPZjJMl.mjs";import{extend as t}from"@fairyhunter13/opentui-solid";t({spinner:e});export{};

package/dist/src-DJPZjJMl.mjs

@@ -0,0 +1 @@
+import{Renderable as e,parseColor as t,resolveRenderLib as n}from"@fairyhunter13/opentui-core";import r from"cli-spinners";function i(e,t=1){return n=>e[Math.floor(n*t)%e.length]}function a(e){return(t,n,r,i)=>{let a=(n+t)%i;return e[Math.floor(a/i*e.length)]??e[0]}}var o=class extends e{_name;_frames;_interval;_autoplay;_backgroundColor;_color;_currentFrameIndex=0;_encodedFrames={};_lib=n();_intervalId=null;_defaultOptions={name:`dots`,frames:r.dots.frames,interval:r.dots.interval,autoplay:!0,backgroundColor:`transparent`,color:`white`};constructor(e,t){super(e,t),this._name=t.name,this._frames=this._name?r[this._name].frames:t.frames??this._defaultOptions.frames,this._interval=this._name?r[this._name].interval:t.interval??this._defaultOptions.interval,this._autoplay=t.autoplay??this._defaultOptions.autoplay,this._backgroundColor=t.backgroundColor??this._defaultOptions.backgroundColor,this._color=t.color??this._defaultOptions.color,this.width=Math.max(...this._frames.map(e=>e.length)),this.height=1,this._encodeFrames(),this._autoplay&&this.start()}_encodeFrames(){for(let e of this._frames){let t=this._lib.encodeUnicode(e,this.ctx.widthMethod);t&&(this._encodedFrames[e]=t)}}_freeFrames(){for(let e in this._encodedFrames)this._encodedFrames[e]&&this._lib.freeUnicode(this._encodedFrames[e]);this._encodedFrames={}}get interval(){return this._interval}set interval(e){this.stop(),this._interval=e,this.start()}get name(){return this._name}set name(e){this._freeFrames(),this._name=e,this._frames=this._name?r[this._name].frames:this._defaultOptions.frames,this._interval=this._name?r[this._name].interval:this._defaultOptions.interval,this.width=Math.max(...this._frames.map(e=>e.length)),this._encodeFrames(),this.requestRender()}get frames(){return this._frames}set frames(e){this._freeFrames(),this._frames=e.length===0?this._defaultOptions.frames:e,this._encodeFrames(),this.width=Math.max(...this._frames.map(e=>e.length)),this.requestRender()}get color(){return this._color}set color(e){this._color=e,this.requestRender()}get backgroundColor(){return this._backgroundColor}set backgroundColor(e){this._backgroundColor=e,this.requestRender()}start(){this._intervalId||=setInterval(()=>{this._currentFrameIndex=(this._currentFrameIndex+1)%this._frames.length,this.requestRender()},this._interval)}stop(){this._intervalId&&=(clearInterval(this._intervalId),null)}renderSelf(e){if(!this.visible)return;let n=this._frames[this._currentFrameIndex];if(!n)return;let r=this._encodedFrames[n];if(!r)return;let i=this.x;for(let n=0;n<r.data.length;n++){let a=typeof this._color==`function`?this._color(this._currentFrameIndex,n,this._frames.length,r.data.length):this._color;e.drawChar(r.data[n].char,i,this.y,t(a),t(this._backgroundColor)),i+=r.data[n].width}}destroySelf(){this.stop(),this._freeFrames(),super.destroySelf()}};export{i as n,a as r,o as t};

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@fairyhunter13/opentui-spinner",
+  "version": "0.0.1",
+  "description": "A small & opinionated spinner library",
+  "license": "MIT",
+  "type": "module",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.mts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      }
+    },
+    "./solid": {
+      "import": {
+        "types": "./dist/solid.d.mts",
+        "default": "./dist/solid.mjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "lint": "biome check .",
+    "lint:fix": "biome check . --write"
+  },
+  "keywords": [
+    "opentui",
+    "spinner",
+    "cli",
+    "terminal",
+    "console",
+    "tui"
+  ],
+  "dependencies": {
+    "cli-spinners": "^3.3.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.3.4",
+    "@fairyhunter13/opentui-core": "^0.1.113",
+    "@fairyhunter13/opentui-solid": "^0.1.113",
+    "@types/bun": "latest",
+    "tsdown": "^0.16.0"
+  },
+  "peerDependencies": {
+    "@fairyhunter13/opentui-core": "^0.1.113",
+    "@fairyhunter13/opentui-solid": "^0.1.113",
+    "typescript": "^5"
+  },
+  "peerDependenciesMeta": {
+    "@fairyhunter13/opentui-solid": {
+      "optional": true
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fairyhunter13/opentui-spinner.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}