Add error handling for dynamic imports

Co-authored-by: Tyriar <2193314+Tyriar@users.noreply.github.com>
Add dynamic imports for AccessibilityManager and OverviewRulerRenderer
2026-01-16 01:58:45 +00:00 · 2026-01-16 01:56:13 +00:00 · 2026-01-16 01:14:01 +00:00 · 2026-01-16 01:12:01 +00:00 · 2026-01-16 00:41:57 +00:00 · 2026-01-16 00:40:40 +00:00
608 changed files with 66325 additions and 19935 deletions
@@ -1,13 +1,15 @@
 {
  "name": "xterm.js",
-  "image": "mcr.microsoft.com/devcontainers/typescript-node:0-18-buster",
+  "image": "mcr.microsoft.com/devcontainers/typescript-node:22-bookworm",
  "features": {
-    "ghcr.io/devcontainers/features/node:1": {} // yarn
+    "ghcr.io/devcontainers/features/node:1": {
      "version": 22
    } // yarn
  },
  "forwardPorts": [
    3000
  ],
-  "postCreateCommand": "yarn install",
+  "postCreateCommand": "npm install && npm run setup",
  "customizations": {
    "vscode": {
      "extensions": [
@@ -5,7 +5,6 @@ indent_style = space
 indent_size = 2
 insert_final_newline = true
 trim_trailing_whitespace = true
 end_of_line = lf
 [*.{j,t}s]
 max_line_length = 100
@@ -1,219 +0,0 @@
 {
  "env": {
    "browser": true,
    "es6": true,
    "node": true
  },
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "project": [
      "demo/tsconfig.json",
      "src/browser/tsconfig.json",
      "src/common/tsconfig.json",
      "src/headless/tsconfig.json",
      "test/api/tsconfig.json",
      "test/benchmark/tsconfig.json",
      "addons/xterm-addon-attach/src/tsconfig.json",
      "addons/xterm-addon-attach/test/tsconfig.json",
      "addons/xterm-addon-canvas/src/tsconfig.json",
      "addons/xterm-addon-fit/src/tsconfig.json",
      "addons/xterm-addon-fit/test/tsconfig.json",
      "addons/xterm-addon-ligatures/src/tsconfig.json",
      "addons/xterm-addon-search/src/tsconfig.json",
      "addons/xterm-addon-search/test/tsconfig.json",
      "addons/xterm-addon-serialize/src/tsconfig.json",
      "addons/xterm-addon-serialize/test/tsconfig.json",
      "addons/xterm-addon-serialize/benchmark/tsconfig.json",
      "addons/xterm-addon-unicode11/src/tsconfig.json",
      "addons/xterm-addon-unicode11/test/tsconfig.json",
      "addons/xterm-addon-web-links/src/tsconfig.json",
      "addons/xterm-addon-web-links/test/tsconfig.json",
      "addons/xterm-addon-webgl/src/tsconfig.json",
      "addons/xterm-addon-webgl/test/tsconfig.json"
    ],
    "sourceType": "module"
  },
  "ignorePatterns": [
    "**/typings/*.d.ts",
    "**/node_modules",
    "**/*.js"
  ],
  "plugins": [
    "@typescript-eslint",
    "jsdoc"
  ],
  "rules": {
    "no-extra-semi": "error",
    "@typescript-eslint/array-type": [
      "warn",
      {
        "default": "array",
        "readonly": "generic"
      }
    ],
    "@typescript-eslint/consistent-type-assertions": "warn",
    "@typescript-eslint/consistent-type-definitions": "warn",
    "@typescript-eslint/explicit-function-return-type": [
      "warn",
      {
        "allowExpressions": true
      }
    ],
    "@typescript-eslint/explicit-member-accessibility": [
      "warn",
      {
        "accessibility": "explicit",
        "overrides": {
          "constructors": "off"
        }
      }
    ],
    "@typescript-eslint/indent": [
      "warn",
      2
    ],
    "@typescript-eslint/member-delimiter-style": [
      "warn",
      {
        "multiline": {
          "delimiter": "semi",
          "requireLast": true
        },
        "singleline": {
          "delimiter": "comma",
          "requireLast": false
        }
      }
    ],
    "@typescript-eslint/naming-convention": [
      "warn",
      { "selector": "default", "format": ["camelCase"] },
      // variableLike
      { "selector": "variable", "format": ["camelCase", "UPPER_CASE"] },
      { "selector": "variable", "filter": "^I.+Service$", "format": ["PascalCase"], "prefix": ["I"] },
      // memberLike
      { "selector": "memberLike", "modifiers": ["private"], "format": ["camelCase"], "leadingUnderscore": "require" },
      { "selector": "memberLike", "modifiers": ["protected"], "format": ["camelCase"], "leadingUnderscore": "require" },
      { "selector": "enumMember", "format": ["UPPER_CASE"] },
      // memberLike - Allow enum-like objects to use UPPER_CASE
      { "selector": "property", "modifiers": ["public"], "format": ["camelCase", "UPPER_CASE"] },
      // restrict on* naming for events only
      { "selector": "method", "modifiers": ["public"], "format": ["camelCase", "UPPER_CASE"], "custom": {
        "regex": "^on[A-Z].+",
        "match": false
      } },
      { "selector": "method", "modifiers": ["private"], "format": ["camelCase"], "leadingUnderscore": "require", "custom": {
        "regex": "^on[A-Z].+",
        "match": false
      } },
      { "selector": "method", "modifiers": ["protected"], "format": ["camelCase"], "leadingUnderscore": "require", "custom": {
        "regex": "^on[A-Z].+",
        "match": false
      } },
      // typeLike
      { "selector": "typeLike", "format": ["PascalCase"] },
      { "selector": "interface", "format": ["PascalCase"], "prefix": ["I"] }
    ],
    "@typescript-eslint/prefer-namespace-keyword": "warn",
    "@typescript-eslint/type-annotation-spacing": "warn",
    "@typescript-eslint/quotes": [
      "warn",
      "single",
      { "allowTemplateLiterals": true }
    ],
    "@typescript-eslint/semi": [
      "warn",
      "always"
    ],
    "comma-dangle": [
      "warn",
      {
        "objects": "never",
        "arrays": "never",
        "functions": "never"
      }
    ],
    "curly": [
      "warn",
      "multi-line"
    ],
    "eol-last": "warn",
    "eqeqeq": [
      "warn",
      "always"
    ],
    "jsdoc/check-alignment": 1,
    "jsdoc/check-param-names": 1,
    "jsdoc/no-multi-asterisks": 1,
    "keyword-spacing": "warn",
    "new-parens": "warn",
    "no-duplicate-imports": "warn",
    "no-else-return": [
      "warn",
      {
        "allowElseIf": false
      }
    ],
    "no-eval": "warn",
    "no-irregular-whitespace": "warn",
    "no-restricted-imports": [
      "warn",
      {
        "patterns": [
          ".*\\/out\\/.*"
        ]
      }
    ],
    "no-restricted-syntax": [
      "warn",
      {
        "selector": "CallExpression[callee.name='requestAnimationFrame']",
        "message": "The global requestAnimationFrame() should be avoided, call it on the parent window from ICoreBrowserService."
      },
      {
        "selector": "CallExpression[callee.name='cancelAnimationFrame']",
        "message": "The global cancelAnimationFrame() should be avoided, call it on the parent window from ICoreBrowserService."
      },
      {
        "selector": "CallExpression > MemberExpression[object.name='window'][property.name='requestAnimationFrame']",
        "message": "window.requestAnimationFrame() should be avoided, call it on the parent window from ICoreBrowserService."
      },
      {
        "selector": "CallExpression > MemberExpression[object.name='window'][property.name='cancelAnimationFrame']",
        "message": "window.cancelAnimationFrame() should be avoided, call it on the parent window from ICoreBrowserService."
      },
      {
        "selector": "MemberExpression[object.name='window'][property.name='devicePixelRatio']",
        "message": "window.devicePixelRatio should be avoided, get it from ICoreBrowserService."
      }
    ],
    "no-trailing-spaces": "warn",
    "no-unsafe-finally": "warn",
    "no-var": "warn",
    "one-var": [
      "warn",
      "never"
    ],
    "object-curly-spacing": [
      "warn",
      "always"
    ],
    "prefer-const": "warn",
    "spaced-comment": [
      "warn",
      "always",
      {
        "markers": ["/"],
        "exceptions": ["-"]
      }
    ]
  },
  "overrides": [
    {
      "files": ["**/*.test.ts"],
      "rules": {
        "object-curly-spacing": "off"
      }
    }
  ]
 }
@@ -0,0 +1,93 @@
 # xterm.js Copilot Instructions
 ## Architecture Overview
 **Core Structure**: xterm.js is a multi-target terminal emulator with three main distributions:
 - `src/browser/`: Full-featured browser terminal with DOM rendering
 - `src/headless/`: Server-side terminal for Node.js (no DOM)
 - `src/common/`: Shared core logic (parsing, buffer management, terminal state)
 **Key Classes**:
 - `Terminal` (browser/headless): Public API wrapper
 - `CoreTerminal` (common): Core terminal logic and state
 - `CoreBrowserTerminal` (browser): Browser-specific terminal implementation
 ## Development Workflow
 **Build System**:
 ```bash
 npm run build && npm run esbuild # Build all TypeScript and bundle
 ```
 **Testing**:
 - Unit tests: `npm run test-unit` (Mocha)
 - Unit tests filtering to file: `npm run test-unit -- **/fileName.ts
 - Per-addon unit tests: `npm run test-unit addons/addon-image/out-esbuild/*.test.js`
 - Integration tests: `npm run test-integration` (Playwright across Chrome/Firefox/WebKit)
 - Integration tests by file: `npm run test-integration -- test/playwright/InputHandler.test.ts`. Never use grep to filter tests, it doesn't work
 - Integration tests by addon: `npm run test-integration --suite=addon-search`. Suites always follow the format `addon-<something>`
 - Lint changes: `npm run lint-changes` to lint only changed files, `npm run lint-changes-fix` to fix them
 ## Addon Development Pattern
 All addons follow this structure:
 ```typescript
 export class MyAddon implements ITerminalAddon {
  activate(terminal: Terminal): void {
    // Called when loaded via terminal.loadAddon()
    // Register handlers, access terminal APIs
  }
  dispose(): void {
    // Cleanup when addon is disposed
  }
 }
 ```
 **Key Examples**:
 - `addons/addon-fit/`: Terminal sizing
 - `addons/addon-webgl/`: GPU-accelerated rendering
 - `addons/addon-search/`: Text search functionality
 ## Project-Specific Conventions
 **TypeScript Project Structure**: Uses TypeScript project references (`tsconfig.all.json`) for incremental builds across browser/headless/addons.
 **API Design**: 
 - Browser and headless terminals share the same public API
 - Proposed APIs require `allowProposedApi: true` option
 - Constructor-only options (cols, rows) cannot be changed after instantiation
 **Testing Utilities**: Use `TestUtils.ts` helpers:
 - `openTerminal(ctx, options)` for setup
 - `pollFor(page, fn, expectedValue)` for async assertions
 - `writeSync(page, data)` for terminal input
 ## Common Patterns
 **Parser Integration**: Register custom escape sequence handlers:
 ```typescript
 terminal.parser.registerCsiHandler('m', params => {
  // Handle SGR sequences
  return true; // Handled
 });
 ```
 **Buffer Access**: Read terminal content via buffer API:
 ```typescript
 const line = terminal.buffer.active.getLine(0);
 const cell = line?.getCell(0);
 ```
 **Events**: All terminals emit standard events (onData, onResize, onRender) plus platform-specific ones.
 ## Critical Implementation Details
 - Terminal rendering uses either DOM or WebGL renderers
 - Buffer lines are immutable; create new instances for modifications
 - Character width handling supports Unicode 11+ and grapheme clustering
 - Mouse events translate web events to terminal protocols (X10, VT200, etc.)
 - Color theming supports both palette and true color modes
 ## Writing unit tests
 - Unit tests live alongside the source code file of the thing it's testing with a .test.ts suffix.
@@ -0,0 +1,8 @@
 ---
 applyTo: '**/*.test.ts'
 ---
 When writing unit tests follow these rules:
 - When writing unit tests for addons, always create a real xterm.js instance instead of mocking it.
 - Prefer `assert.ok` over `assert.notStrictEqual` when checking something is undefined or not.
 - Avoid comments as most tests should be self-documenting.
@@ -0,0 +1,271 @@
 name: CI
 on:
  push:
    branches: [ "master" ]
  pull_request:
    branches: [ "master" ]
 jobs:
  build:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
    - uses: actions/checkout@v3
    - name: Use Node.js 22.x
      uses: actions/setup-node@v3
      with:
        node-version: 22.x
        cache: 'npm'
    - name: Install dependencies
      run: npm ci
    - name: Setup and run tsc
      run: npm run setup
    - name: Esbuild
      run: npm run esbuild
    - name: Zip artifacts
      run: |
        zip -r compressed-build \
          ./lib/* \
          ./out/* \
          ./out-*/* \
          ./addons/addon-attach/lib/* \
          ./addons/addon-attach/out/* \
          ./addons/addon-attach/out-*/* \
          ./addons/addon-clipboard/lib/* \
          ./addons/addon-clipboard/out/* \
          ./addons/addon-clipboard/out-*/* \
          ./addons/addon-fit/lib/* \
          ./addons/addon-fit/out/* \
          ./addons/addon-fit/out-*/* \
          ./addons/addon-image/lib/* \
          ./addons/addon-image/out/* \
          ./addons/addon-image/out-*/* \
          ./addons/addon-ligatures/lib/* \
          ./addons/addon-ligatures/out/* \
          ./addons/addon-ligatures/out-*/* \
          ./addons/addon-progress/lib/* \
          ./addons/addon-progress/out/* \
          ./addons/addon-progress/out-*/* \
          ./addons/addon-search/lib/* \
          ./addons/addon-search/out/* \
          ./addons/addon-search/out-*/* \
          ./addons/addon-serialize/lib/* \
          ./addons/addon-serialize/out/* \
          ./addons/addon-serialize/out-*/* \
          ./addons/addon-unicode11/lib/* \
          ./addons/addon-unicode11/out/* \
          ./addons/addon-unicode11/out-*/* \
          ./addons/addon-unicode-graphemes/lib/* \
          ./addons/addon-unicode-graphemes/out/* \
          ./addons/addon-unicode-graphemes/out-*/* \
          ./addons/addon-web-links/lib/* \
          ./addons/addon-web-links/out/* \
          ./addons/addon-web-links/out-*/* \
          ./addons/addon-web-fonts/lib/* \
          ./addons/addon-web-fonts/out/* \
          ./addons/addon-web-fonts/out-*/* \
          ./addons/addon-webgl/lib/* \
          ./addons/addon-webgl/out/* \
          ./addons/addon-webgl/out-*st/*
    - name: Upload artifacts
      uses: actions/upload-artifact@v4
      with:
        name: build-artifacts
        path: compressed-build.zip
        if-no-files-found: error
  lint:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
    - uses: actions/checkout@v3
    - name: Use Node.js 22.x
      uses: actions/setup-node@v3
      with:
        node-version: 22.x
        cache: 'npm'
    - name: Install dependencies
      run: |
        npm ci
    - name: Lint code
      env:
        NODE_OPTIONS: --max_old_space_size=4096
      run: npm run lint
    - name: Lint API
      run: npm run lint-api
  test-unit-coverage:
    needs: build
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
    - uses: actions/checkout@v3
    - name: Use Node.js 22.x
      uses: actions/setup-node@v3
      with:
        node-version: 22.x
        cache: 'npm'
    - name: Install dependencies
      run: |
        npm ci
    - uses: actions/download-artifact@v4
      with:
        name: build-artifacts
    - name: Unzip artifacts
      shell: bash
      run: |
        if [ "$RUNNER_OS" == "Windows" ]; then
          pwsh -Command "7z x compressed-build.zip -aoa -o${{ github.workspace }}"
        else
          unzip -o compressed-build.zip
        fi
        ls -R
    - name: Unit test coverage
      run: |
        npm run test-unit-coverage --forbid-only
        EXIT_CODE=$?
        ./node_modules/.bin/nyc report --reporter=cobertura
        exit $EXIT_CODE
  test-unit:
    timeout-minutes: 20
    strategy:
      matrix:
        node-version: [22]
        runs-on: [ubuntu, macos, windows]
    runs-on: ${{ matrix.runs-on }}-latest
    steps:
    - uses: actions/checkout@v3
    - name: Use Node.js ${{ matrix.node-version }}.x
      uses: actions/setup-node@v3
      with:
        node-version: ${{ matrix.node-version }}.x
        cache: 'npm'
    - name: Install dependencies
      run: |
        npm ci
    - name: Wait for build job
      uses: NathanFirmo/wait-for-other-job@v1.1.1
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        job: build
    - uses: actions/download-artifact@v4
      with:
        name: build-artifacts
    - name: Unzip artifacts
      shell: bash
      run: |
        if [ "$RUNNER_OS" == "Windows" ]; then
          pwsh -Command "7z x compressed-build.zip -aoa -o${{ github.workspace }}"
        else
          unzip -o compressed-build.zip
        fi
        ls -R
    - name: Unit tests
      run: npm run test-unit --forbid-only
  test-integration:
    timeout-minutes: 20
    strategy:
      matrix:
        node-version: [22] # just one as integration tests are about testing in browser
        runs-on: [ubuntu-22.04] # macos is flaky
        browser: [chromium, firefox, webkit]
    runs-on: ${{ matrix.runs-on }}
    steps:
    - uses: actions/checkout@v3
    - name: Use Node.js ${{ matrix.node-version }}.x
      uses: actions/setup-node@v3
      with:
        node-version: ${{ matrix.node-version }}.x
        cache: 'npm'
    - name: Install dependencies
      run: |
        npm ci
    - name: Install playwright
      run: npx playwright install --with-deps ${{ matrix.browser }}
    - name: Wait for build job
      uses: NathanFirmo/wait-for-other-job@v1.1.1
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        job: build
    - uses: actions/download-artifact@v4
      with:
        name: build-artifacts
    - name: Unzip artifacts
      shell: bash
      run: |
        if [ "$RUNNER_OS" == "Windows" ]; then
          pwsh -Command "7z x compressed-build.zip -aoa -o${{ github.workspace }}"
        else
          unzip -o compressed-build.zip
        fi
        ls -R
    - name: Build demo client
      run: npm run esbuild-demo-client
    - name: Build demo server
      run: npm run esbuild-demo-server
    - name: Integration tests (core) # Tests use 50% workers to reduce flakiness
      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=core
    - name: Integration tests (addon-attach)
      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-attach
    - name: Integration tests (addon-clipboard)
      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-clipboard
    - name: Integration tests (addon-fit)
      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-fit
    - name: Integration tests (addon-image)
      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-image
    - name: Integration tests (addon-progress)
      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-progress
    - name: Integration tests (addon-search)
      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-search
    - name: Integration tests (addon-serialize)
      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-serialize
    - name: Integration tests (addon-unicode-graphemes)
      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-unicode-graphemes
    - name: Integration tests (addon-unicode11)
      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-unicode11
    - name: Integration tests (addon-web-fonts)
      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-web-fonts
    - name: Integration tests (addon-web-links)
      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-web-links
    - name: Integration tests (addon-webgl)
      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-webgl
  release-dry-run:
    needs: build
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [22]
    steps:
    - uses: actions/checkout@v3
    - name: Use Node.js ${{ matrix.node-version }}.x
      uses: actions/setup-node@v3
      with:
        node-version: ${{ matrix.node-version }}.x
        cache: 'npm'
    - name: Install dependencies
      run: |
        npm ci
    - name: Install playwright
      run: npx playwright install
    - uses: actions/download-artifact@v4
      with:
        name: build-artifacts
    - name: Unzip artifacts
      shell: bash
      run: |
        if [ "$RUNNER_OS" == "Windows" ]; then
          pwsh -Command "7z x compressed-build.zip -aoa -o${{ github.workspace }}"
        else
          unzip -o compressed-build.zip
        fi
        ls -R
    - name: Package headless
      run: |
        npm run package-headless
        node ./bin/package_headless.js
    - name: Publish to npm (dry run)
      run: node ./bin/publish.js --dry
@@ -1,21 +1,9 @@
 # For most projects, this workflow file will not need changing; you simply need
 # to commit it to your repository.
 #
 # You may wish to alter this file to override the set of languages analyzed,
 # or to provide custom queries or build logic.
 #
 # ******** NOTE ********
 # We have attempted to detect the languages in your repository. Please check
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
 name: "CodeQL"
 on:
  push:
    branches: [ "master" ]
  pull_request:
    # The branches below must be a subset of the branches above
    branches: [ "master" ]
  schedule:
    - cron: '41 17 * * 0'
@@ -33,40 +21,15 @@ jobs:
      fail-fast: false
      matrix:
        language: [ 'javascript' ]
        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
    steps:
    - name: Checkout repository
      uses: actions/checkout@v3
    # Initializes the CodeQL tools for scanning.
    - name: Initialize CodeQL
      uses: github/codeql-action/init@v2
      with:
        languages: ${{ matrix.language }}
        # If you wish to specify custom queries, you can do so here or in a config file.
        # By default, queries listed here will override any specified in a config file.
        # Prefix the list here with "+" to use these queries and those in the config file.
        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
        # queries: security-extended,security-and-quality
    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
    # If this step fails, then you should remove it and run the build manually (see below)
    - name: Autobuild
      uses: github/codeql-action/autobuild@v2
    # ℹ️ Command-line programs to run using the OS shell.
    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
    #   If the Autobuild fails above, remove it and uncomment the following three lines.
    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
    # - run: |
    #   echo "Run, Build Application using script"
    #   ./location_of_script_within_repo/buildscript.sh
    - name: Perform CodeQL Analysis
      uses: github/codeql-action/analyze@v2
@@ -0,0 +1,32 @@
 name: "Copilot Setup Steps"
 on:
  workflow_dispatch:
  push:
    paths:
      - .github/workflows/copilot-setup-steps.yml
  pull_request:
    paths:
      - .github/workflows/copilot-setup-steps.yml
 jobs:
  copilot-setup-steps:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Use Node.js 22.x
        uses: actions/setup-node@v3
        with:
          node-version: 22.x
          cache: 'npm'
      - name: Install dependencies
        run: npm ci
      - name: Setup and run tsc
        run: npm run setup
      - name: Esbuild
        run: npm run esbuild
@@ -0,0 +1,30 @@
 name: Release
 on:
  push:
    # If a commit reaches master, assume it has passed CI via PR and publish
    # without running tests to save time to publish
    branches: [ "master" ]
 jobs:
  release:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Use Node.js 22.x
      uses: actions/setup-node@v3
      with:
        node-version: 22.x
        cache: 'npm'
    - name: Install dependencies
      run: npm ci
    - name: Build
      run: npm run setup
    - name: Package headless
      run: |
        npm run package-headless
        node ./bin/package_headless.js
    - name: Publish to npm
      env:
        NPM_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
      run: node ./bin/publish.js
@@ -3,7 +3,10 @@ node_modules/
 .lock-wscript
 lib/
 out/
 out-demo/
 out-test/
 out-esbuild/
 out-esbuild-test/
 .nyc_output/
 Makefile.gyp
 *.Makefile
@@ -16,7 +19,8 @@ npm-debug.log
 .env
 build/
 .DS_Store
-package-lock.json
+yarn.lock
 test-results/
 # Keep bundled code out of Git
 dist/
@@ -1,7 +0,0 @@
 Antonis Kalipetis <akalipetis@sourcelair.com>
 Antonis Kalipetis <akalipetis@sourcelair.com> <akalipetis@gmail.com>
 Daniel Imms <daimms@microsoft.com> <tyriar@tyriar.com>
 Paris Kasidiaris <paris@sourcelair.com>
 Paris Kasidiaris <pariskasidiaris@gmail.com>
 Thanasis Daglis <thanasis@sourcelair.com>
 Thanasis Daglis <thanasis@sourcelair.com> <ath.daglis@gmail.com>
@@ -1 +0,0 @@
 NODE_PATH=./out
@@ -1,5 +0,0 @@
 require:
  - source-map-support/register
 reporter: spec
 color: true
 check-leaks: true
@@ -17,6 +17,9 @@
 !lib/**/*.js
 !lib/**/*.js.map
 !lib/**/*.mjs
 !lib/**/*.mjs.map
 !lib/**/*.css
 # Whitelist - src/
@@ -1 +0,0 @@
 package-lock=false
@@ -0,0 +1 @@
 22
@@ -0,0 +1,5 @@
 {
    "recommendations": [
        "dbaeumer.vscode-eslint"
    ]
 }
@@ -43,7 +43,14 @@
    {
      "type": "chrome",
      "request": "launch",
-      "name": "Demo Client",
+      "name": "Demo Client (Chrome)",
      "url": "http://127.0.0.1:3000",
      "webRoot": "${workspaceFolder}/"
    },
    {
      "type": "msedge",
      "request": "launch",
      "name": "Demo Client (Edge)",
      "url": "http://127.0.0.1:3000",
      "webRoot": "${workspaceFolder}/"
    },
@@ -52,11 +59,9 @@
      "request": "launch",
      "name": "Demo Server",
      "runtimeExecutable": "npm",
-      "runtimeArgs": [
+      "runtimeArgs": ["start"],
-        "run",
+      "stopOnEntry": true,
-        "start-debug"
+      "runtimeVersion": "22",
      ],
      "port": 9229,
      "serverReadyAction": {
        "action": "openExternally",
        "pattern": "App listening to (http://.*?:[0-9]+)"
@@ -1,13 +1,4 @@
 {
  "typescript.preferences.importModuleSpecifier": "non-relative",
-  "typescript.preferences.quoteStyle": "single",
+  "typescript.preferences.quoteStyle": "single"
  "mochaExplorer.envPath": ".mocha.env",
  "mochaExplorer.files": [
    "out/**/*.test.js",
    "addons/**/out/*.test.js"
  ],
  "mochaExplorer.watch": [
    "out/**/*.js",
    "addons/**/out/*.js"
  ]
 }
@@ -8,6 +8,87 @@
    "showReuseMessage": true
  },
  "tasks": [
    // Compound tasks
    {
      "label": "dev",
      "detail": "Runs all tasks required to run the demo in a single terminal using concurrently. This does not support problem matching.",
      "type": "npm",
      "script": "dev",
      "isBackground": true,
      "group": {
        "kind": "build",
        "isDefault": true
      }
    },
    {
      "label": "dev (separate terminals)",
      "detail": "Runs all tasks required to run the demo in separate terminals. This does support problem matching.",
      "dependsOn": ["demo-server", "tsc", "esbuild", "esbuild-demo-client", "esbuild-demo-server"],
      "group": "build"
    },
    // Demo
    {
      "label": "demo-server",
      "type": "npm",
      "script": "start",
      "group": "build",
      "isBackground": true,
      "problemMatcher": [],
      "presentation": {
        "group": "xterm-demo"
      }
    },
    // Build
    {
      "label": "tsc",
      "type": "npm",
      "script": "tsc-watch",
      "group": "build",
      "isBackground": true,
      "problemMatcher": "$tsc-watch",
      "presentation": {
        "group": "xterm-build"
      }
    },
    {
      "label": "esbuild",
      "type": "npm",
      "script": "esbuild-watch",
      "group": "build",
      "isBackground": true,
      "problemMatcher": "$esbuild-watch",
      "presentation": {
        "group": "xterm-build"
      }
    },
    {
      "label": "esbuild-demo-client",
      "type": "npm",
      "script": "esbuild-demo-client-watch",
      "dependsOn": ["esbuild", "tsc"],
      "group": "build",
      "isBackground": true,
      "problemMatcher": "$esbuild-watch",
      "presentation": {
        "group": "xterm-demo"
      }
    },
    {
      "label": "esbuild-demo-server",
      "type": "npm",
      "script": "esbuild-demo-server-watch",
      "dependsOn": ["esbuild", "tsc"],
      "group": "build",
      "isBackground": true,
      "problemMatcher": "$esbuild-watch",
      "presentation": {
        "group": "xterm-demo"
      }
    },
    // Test
    {
      "type": "npm",
      "script": "test",
@@ -16,59 +97,6 @@
        "isDefault": true
      },
      "problemMatcher": []
    },
    {
      "label": "watch",
      "type": "npm",
      "script": "watch",
      "group": "build",
      "isBackground": true,
      "problemMatcher": "$tsc-watch",
      "presentation": {
        "group": "vscode"
      }
    },
    {
      "label": "start",
      "type": "npm",
      "script": "start",
      "group": "build",
      "isBackground": true,
      "problemMatcher": [],
      "presentation": {
        "group": "vscode"
      }
    },
    {
      "label": "Start demo",
      "dependsOn": ["start", "watch"],
      "group": {
        "kind": "build",
        "isDefault": true
      },
      "isBackground": true,
      "problemMatcher": {
        "owner": "typescript",
        "fileLocation": [
          "relative",
          "${workspaceFolder}"
        ],
        "pattern": [
          {
            "regexp": "^([^\\\\s].*)\\\\((\\\\d+,\\\\d+)\\\\):\\\\s*(.*)$",
            "file": 1,
            "location": 2,
            "message": 3
          }
        ],
        "background": {
          "beginsPattern": "assets by",
          "endsPattern": "webpack \\d+\\.\\d+\\.\\d+ compiled successfully"
        }
      },
      "presentation": {
        "group": "vscode"
      }
    }
  ]
 }
@@ -1,58 +1,50 @@
 # How to contribute to xterm.js
 - [Opening issues for bug reports or feature requests](#opening-issues)
 - [Contributing code](#contributing-code)
 - [Opening issues](#opening-issues)
 - [Answering discussion questions](#answering-discussion-questions)
 ## Contributing code
 You can find issues to work on by looking at issues labeled with [help wanted](https://github.com/xtermjs/xterm.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) or [good first issue](https://github.com/xtermjs/xterm.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). It's a good idea to comment on the issue saying that you're looking into it, just in case someone else comes along and you duplicate work. Once you have your issue, here are the steps to contribute:
 - Fork [xterm.js](https://github.com/xtermjs/xterm.js/) ([how to fork a repo](https://help.github.com/articles/fork-a-repo)).
 - Get the [xterm.js demo](https://github.com/xtermjs/xterm.js/wiki/Contributing#running-the-demo) running.
 - Make the fix and verify it works in the demo. Be sure to follow thew general code style of the rest of the project.
 - If your changes are easy to test or likely to regress in the future, add tests. These could be unit or integration (playwright) tests.
 - Submit a pull request ([how to create a pull request](https://help.github.com/articles/fork-a-repo)).
 > ![TIP]
 > Don't put more than one feature or fix in a single pull request. The smaller pull requests are the easier they are to review and merge.
 By contributing code to xterm.js you:
 - Agree to license the contributed code under xterm.js' [MIT license](LICENSE).
 - Confirm that you have the right to contribute and license the code in question. This means that either you hold all rights on the code, or the rights holder has explicitly granted the right to use it like this, through a compatible open source license or through a direct agreement with you.
 ## Opening issues
 The preferred way to report bugs or request features is to use
-[GitHub issues](http://github.com/sourcelair/xterm.js/issues). Before
+[GitHub issues](http://github.com/xtermjs/xterm.js/issues).
 opening an issue, read these pointers.
-### Opening issues effectively
+### Creating great issues
- Include information about **the browser in which the problem occurred**. Even
+- Include information about **the browser in which the problem occurred** or the terminal being used. If you tested several browsers and the problem occurred in all of them, mention this fact in the bug report. Also include browser version numbers and the operating system that you're on.
-  if you tested several browsers, and the problem occurred in all of them,
+- Include the version of xterm.js being used, preferably either with the latest `beta` tagged release on npm or reproducing in the demo on the `master` branch.
-  mention this fact in the bug report. Also include browser version numbers and
+- Mention precisely what went wrong. What did you expect to happen? What happened instead? Describe the exact steps a maintainer has to take to make the problem occur.
-  the operating system that you're on.
+- If the problem can not be reproduced in the [demo of xterm.js](https://github.com/xtermjs/xterm.js/wiki/Contributing#running-the-demo), provide an HTML document that demonstrates the problem.
 - Be polite and follow [the code of conduct](https://github.com/xtermjs/xterm.js?tab=coc-ov-file#readme).
- Mention which release of xterm.js you're using. Preferably, try also with
+### Issue triaging philosophy
  the current HEAD of the master branch, to ensure the problem has not already been
  fixed.
- Mention precisely what went wrong. What did you expect to happen? What happened instead? Describe the
+It's pretty common for maintainers of large open source projects to suffer from burnout, especially when needing to triage a large number of incoming issues instead of actually building things. Here are some of the steps we take to try mitigate this:
  exact steps a maintainer has to take to make the problem occur.
- If the problem can not be reproduced in the [demo of xterm.js](https://github.com/xtermjs/xterm.js/wiki/Contributing#running-the-demo), please provide an HTML document that demonstrates the problem.
+- Support questions live in [GH discussions](https://github.com/xtermjs/xterm.js/discussions), issues may be transfered there without further comment and core maintainers may or may not participate in discussions.
 - Issues are strictly for well defined features or bugs that are _actionable_.
 - Sometimes features are out of scope. A common example of this is a niche feature that the pricipal implementation ([VS Code](https://code.visualstudio.com/)) won't leverage and therefore would be difficult to maintain and likely suffer from bitrot. The reporter may not agree with this, but you could always create an addon if that works or maintain your own fork if it comes to that.
 - If a feature does not have a clear way forward or needs more discussion it may be closed ro moved to a discussion.
 - If a bug is not easily reproducible it may be closed or moved to a discussion. Generally issues that are labeled are something we want to do or has actionable steps to look into further.
- Be polite. Issues with an indignant or belligerent tone tend to be moved to the
+## Answering discussion questions
  bottom of the pile.
-## Contributing code
+Issues are only meant to track (likely) feature requests and bugs. We use [GitHub Discussions](https://github.com/xtermjs/xterm.js/discussions) for general Q&A as well as discussing possible features. If you want to help out, many questions get asked over at the [discussions page](https://github.com/xtermjs/xterm.js/discussions) which could use an expert as the core team is often stretched thin.
 You can find issues to work on by looking at the [help wanted](https://github.com/xtermjs/xterm.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) or [good first issue](https://github.com/xtermjs/xterm.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) issues. It's a good idea to comment on the issue saying that you're taking it, just in case someone else comes along and you duplicate work. Once you have your issue, here are the steps to contribute:
 - Fork [xterm.js](https://github.com/sourcelair/xterm.js/)
  ([how to fork a repo](https://help.github.com/articles/fork-a-repo)).
 - Get the [xterm.js demo](https://github.com/xtermjs/xterm.js/wiki/Contributing#running-the-demo) running.
 - Make your changes.
 - If your changes are easy to test or likely to regress, add tests. Tests go into `test`, directory.
 - Follow the general code style of the rest of the project (see below).
 - Submit a pull request
 ([how to create a pull request](https://help.github.com/articles/fork-a-repo)).
  Don't put more than one feature/fix in a single pull request.
 By contributing code to xterm.js you:
 - Agree to license the contributed code under xterm.js' [MIT
   license](LICENSE).
 - Confirm that you have the right to contribute and license the code
   in question. (Either you hold all rights on the code, or the rights
   holder has explicitly granted the right to use it like this,
   through a compatible open source license or through a direct
   agreement with you.)
 ### Test coverage
 One area that always needs attention is improving out unit test coverage, you can view the code coverage report on [Azure Pipelines](https://dev.azure.com/xtermjs/xterm.js/_build/latest?definitionId=3) by clicking the Code Coverage tab.
@@ -1,2 +0,0 @@
 web: npm start
 webpack: npm run watch
@@ -1,29 +1,27 @@
-# [![xterm.js logo](logo-full.png)](https://xtermjs.org)
+# [![xterm.js](images/logo-full.png)](https://xtermjs.org)
-[![Build Status](https://dev.azure.com/xtermjs/xterm.js/_apis/build/status/xtermjs.xterm.js)](https://dev.azure.com/xtermjs/xterm.js/_build/latest?definitionId=3)
+Xterm.js is a frontend component that enables applications to bring fully-featured terminals to their users in the browser. It's used by popular projects such as [VS Code](https://code.visualstudio.com/) (and its forks), [Tabby](https://tabby.sh/) and [Hyper](https://hyper.is/).
 Xterm.js is a front-end component written in TypeScript that lets applications bring fully-featured terminals to their users in the browser. It's used by popular projects such as VS Code, Hyper and Theia.
 ## Features
 - **Terminal apps just work**: Xterm.js works with most terminal apps such as `bash`, `vim`, and `tmux`, including support for curses-based apps and mouse events.
- **Performant**: Xterm.js is *really* fast, it even includes a GPU-accelerated renderer.
+- **Performant**: Xterm.js is *really* fast and includes an optional GPU-accelerated renderer.
 - **Rich Unicode support**: Supports CJK, emojis, and IMEs.
- **Self-contained**: Requires zero dependencies to work.
+- **Self-contained**: The core library has zero dependencies.
- **Accessible**: Screen reader and minimum contrast ratio support can be turned on.
+- **Accessible**: Screen reader mode and minimum contrast ratio support can be turned on.
- **And much more**: Links, theming, addons, well documented API, etc.
+- **And much more**: Links, theming, custom glyphs, addons, well documented API, etc.
 ## What xterm.js is not
 - Xterm.js is not a terminal application that you can download and use on your computer.
- Xterm.js is not `bash`. Xterm.js can be connected to processes like `bash` and let you interact with them (provide input, receive output).
+- Xterm.js is not `bash`. Xterm.js can be connected to processes like `bash` and let you interact with them (provide input, receive output) through a library like [node-pty](https://github.com/microsoft/node-pty).
 ## Getting Started
-First, you need to install the module, we ship exclusively through [npm](https://www.npmjs.com/), so you need that installed and then add xterm.js as a dependency by running:
+First, you need to install the module. We ship exclusively through [npm](https://www.npmjs.com), so you need that installed and then add [@xterm/xterm](https://www.npmjs.com/package/@xterm/xterm) as a dependency by running:
 ```bash
-npm install xterm
+npm install --save @xterm/xterm
 ```
 To start using xterm.js on your browser, add the `xterm.js` and `xterm.css` to the head of your HTML page. Then create a `<div id="terminal"></div>` onto which xterm can attach itself. Finally, instantiate the `Terminal` object and then call the `open` function with the DOM object of the `div`.
@@ -32,8 +30,8 @@ To start using xterm.js on your browser, add the `xterm.js` and `xterm.css` to t
 <!doctype html>
  <html>
    <head>
-      <link rel="stylesheet" href="node_modules/xterm/css/xterm.css" />
+      <link rel="stylesheet" href="node_modules/@xterm/xterm/css/xterm.css" />
-      <script src="node_modules/xterm/lib/xterm.js"></script>
+      <script src="node_modules/@xterm/xterm/lib/xterm.js"></script>
    </head>
    <body>
      <div id="terminal"></div>
@@ -51,24 +49,22 @@ To start using xterm.js on your browser, add the `xterm.js` and `xterm.css` to t
 The recommended way to load xterm.js is via the ES6 module syntax:
 ```javascript
-import { Terminal } from 'xterm';
+import { Terminal } from '@xterm/xterm';
 ```
 ### Addons
 ⚠️ *This section describes the new addon format introduced in v3.14.0, see [here](https://github.com/xtermjs/xterm.js/blob/3.14.2/README.md#addons) for the instructions on the old format*
 Addons are separate modules that extend the `Terminal` by building on the [xterm.js API](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts). To use an addon, you first need to install it in your project:
 ```bash
-npm i -S xterm-addon-web-links
+npm install --save @xterm/addon-web-links
 ```
 Then import the addon, instantiate it and call `Terminal.loadAddon`:
 ```ts
-import { Terminal } from 'xterm';
+import { Terminal } from '@xterm/xterm';
-import { WebLinksAddon } from 'xterm-addon-web-links';
+import { WebLinksAddon } from '@xterm/addon-web-links';
 const terminal = new Terminal();
 // Load WebLinksAddon on terminal, this is all that's needed to get web links
@@ -78,54 +74,59 @@ terminal.loadAddon(new WebLinksAddon());
 The xterm.js team maintains the following addons, but anyone can build them:
- [`xterm-addon-attach`](https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-attach): Attaches to a server running a process via a websocket
+- [`@xterm/addon-attach`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-attach): Attaches to a server running a process via a websocket
- [`xterm-addon-fit`](https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-fit): Fits the terminal to the containing element
+- [`@xterm/addon-clipboard`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-clipboard): Access the browser's clipboard
- [`xterm-addon-search`](https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-search): Adds search functionality
+- [`@xterm/addon-fit`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-fit): Fits the terminal to the containing element
- [`xterm-addon-web-links`](https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-web-links): Adds web link detection and interaction
+- [`@xterm/addon-image`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-image): Adds image support
 - [`@xterm/addon-ligatures`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-ligatures): Enables rendering of ligatures
 - [`@xterm/addon-progress`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-progress): Adds support for the progress API (`OSC 9;4`)
 - [`@xterm/addon-search`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-search): Adds search functionality
 - [`@xterm/addon-serialize`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-serialize): Serializes the terminal's buffer to VT sequences or HTML
 - [`@xterm/addon-unicode-graphemes`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-unicode-graphemes): Enhanced unicode support including grapheme clustering (experimental)
 - [`@xterm/addon-unicode11`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-unicode11): Updates character widths to their unicode11 values
 - [`@xterm/addon-web-fonts`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-web-fonts): Easily integrate web fonts
 - [`@xterm/addon-web-links`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-web-links): Adds web link detection and interaction
 - [`@xterm/addon-webgl`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-webgl): Renders xterm.js using a `canvas` element's webgl2 context
 ## Browser Support
-Since xterm.js is typically implemented as a developer tool, only modern browsers are supported officially. Specifically the latest versions of *Chrome*, *Edge*, *Firefox*, and *Safari*.
+Since xterm.js is typically implemented as a developer tool, generally only modern evergreen browsers are supported officially. Specifically the latest versions of *Chrome*, *Edge*, *Firefox*, and *Safari*. Xterm.js also works seamlessly in [Electron](https://electronjs.org/) apps and may even work on earlier versions of the browsers. These are the versions we strive to keep working.
 Xterm.js works seamlessly in [Electron](https://electronjs.org/) apps and may even work on earlier versions of the browsers. These are the versions we strive to keep working.
 ### Node.js Support
-We also publish [`xterm-headless`](https://www.npmjs.com/package/xterm-headless) which is a stripped down version of xterm.js that runs in Node.js. An example use case for this is to keep track of a terminal's state where the process is running and using the serialize addon so it can get all state restored upon reconnection.
+We also publish [`xterm-headless`](https://www.npmjs.com/package/xterm-headless) which is a stripped down version of xterm.js that runs headless in Node.js. An example use case for this is to keep track of a terminal's state where the process is running and using the [serialize addon](https://www.npmjs.com/package/@xterm/addon-serialize) so it can get all state restored upon reconnection.
 ## API
 The full API for xterm.js is contained within the [TypeScript declaration file](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts), use the branch/tag picker in GitHub (`w`) to navigate to the correct version of the API.
-Note that some APIs are marked *experimental*, these are added to enable experimentation with new ideas without committing to support it like a normal [semver](https://semver.org/) API. Note that these APIs can change radically between versions, so be sure to read release notes if you plan on using experimental APIs.
+Some APIs may be marked with *experimental*, these are added to enable experimentation with new ideas without committing to support it like a normal [semver](https://semver.org/) API. Note that these APIs can change radically between versions, so be sure to read release notes if you plan on using experimental APIs.
 ## Releases
-Xterm.js follows a monthly release cycle roughly.
+Stable releases are done on an as needed basis. All current and past releases are available on this repo's [releases page](https://github.com/sourcelair/xterm.js/releases), you can see what's planned for upcoming releases looking through the repository [milestones](https://github.com/sourcelair/xterm.js/milestones).
 All current and past releases are available on this repo's [Releases page](https://github.com/sourcelair/xterm.js/releases), you can view the [high-level roadmap on the wiki](https://github.com/xtermjs/xterm.js/wiki/Roadmap) and see what we're working on now by looking through [Milestones](https://github.com/sourcelair/xterm.js/milestones).
 ### Beta builds
-Our CI releases beta builds to npm for every change that goes into master. Install the latest beta build with:
+Beta releases are continuously published off the `master` branch. Install the latest beta build with:
 ```bash
-npm install -S xterm@beta
+npm install --save @xterm/xterm@beta
 ```
-These should generally be stable, but some bugs may slip in. We recommend using the beta build primarily to test out new features and to verify bug fixes.
+The principal implementation (VS Code) typically uses the latest or near the latest beta build. Generally they are quite stable but can potentially contain bugs or breaking changes. If stability is very important we recommend using the beta build primarily to test out new features and to verify bug fixes, unless you're tracking what's landing and are comfortable taking that risk.
 ## Contributing
-You can read the [guide on the wiki](https://github.com/xtermjs/xterm.js/wiki/Contributing) to learn how to contribute and set up xterm.js for development.
+Read [CONTRIBUTING.md](https://github.com/xtermjs/xterm.js/blob/master/CONTRIBUTING.md) to learn how to contribute to the project.
 ## Real-world uses
-Xterm.js is used in several world-class applications to provide great terminal experiences.
+
 Xterm.js is used in many world-class applications to provide great terminal experiences.
 - [**SourceLair**](https://www.sourcelair.com/): In-browser IDE that provides its users with fully-featured Linux terminals based on xterm.js.
 - [**Microsoft Visual Studio Code**](http://code.visualstudio.com/): Modern, versatile, and powerful open source code editor that provides an integrated terminal based on xterm.js.
 - [**ttyd**](https://github.com/tsl0922/ttyd): A command-line tool for sharing terminal over the web, with fully-featured terminal emulation based on xterm.js.
 - [**Katacoda**](https://www.katacoda.com/): Katacoda is an Interactive Learning Platform for software developers, covering the latest Cloud Native technologies.
 - [**Eclipse Che**](http://www.eclipse.org/che): Developer workspace server, cloud IDE, and Eclipse next-generation IDE.
 - [**Codenvy**](http://www.codenvy.com): Cloud workspaces for development teams.
 - [**CoderPad**](https://coderpad.io): Online interviewing platform for programmers. Run code in many programming languages, with results displayed by xterm.js.
@@ -216,14 +217,26 @@ Xterm.js is used in several world-class applications to provide great terminal e
 - [**Super Terminal**](https://github.com/bugwheels94/super-terminal): It is a http based terminal for developers who dont like repetition and save time.
 - [**graSSHopper**](https://grasshopper.coding.kiwi): A simple SSH client with file explorer, history and many more features.
 - [**DomTerm**](https://domterm.org/xtermjs.html): Tiles and tabs. Detachable sessions (like tmux). [Remote connections](https://domterm.org/Remoting-over-ssh.html) using a nice ssh wrapper with predictive echo. Qt, Electron, Tauri/Wry, or desktop browser front-ends. Choose between xterm.js engine (faster) or native DomTerm (more functionality and graphics) - or both.
 - [**Cloudtutor.io**](https://cloudtutor.io): innovative online learning platform that offers users access to an interactive lab.
 - [**Helix Editor Playground**](https://github.com/tomgroenwoldt/helix-editor-playground): Online playground for the terminal based helix editor.
 - [**Coder**](https://github.com/coder/coder): Self-Hosted Remote Development Environments
 - [**Wave Terminal**](https://waveterm.dev): An open-source, ai-native, terminal built for seamless workflows.
 - [**eva**](https://github.com/info24/eva): Eva is a web application for SSH remote login, developed in Go.
 - [**OpenSFTP**](https://opensftp.com): Super beautiful SSH and SFTP integrated workspace client.
 - [**balena**](https://www.balena.io/): Balena is a full-stack solution for developing, deploying, updating, and troubleshooting IoT Edge devices. We use xterm.js to manage & debug devices on [balenaCloud](https://www.balena.io/cloud).
 - [**Filet Cloud**](https://github.com/fuglaro/filet-cloud): The lean and powerful personal cloud ⛅.
 - [**pyTermTk**](https://github.com/ceccopierangiolieugenio/pyTermTk): Python Terminal Toolkit - a Spiced Up Cross Compatible TUI Library 🌶️, use xterm.js for the [HTML5 exporter](https://ceccopierangiolieugenio.github.io/pyTermTk/sandbox/sandbox.html).
 - [**ecmaOS**](https://ecmaos.sh): A kernel and suite of applications tying modern web technologies into a browser-based operating system.
 - [**LabEx**](https://labex.io): Interactive learning platform with hands-on labs and xterm.js-based online terminals, focused on learn-by-doing approach.
 - [**EmuDevz**](https://afska.github.io/emudevz): A free coding game where players learn how to build an emulator from scratch.
 - [And much more...](https://github.com/xtermjs/xterm.js/network/dependents?package_id=UGFja2FnZS0xNjYzMjc4OQ%3D%3D)
-Do you use xterm.js in your application as well? Please [open a Pull Request](https://github.com/sourcelair/xterm.js/pulls) to include it here. We would love to have it on our list. Note: Please add any new contributions to the end of the list only.
+Do you use xterm.js in your application as well? Please [open a Pull Request](https://github.com/sourcelair/xterm.js/pulls) to include it here. We would love to have it on our list. Please add any new contributions to the end of the list.
 ## License Agreement
 If you contribute code to this project, you implicitly allow your code to be distributed under the MIT license. You are also implicitly verifying that all code is your original work.
-Copyright (c) 2017-2022, [The xterm.js authors](https://github.com/xtermjs/xterm.js/graphs/contributors) (MIT License)<br>
+Copyright (c) 2017-2026, [The xterm.js authors](https://github.com/xtermjs/xterm.js/graphs/contributors) (MIT License)<br>
 Copyright (c) 2014-2017, SourceLair, Private Company ([www.sourcelair.com](https://www.sourcelair.com/home)) (MIT License)<br>
 Copyright (c) 2012-2013, Christopher Jeffrey (MIT License)
@@ -8,6 +8,9 @@
 !lib/**/*.js
 !lib/**/*.js.map
 !lib/**/*.mjs
 !lib/**/*.mjs.map
 !lib/**/*.css
 # Whitelist - src/
@@ -1,22 +1,22 @@
-## xterm-addon-attach
+## @xterm/addon-attach
 An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables attaching to a web socket. This addon requires xterm.js v4+.
 ### Install
 ```bash
-npm install --save xterm-addon-attach
+npm install --save @xterm/addon-attach
 ```
 ### Usage
 ```ts
-import { Terminal } from 'xterm';
+import { Terminal } from '@xterm/xterm';
-import { AttachAddon } from 'xterm-addon-attach';
+import { AttachAddon } from '@xterm/addon-attach';
 const terminal = new Terminal();
 const attachAddon = new AttachAddon(webSocket);
 terminal.loadAddon(attachAddon);
 ```
-See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/xterm-addon-attach/typings/xterm-addon-attach.d.ts) for more advanced usage.
+See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/addon-attach/typings/addon-attach.d.ts) for more advanced usage.
@@ -1,13 +1,14 @@
 {
-  "name": "xterm-addon-search",
+  "name": "@xterm/addon-attach",
  "version": "0.12.0",
  "author": {
    "name": "The xterm.js authors",
    "url": "https://xtermjs.org/"
  },
-  "main": "lib/xterm-addon-search.js",
+  "main": "lib/addon-attach.js",
-  "types": "typings/xterm-addon-search.d.ts",
+  "module": "lib/addon-attach.mjs",
-  "repository": "https://github.com/xtermjs/xterm.js",
+  "types": "typings/addon-attach.d.ts",
  "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-attach",
  "license": "MIT",
  "keywords": [
    "terminal",
@@ -18,9 +19,7 @@
    "build": "../../node_modules/.bin/tsc -p .",
    "prepackage": "npm run build",
    "package": "../../node_modules/.bin/webpack",
-    "prepublishOnly": "npm run package"
+    "prepublishOnly": "npm run package",
-  },
+    "start": "node ../../demo/start"
  "peerDependencies": {
    "xterm": "^5.0.0"
  }
 }
@@ -5,13 +5,14 @@
 * Implements the attach method, that attaches the terminal to a WebSocket stream.
 */
-import { Terminal, IDisposable, ITerminalAddon } from 'xterm';
+import type { Terminal, IDisposable, ITerminalAddon } from '@xterm/xterm';
 import type { AttachAddon as IAttachApi } from '@xterm/addon-attach';
 interface IAttachOptions {
  bidirectional?: boolean;
 }
-export class AttachAddon implements ITerminalAddon {
+export class AttachAddon implements ITerminalAddon , IAttachApi {
  private _socket: WebSocket;
  private _bidirectional: boolean;
  private _disposables: IDisposable[] = [];
@@ -1,7 +1,7 @@
 {
  "compilerOptions": {
    "module": "commonjs",
-    "target": "es2015",
+    "target": "es2021",
    "lib": [
      "dom",
      "es2015"
@@ -13,7 +13,12 @@
    "strict": true,
    "types": [
      "../../../node_modules/@types/mocha"
-    ]
+    ],
    "paths": {
      "@xterm/addon-attach": [
        "../typings/addon-attach.d.ts"
      ]
    }
  },
  "include": [
    "./**/*",
@@ -0,0 +1,42 @@
 /**
 * Copyright (c) 2019 The xterm.js authors. All rights reserved.
 * @license MIT
 */
 import WebSocket = require('ws');
 import test from '@playwright/test';
 import { ITestContext, createTestContext, openTerminal, pollFor, timeout } from '../../../test/playwright/TestUtils';
 let ctx: ITestContext;
 test.beforeAll(async ({ browser }) => {
  ctx = await createTestContext(browser);
  await openTerminal(ctx);
 });
 test.afterAll(async () => await ctx.page.close());
 test.describe('Search Tests', () => {
  test.beforeEach(async () => {
    await ctx.proxy.reset();
  });
  test('string', async function(): Promise<any> {
    const port = 8080;
    const server = new WebSocket.Server({ port });
    server.on('connection', socket => socket.send('foo'));
    await ctx.page.evaluate(`window.term.loadAddon(new window.AttachAddon(new WebSocket('ws://localhost:${port}')))`);
    await pollFor(ctx.page, `window.term.buffer.active.getLine(0).translateToString(true)`, 'foo');
    server.close();
  });
  test('utf8', async function(): Promise<any> {
    const port = 8080;
    const server = new WebSocket.Server({ port });
    const data = new Uint8Array([102, 111, 111]);
    server.on('connection', socket => socket.send(data));
    await ctx.page.evaluate(`window.term.loadAddon(new window.AttachAddon(new WebSocket('ws://localhost:${port}')))`);
    await pollFor(ctx.page, `window.term.buffer.active.getLine(0).translateToString(true)`, 'foo');
    server.close();
  });
 });
@@ -0,0 +1,35 @@
 import { PlaywrightTestConfig } from '@playwright/test';
 const config: PlaywrightTestConfig = {
  testDir: '.',
  timeout: 10000,
  projects: [
    {
      name: 'ChromeStable',
      use: {
        browserName: 'chromium',
        channel: 'chrome'
      }
    },
    {
      name: 'FirefoxStable',
      use: {
        browserName: 'firefox'
      }
    },
    {
      name: 'WebKit',
      use: {
        browserName: 'webkit'
      }
    }
  ],
  reporter: 'list',
  webServer: {
    command: 'npm run start',
    port: 3000,
    timeout: 120000,
    reuseExistingServer: !process.env.CI
  }
 };
 export default config;
@@ -1,13 +1,12 @@
 {
  "compilerOptions": {
    "module": "commonjs",
-    "target": "es2015",
+    "target": "ESNext",
    "lib": [
-      "dom",
+      "es2021",
      "es6"
    ],
    "rootDir": ".",
-    "outDir": "../out",
+    "outDir": "../out-test",
    "sourceMap": true,
    "removeComments": true,
    "baseUrl": ".",
@@ -20,9 +19,8 @@
      ]
    },
    "strict": true,
    "downlevelIteration": true,
    "types": [
-      "../../../node_modules/@types/mocha"
+      "../../../node_modules/@types/node"
    ]
  },
  "include": [
@@ -35,6 +33,9 @@
    },
    {
      "path": "../../../src/browser"
    },
    {
      "path": "../../../test/playwright"
    }
  ]
 }
@@ -3,9 +3,9 @@
 * @license MIT
 */
-import { Terminal, ITerminalAddon } from 'xterm';
+import { Terminal, ITerminalAddon } from '@xterm/xterm';
-declare module 'xterm-addon-attach' {
+declare module '@xterm/addon-attach' {
  export interface IAttachOptions {
    /**
     * Whether input should be written to the backend. Defaults to `true`.
@@ -6,7 +6,7 @@
 const path = require('path');
 const addonName = 'AttachAddon';
-const mainFile = 'xterm-addon-attach.js';
+const mainFile = 'addon-attach.js';
 module.exports = {
  entry: `./out/${addonName}.js`,
@@ -25,7 +25,9 @@ module.exports = {
    filename: mainFile,
    path: path.resolve('./lib'),
    library: addonName,
-    libraryTarget: 'umd'
+    libraryTarget: 'umd',
    // Force usage of globalThis instead of global / self. (This is cross-env compatible)
    globalObject: 'globalThis',
  },
  mode: 'production'
 };
@@ -8,6 +8,9 @@
 !lib/**/*.js
 !lib/**/*.js.map
 !lib/**/*.mjs
 !lib/**/*.mjs.map
 !lib/**/*.css
 # Whitelist - src/
@@ -1,4 +1,4 @@
-Copyright (c) 2017, The xterm.js authors (https://github.com/xtermjs/xterm.js)
+Copyright (c) 2023, The xterm.js authors (https://github.com/xtermjs/xterm.js)
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -0,0 +1,53 @@
 ## @xterm/addon-clipboard
 An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables
 accessing the system clipboard. This addon requires xterm.js v4+.
 ### Install
 ```bash
 npm install --save @xterm/addon-clipboard
 ```
 ### Usage
 ```ts
 import { Terminal } from 'xterm';
 import { ClipboardAddon } from '@xterm/addon-clipboard';
 const terminal = new Terminal();
 const clipboardAddon = new ClipboardAddon();
 terminal.loadAddon(clipboardAddon);
 ```
 To use a custom clipboard provider
 ```ts
 import { Terminal } from '@xterm/xterm';
 import { ClipboardAddon, IClipboardProvider, ClipboardSelectionType } from '@xterm/addon-clipboard';
 function b64Encode(data: string): string {
  // Base64 encode impl
 }
 function b64Decode(data: string): string {
  // Base64 decode impl
 }
 class MyCustomClipboardProvider implements IClipboardProvider {
  private _data: string
  public readText(selection: ClipboardSelectionType): Promise<string> {
    return Promise.resolve(b64Encode(this._data));
  }
  public writeText(selection: ClipboardSelectionType, data: string): Promise<void> {
    this._data = b64Decode(data);
    return Promise.resolve();
  }
 }
 const terminal = new Terminal();
 const clipboardAddon = new ClipboardAddon(new MyCustomClipboardProvider());
 terminal.loadAddon(clipboardAddon);
 ```
 See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/addon-clipboard/typings/addon-clipboard.d.ts) for more advanced usage.
@@ -0,0 +1,28 @@
 {
  "name": "@xterm/addon-clipboard",
  "version": "0.2.0",
  "author": {
    "name": "The xterm.js authors",
    "url": "https://xtermjs.org/"
  },
  "main": "lib/addon-clipboard.js",
  "module": "lib/addon-clipboard.mjs",
  "types": "typings/addon-clipboard.d.ts",
  "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-clipboard",
  "license": "MIT",
  "keywords": [
    "terminal",
    "xterm",
    "xterm.js"
  ],
  "scripts": {
    "build": "../../node_modules/.bin/tsc -p .",
    "prepackage": "npm run build",
    "package": "../../node_modules/.bin/webpack",
    "prepublishOnly": "npm run package",
    "start": "node ../../demo/start"
  },
  "dependencies": {
    "js-base64": "^3.7.5"
  }
 }
@@ -0,0 +1,99 @@
 /**
 * Copyright (c) 2023 The xterm.js authors. All rights reserved.
 * @license MIT
 */
 import type { IDisposable, ITerminalAddon, Terminal } from '@xterm/xterm';
 import { type IClipboardProvider, ClipboardSelectionType, type IBase64 } from '@xterm/addon-clipboard';
 import { Base64 as JSBase64 } from 'js-base64';
 export class ClipboardAddon implements ITerminalAddon {
  private _terminal?: Terminal;
  private _disposable?: IDisposable;
  constructor(
    private _base64: IBase64 = new Base64(),
    private _provider: IClipboardProvider = new BrowserClipboardProvider()
  ) {}
  public activate(terminal: Terminal): void {
    this._terminal = terminal;
    this._disposable = terminal.parser.registerOscHandler(52, data => this._setOrReportClipboard(data));
  }
  public dispose(): void {
    return this._disposable?.dispose();
  }
  private _readText(sel: ClipboardSelectionType, data: string): void {
    const b64 = this._base64.encodeText(data);
    this._terminal?.input(`\x1b]52;${sel};${b64}\x07`, false);
  }
  private _setOrReportClipboard(data: string): boolean | Promise<boolean> {
    const args = data.split(';');
    if (args.length < 2) {
      return true;
    }
    const pc = args[0] as ClipboardSelectionType;
    const pd = args[1];
    if (pd === '?') {
      const text = this._provider.readText(pc);
      // Report clipboard
      if (text instanceof Promise) {
        return text.then((data) => {
          this._readText(pc, data);
          return true;
        });
      }
      this._readText(pc, text);
      return true;
    }
    // Clear clipboard if text is not a base64 encoded string.
    let text = '';
    try {
      text = this._base64.decodeText(pd);
    } catch {}
    const result = this._provider.writeText(pc, text);
    if (result instanceof Promise) {
      return result.then(() => true);
    }
    return true;
  }
 }
 export class BrowserClipboardProvider implements IClipboardProvider {
  public async readText(selection: ClipboardSelectionType): Promise<string> {
    if (selection !== 'c') {
      return Promise.resolve('');
    }
    return navigator.clipboard.readText();
  }
  public async writeText(selection: ClipboardSelectionType, text: string): Promise<void> {
    if (selection !== 'c') {
      return Promise.resolve();
    }
    return navigator.clipboard.writeText(text);
  }
 }
 export class Base64 implements IBase64 {
  public encodeText(data: string): string {
    return JSBase64.encode(data);
  }
  public decodeText(data: string): string {
    const text = JSBase64.decode(data);
    if (!JSBase64.isValid(data) || JSBase64.encode(text) !== data) {
      return '';
    }
    return text;
  }
 }
@@ -0,0 +1,35 @@
 {
  "compilerOptions": {
    "module": "commonjs",
    "target": "es2021",
    "lib": [
      "dom",
      "es2015"
    ],
    "rootDir": ".",
    "outDir": "../out",
    "sourceMap": true,
    "removeComments": true,
    "strict": true,
    "types": [
      "../../../node_modules/@types/mocha"
    ],
    "paths": {
      "browser/*": [
        "../../../src/browser/*"
      ],
      "@xterm/addon-clipboard": [
        "../typings/addon-clipboard.d.ts"
      ]
    }
  },
  "include": [
    "./**/*",
    "../../../typings/xterm.d.ts"
  ],
  "references": [
    {
      "path": "../../../src/browser"
    }
  ]
 }
@@ -0,0 +1,78 @@
 /**
 * Copyright (c) 2023 The xterm.js authors. All rights reserved.
 * @license MIT
 */
 import test from '@playwright/test';
 import { deepEqual, ok, strictEqual } from 'assert';
 import { ITestContext, createTestContext, launchBrowser, openTerminal, timeout } from '../../../test/playwright/TestUtils';
 let ctx: ITestContext;
 test.beforeAll(async ({ browser }, testInfo) => {
  ctx = await createTestContext(browser);
  await openTerminal(ctx);
 });
 test.afterAll(async () => {
  await ctx.page.close();
 });
 test.describe('ClipboardAddon', () => {
  test.beforeEach(async ({}, testInfo) => {
    // DEBT: This test doesn't work since the migration to @playwright/test
    if (ctx.browser.browserType().name() !== 'chromium') {
      testInfo.skip();
      return;
    }
    if (ctx.browser.browserType().name() === 'chromium') {
      // Enable clipboard access in chromium without user gesture
      await ctx.page.context().grantPermissions(['clipboard-read', 'clipboard-write']);
    }
    await ctx.page.evaluate(`
      window.term.reset()
      window.clipboard?.dispose();
      window.clipboard = new ClipboardAddon();
      window.term.loadAddon(window.clipboard);
    `);
  });
  test.beforeEach(async () => {
    await ctx.proxy.reset();
  });
  const testDataEncoded = 'aGVsbG8gd29ybGQ=';
  const testDataDecoded = 'hello world';
  test.describe('write data', async function (): Promise<any> {
    test('simple string', async () => {
      await ctx.proxy.write(`\x1b]52;c;${testDataEncoded}\x07`);
      deepEqual(await ctx.page.evaluate(() => window.navigator.clipboard.readText()), testDataDecoded);
    });
    test('invalid base64 string', async () => {
      await ctx.proxy.write(`\x1b]52;c;${testDataEncoded}invalid\x07`);
      deepEqual(await ctx.page.evaluate(() => window.navigator.clipboard.readText()), '');
    });
    test('empty string', async () => {
      await ctx.proxy.write(`\x1b]52;c;${testDataEncoded}\x07`);
      await ctx.proxy.write(`\x1b]52;c;\x07`);
      deepEqual(await ctx.page.evaluate(() => window.navigator.clipboard.readText()), '');
    });
  });
  test.describe('read data', async function (): Promise<any> {
    test('simple string', async () => {
      await ctx.page.evaluate(`
        window.data = [];
        window.term.onData(e => data.push(e));
      `);
      await ctx.page.evaluate(() => window.navigator.clipboard.writeText('hello world'));
      await ctx.proxy.write(`\x1b]52;c;?\x07`);
      deepEqual(await ctx.page.evaluate('window.data'), [`\x1b]52;c;${testDataEncoded}\x07`]);
    });
    test('clear clipboard', async () => {
      await ctx.proxy.write(`\x1b]52;c;!\x07`);
      await ctx.proxy.write(`\x1b]52;c;?\x07`);
      deepEqual(await ctx.page.evaluate(() => window.navigator.clipboard.readText()), '');
    });
  });
 });
@@ -0,0 +1,35 @@
 import { PlaywrightTestConfig } from '@playwright/test';
 const config: PlaywrightTestConfig = {
  testDir: '.',
  timeout: 10000,
  projects: [
    {
      name: 'ChromeStable',
      use: {
        browserName: 'chromium',
        channel: 'chrome'
      }
    },
    {
      name: 'FirefoxStable',
      use: {
        browserName: 'firefox'
      }
    },
    {
      name: 'WebKit',
      use: {
        browserName: 'webkit'
      }
    }
  ],
  reporter: 'list',
  webServer: {
    command: 'npm run start',
    port: 3000,
    timeout: 120000,
    reuseExistingServer: !process.env.CI
  }
 };
 export default config;
@@ -1,13 +1,12 @@
 {
  "compilerOptions": {
    "module": "commonjs",
-    "target": "es2015",
+    "target": "ESNext",
    "lib": [
-      "dom",
+      "es2021",
      "es6"
    ],
    "rootDir": ".",
-    "outDir": "../out",
+    "outDir": "../out-test",
    "sourceMap": true,
    "removeComments": true,
    "baseUrl": ".",
@@ -20,9 +19,8 @@
      ]
    },
    "strict": true,
    "downlevelIteration": true,
    "types": [
-      "../../../node_modules/@types/mocha"
+      "../../../node_modules/@types/node"
    ]
  },
  "include": [
@@ -35,6 +33,9 @@
    },
    {
      "path": "../../../src/browser"
    },
    {
      "path": "../../../test/playwright"
    }
  ]
 }
@@ -0,0 +1,113 @@
 /**
 * Copyright (c) 2023 The xterm.js authors. All rights reserved.
 * @license MIT
 */
 import { Terminal, ITerminalAddon } from '@xterm/xterm';
 declare module '@xterm/addon-clipboard' {
  /**
   * An xterm.js addon that enables accessing the system clipboard from
   * xterm.js.
   */
  export class ClipboardAddon implements ITerminalAddon {
    /**
     * Creates a new clipboard addon.
     * @param base64 An optional base64 encoder/decoder.
     * @param provider An optional clipboard provider.
     */
    constructor(base64?: IBase64, provider?: IClipboardProvider);
    /**
     * Activates the addon
     * @param terminal The terminal the addon is being loaded in.
     */
    public activate(terminal: Terminal): void;
    /**
     * Disposes the addon.
     */
    public dispose(): void
  }
  /**
   * Clipboard selection type. This is used to specify which selection buffer to
   * read or write to.
   * - SYSTEM `c`: The system clipboard.
   * - PRIMARY `p`: The primary clipboard. This is provided for compatibility
   *  with Linux X11.
   */
  export const enum ClipboardSelectionType {
    SYSTEM = 'c',
    PRIMARY = 'p',
  }
  export interface IBase64 {
    /**
    * Converts a utf-8 string to a base64 string.
    * @param data The utf-8 string to convert to base64 string.
    */
    encodeText(data: string): string;
    /**
    * Converts a base64 string to a utf-8 string.
    * @param data The base64 string to convert to utf-8 string.
    * @throws An error if the input is not valid base64.
    */
    decodeText(data: string): string;
  }
  /**
   * A default Base64 encoding and decoding type.
   **/
  export class Base64 implements IBase64 {
    /**
     * Converts a utf-8 string to a base64 string.
     * @param data The utf-8 string to convert to base64 string.
     */
    public encodeText(data: string): string;
    /**
     * Converts a base64 string to a utf-8 string.
     * @param data The base64 string to convert to utf-8 string.
     * @throws An error if the input is not valid base64.
     */
    public decodeText(data: string): string;
  }
  export interface IClipboardProvider {
    /**
     * Gets the clipboard content.
     * @param selection The clipboard selection to read.
     * @returns A promise that resolves with clipboard selection data.
     */
    readText(selection: ClipboardSelectionType): string | Promise<string>;
    /**
     * Sets the clipboard content.
     * @param selection The clipboard selection to set.
     * @param data The clipboard text to write.
     */
    writeText(selection: ClipboardSelectionType, text: string): void | Promise<void>;
  }
  /**
   * The clipboard provider interface that enables xterm.js to access the system clipboard.
   */
  export class BrowserClipboardProvider implements IClipboardProvider{
    /**
     * Reads text from the clipboard.
     * @param selection The selection type to read from.
     * @returns A promise that resolves with the text from the clipboard.
     */
    public readText(selection: ClipboardSelectionType): Promise<string>;
    /**
     * Writes text to the clipboard.
     * @param selection The selection type to write to.
     * @param data The text to write to the clipboard.
     * @returns A promise that resolves when the text has been written to the clipboard.
     */
    public writeText(selection: ClipboardSelectionType, data: string): Promise<void>;
  }
 }
@@ -1,12 +1,12 @@
 /**
- * Copyright (c) 2019 The xterm.js authors. All rights reserved.
+ * Copyright (c) 2023 The xterm.js authors. All rights reserved.
 * @license MIT
 */
 const path = require('path');
-const addonName = 'FitAddon';
+const addonName = 'ClipboardAddon';
-const mainFile = 'xterm-addon-fit.js';
+const mainFile = 'addon-clipboard.js';
 module.exports = {
  entry: `./out/${addonName}.js`,
@@ -8,6 +8,9 @@
 !lib/**/*.js
 !lib/**/*.js.map
 !lib/**/*.mjs
 !lib/**/*.mjs.map
 !lib/**/*.css
 # Whitelist - src/
@@ -1,18 +1,18 @@
-## xterm-addon-fit
+## @xterm/addon-fit
 An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables fitting the terminal's dimensions to a containing element. This addon requires xterm.js v4+.
 ### Install
 ```bash
-npm install --save xterm-addon-fit
+npm install --save @xterm/addon-fit
 ```
 ### Usage
 ```ts
-import { Terminal } from 'xterm';
+import { Terminal } from '@xterm/xterm';
-import { FitAddon } from 'xterm-addon-fit';
+import { FitAddon } from '@xterm/addon-fit';
 const terminal = new Terminal();
 const fitAddon = new FitAddon();
@@ -21,4 +21,4 @@ terminal.open(containerElement);
 fitAddon.fit();
 ```
-See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/xterm-addon-fit/typings/xterm-addon-fit.d.ts) for more advanced usage.
+See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/addon-fit/typings/addon-fit.d.ts) for more advanced usage.
@@ -1,13 +1,14 @@
 {
-  "name": "xterm-addon-attach",
+  "name": "@xterm/addon-fit",
-  "version": "0.8.0",
+  "version": "0.11.0",
  "author": {
    "name": "The xterm.js authors",
    "url": "https://xtermjs.org/"
  },
-  "main": "lib/xterm-addon-attach.js",
+  "main": "lib/addon-fit.js",
-  "types": "typings/xterm-addon-attach.d.ts",
+  "module": "lib/addon-fit.mjs",
-  "repository": "https://github.com/xtermjs/xterm.js",
+  "types": "typings/addon-fit.d.ts",
  "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-fit",
  "license": "MIT",
  "keywords": [
    "terminal",
@@ -18,9 +19,7 @@
    "build": "../../node_modules/.bin/tsc -p .",
    "prepackage": "npm run build",
    "package": "../../node_modules/.bin/webpack",
-    "prepublishOnly": "npm run package"
+    "prepublishOnly": "npm run package",
-  },
+    "start": "node ../../demo/start"
  "peerDependencies": {
    "xterm": "^5.0.0"
  }
 }
@@ -3,8 +3,9 @@
 * @license MIT
 */
-import { Terminal, ITerminalAddon } from 'xterm';
+import type { Terminal, ITerminalAddon, IRenderDimensions } from '@xterm/xterm';
-import { IRenderDimensions } from 'browser/renderer/shared/Types';
+import type { FitAddon as IFitApi } from '@xterm/addon-fit';
 import { ViewportConstants } from 'browser/shared/Constants';
 interface ITerminalDimensions {
  /**
@@ -21,10 +22,19 @@ interface ITerminalDimensions {
 const MINIMUM_COLS = 2;
 const MINIMUM_ROWS = 1;
-export class FitAddon implements ITerminalAddon {
+function getWindow(e: Node): Window {
-  private _terminal: Terminal | undefined;
+  if (e?.ownerDocument?.defaultView) {
    return e.ownerDocument.defaultView;
  }
-  constructor() {}
+  return window;
 }
 function _getComputedStyle(el: HTMLElement): CSSStyleDeclaration {
  return getWindow(el).getComputedStyle(el, null);
 }
 export class FitAddon implements ITerminalAddon , IFitApi {
  private _terminal: Terminal | undefined;
  public activate(terminal: Terminal): void {
    this._terminal = terminal;
@@ -38,12 +48,8 @@ export class FitAddon implements ITerminalAddon {
      return;
    }
    // TODO: Remove reliance on private API
    const core = (this._terminal as any)._core;
    // Force a full render
    if (this._terminal.rows !== dims.rows || this._terminal.cols !== dims.cols) {
      core._renderService.clear();
      this._terminal.resize(dims.cols, dims.rows);
    }
  }
@@ -57,21 +63,20 @@ export class FitAddon implements ITerminalAddon {
      return undefined;
    }
-    // TODO: Remove reliance on private API
+    const dims: IRenderDimensions | undefined = this._terminal.dimensions;
    const core = (this._terminal as any)._core;
    const dims: IRenderDimensions = core._renderService.dimensions;
-    if (dims.css.cell.width === 0 || dims.css.cell.height === 0) {
+    if (!dims || dims.css.cell.width === 0 || dims.css.cell.height === 0) {
      return undefined;
    }
-    const scrollbarWidth = this._terminal.options.scrollback === 0 ?
+    const scrollbarWidth = (this._terminal.options.scrollback === 0
-      0 : core.viewport.scrollBarWidth;
+      ? 0
      : (this._terminal.options.overviewRuler?.width || ViewportConstants.DEFAULT_SCROLL_BAR_WIDTH));
-    const parentElementStyle = window.getComputedStyle(this._terminal.element.parentElement);
+    const parentElementStyle = _getComputedStyle(this._terminal.element.parentElement);
    const parentElementHeight = parseInt(parentElementStyle.getPropertyValue('height'));
    const parentElementWidth = Math.max(0, parseInt(parentElementStyle.getPropertyValue('width')));
-    const elementStyle = window.getComputedStyle(this._terminal.element);
+    const elementStyle = _getComputedStyle(this._terminal.element);
    const elementPadding = {
      top: parseInt(elementStyle.getPropertyValue('padding-top')),
      bottom: parseInt(elementStyle.getPropertyValue('padding-bottom')),
@@ -1,7 +1,7 @@
 {
  "compilerOptions": {
    "module": "commonjs",
-    "target": "es2015",
+    "target": "es2021",
    "lib": [
      "dom",
      "es2015"
@@ -17,6 +17,9 @@
    "paths": {
      "browser/*": [
        "../../../src/browser/*"
      ],
      "@xterm/addon-fit": [
        "../typings/addon-fit.d.ts"
      ]
    }
  },
@@ -0,0 +1,133 @@
 /**
 * Copyright (c) 2019 The xterm.js authors. All rights reserved.
 * @license MIT
 */
 import test from '@playwright/test';
 import { deepEqual, ok, strictEqual } from 'assert';
 import { ITestContext, createTestContext, openTerminal, timeout } from '../../../test/playwright/TestUtils';
 let ctx: ITestContext;
 test.beforeAll(async ({ browser }) => {
  ctx = await createTestContext(browser);
  ctx.page.setViewportSize({ width: 1024, height: 768 });
  await openTerminal(ctx);
 });
 test.afterAll(async () => await ctx.page.close());
 test.describe('FitAddon', () => {
  test.beforeEach(async function(): Promise<any> {
    await ctx.page.evaluate(`document.querySelector('#terminal-container').style.display=''`);
    await ctx.page.evaluate(`
      window.term.reset()
      window.fit?.dispose();
      window.fit = new FitAddon();
      window.term.loadAddon(window.fit);
    `);
  });
  // test.beforeEach(async function(): Promise<any> {
  //   await ctx.page.evaluate(`document.querySelector('#terminal-container').style.display=''`);
  //   await openTerminal(page);
  // });
  // after(async () => {
  //   await browser.close();
  // });
  // afterEach(async function(): Promise<any> {
  //   await ctx.proxy.dispose();
  // });
  test('no terminal', async function(): Promise<any> {
    await ctx.page.evaluate(`window.fit2 = new FitAddon();`);
    strictEqual(await ctx.page.evaluate(`window.fit2.proposeDimensions()`), undefined);
    await ctx.page.evaluate(`window.fit2.dispose();`);
  });
  test.describe('proposeDimensions', () => {
    test('default', async function(): Promise<any> {
      await setDimensions();
      const dimensions: {cols: number, rows: number} = await ctx.page.evaluate(`window.fit.proposeDimensions()`);
      ok(dimensions.cols > 85);
      ok(dimensions.cols < 88);
      ok(dimensions.rows > 24);
      ok(dimensions.rows < 29);
    });
    test('width', async function(): Promise<any> {
      await setDimensions(1008);
      const dimensions: {cols: number, rows: number} = await ctx.page.evaluate(`window.fit.proposeDimensions()`);
      ok(dimensions.cols > 108);
      ok(dimensions.cols < 111);
      ok(dimensions.rows > 24);
      ok(dimensions.rows < 29);
    });
    test('small', async function(): Promise<any> {
      await setDimensions(1, 1);
      deepEqual(await ctx.page.evaluate(`window.fit.proposeDimensions()`), {
        cols: 2,
        rows: 1
      });
    });
    test('hidden', async function(): Promise<any> {
      await ctx.proxy.dispose();
      await ctx.page.evaluate(`document.querySelector('#terminal-container').style.display='none'`);
      await ctx.page.evaluate(`window.term = new Terminal()`);
      await ctx.page.evaluate(`window.term.open(document.querySelector('#terminal-container'))`);
      await setDimensions();
      const dimensions: { cols: number, rows: number } | undefined = await ctx.page.evaluate(`window.fit.proposeDimensions()`);
      // The value of dims will be undefined if the char measure strategy falls back to the DOM
      // method, so only assert if it's not undefined.
      if (dimensions) {
        ok(dimensions.cols > 85);
        ok(dimensions.cols < 88);
        ok(dimensions.rows > 24);
        ok(dimensions.rows < 29);
      }
    });
  });
  test.describe('fit', () => {
    test('default', async function(): Promise<any> {
      await setDimensions();
      await ctx.page.evaluate(`window.fit.fit()`);
      const cols: number = await ctx.proxy.cols;
      const rows: number = await ctx.proxy.rows;
      ok(cols > 85);
      ok(cols < 88);
      ok(rows > 24);
      ok(rows < 29);
    });
    test('width', async function(): Promise<any> {
      await setDimensions(1008);
      await ctx.page.evaluate(`window.fit.fit()`);
      const cols: number = await ctx.proxy.cols;
      const rows: number = await ctx.proxy.rows;
      ok(cols > 108);
      ok(cols < 111);
      ok(rows > 24);
      ok(rows < 29);
    });
    test('small', async function(): Promise<any> {
      await setDimensions(1, 1);
      await ctx.page.evaluate(`window.fit.fit()`);
      strictEqual(await ctx.proxy.cols, 2);
      strictEqual(await ctx.proxy.rows, 1);
    });
  });
 });
 async function setDimensions(width: number = 800, height: number = 450): Promise<void> {
  await ctx.page.evaluate(`
    document.querySelector('#terminal-container').style.width='${width}px';
    document.querySelector('#terminal-container').style.height='${height}px';
    document.querySelector('#terminal-container').style.display='';
  `);
  // HACK: Await a short period as hiding #terminal-container can mess with other tests
  await timeout(500);
 }
@@ -0,0 +1,35 @@
 import { PlaywrightTestConfig } from '@playwright/test';
 const config: PlaywrightTestConfig = {
  testDir: '.',
  timeout: 10000,
  projects: [
    {
      name: 'ChromeStable',
      use: {
        browserName: 'chromium',
        channel: 'chrome'
      }
    },
    {
      name: 'FirefoxStable',
      use: {
        browserName: 'firefox'
      }
    },
    {
      name: 'WebKit',
      use: {
        browserName: 'webkit'
      }
    }
  ],
  reporter: 'list',
  webServer: {
    command: 'npm run start',
    port: 3000,
    timeout: 120000,
    reuseExistingServer: !process.env.CI
  }
 };
 export default config;
@@ -0,0 +1,41 @@
 {
  "compilerOptions": {
    "module": "commonjs",
    "target": "ESNext",
    "lib": [
      "es2021",
    ],
    "rootDir": ".",
    "outDir": "../out-test",
    "sourceMap": true,
    "removeComments": true,
    "baseUrl": ".",
    "paths": {
      "common/*": [
        "../../../src/common/*"
      ],
      "browser/*": [
        "../../../src/browser/*"
      ]
    },
    "strict": true,
    "types": [
      "../../../node_modules/@types/node"
    ]
  },
  "include": [
    "./**/*",
    "../../../typings/xterm.d.ts"
  ],
  "references": [
    {
      "path": "../../../src/common"
    },
    {
      "path": "../../../src/browser"
    },
    {
      "path": "../../../test/playwright"
    }
  ]
 }
@@ -3,9 +3,9 @@
 * @license MIT
 */
-import { Terminal, ITerminalAddon } from 'xterm';
+import { Terminal, ITerminalAddon } from '@xterm/xterm';
-declare module 'xterm-addon-fit' {
+declare module '@xterm/addon-fit' {
  /**
   * An xterm.js addon that enables resizing the terminal to the dimensions of
   * its containing element.
@@ -39,7 +39,7 @@ declare module 'xterm-addon-fit' {
  }
  /**
-   * Reprepresents the dimensions of a terminal.
+   * Represents the dimensions of a terminal.
   */
  export interface ITerminalDimensions {
    /**
@@ -5,8 +5,8 @@
 const path = require('path');
-const addonName = 'SerializeAddon';
+const addonName = 'FitAddon';
-const mainFile = 'xterm-addon-serialize.js';
+const mainFile = 'addon-fit.js';
 module.exports = {
  entry: `./out/${addonName}.js`,
@@ -26,7 +26,8 @@ module.exports = {
    path: path.resolve('./lib'),
    library: addonName,
    libraryTarget: 'umd',
-    globalObject: 'this'
+    // Force usage of globalThis instead of global / self. (This is cross-env compatible)
    globalObject: 'globalThis',
  },
  mode: 'production'
 };
@@ -0,0 +1,33 @@
 node_modules/
 *.swp
 .lock-wscript
 lib/
 out/
 out-test/
 out-worker/
 .nyc_output/
 Makefile.gyp
 *.Makefile
 *.target.gyp.mk
 *.node
 example/*.log
 docs/
 npm-debug.log
 /.idea/
 .env
 build/
 .DS_Store
 yarn.lock
 # Keep bundled code out of Git
 dist/
 demo/dist/
 # skip benchmark & inwasm folders, except builds
 .benchmark/
 timeline/
 inwasm-sdks/
 inwasm-builds/
 !inwasm-builds/**/final.wat
 !inwasm-builds/**/final.wasm
 !inwasm-builds/**/definition.json
@@ -0,0 +1,12 @@
 .github
 fixture
 overwrite
 bootstrap.sh
 tsconfig.json
 webpack.config.js
 test
 out-test
 out-esbuild
 out-esbuild-test
 inwasm-sdks
 inwasm-builds
@@ -0,0 +1,19 @@
 Copyright (c) 2019, 2020, 2021, 2022, 2023 The xterm.js authors (https://github.com/xtermjs/xterm.js)
 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.
@@ -0,0 +1,231 @@
 ## @xterm/addon-image
 Inline image output in xterm.js. Supports SIXEL and iTerm's inline image protocol (IIP).
 ![](fixture/example.png)
 ### Install from npm
 ```bash
 npm install --save @xterm/addon-image
 ```
 ### Usage
 ```ts
 import { Terminal } from '@xterm/xterm';
 import { ImageAddon, IImageAddonOptions } from '@xterm/addon-image';
 // customize as needed (showing addon defaults)
 const customSettings: IImageAddonOptions = {
  enableSizeReports: true,    // whether to enable CSI t reports (see below)
  pixelLimit: 16777216,       // max. pixel size of a single image
  sixelSupport: true,         // enable sixel support
  sixelScrolling: true,       // whether to scroll on image output
  sixelPaletteLimit: 256,     // initial sixel palette size
  sixelSizeLimit: 25000000,   // size limit of a single sixel sequence
  storageLimit: 128,          // FIFO storage limit in MB
  showPlaceholder: true,      // whether to show a placeholder for evicted images
  iipSupport: true,           // enable iTerm IIP support
  iipSizeLimit: 20000000      // size limit of a single IIP sequence
 }
 // initialization
 const terminal = new Terminal();
 const imageAddon = new ImageAddon(customSettings);
 terminal.loadAddon(imageAddon);
 ```
 ### General Notes
 - *IMPORTANT:* The worker approach as done in previous releases got removed.
  The addon contructor no longer expects a worker path as first argument.
 - By default the addon will activate these `windowOptions` reports on the terminal:
  - getWinSizePixels (CSI 14 t)
  - getCellSizePixels (CSI 16 t)
  - getWinSizeChars (CSI 18 t)
  to help applications getting useful terminal metrics for their image preparations. Set `enableSizeReports` in the constructor options to `false`, if you dont want the addon to alter these terminal settings. This is especially useful, if you have very strict security needs not allowing any terminal reports, or deal with `windowOptions` by other means.
 ### Operation Modes
 - **SIXEL Support**  
  Set by default, change it with `{sixelSupport: true}`.
 - **Scrolling On | Off**  
  By default scrolling is on, thus an image will advance the cursor at the bottom if needed.
  (see cursor positioning).
  If scrolling is off, the image gets painted from the top left of the current viewport
  and might be truncated if the image exceeds the viewport size.
  The cursor position does not change.
  You can customize this behavior with the constructor option `{sixelScrolling: false}`
  or with `DECSET 80` (off, binary: `\x1b [ ? 80 h`) and
  `DECRST 80` (on, binary: `\x1b [ ? 80 l`) during runtime.
 - **Cursor Positioning**  
  If scrolling is set, the cursor will be placed at the first image column of the last image row (VT340 mode).
  Other cursor positioning modes as used by xterm or mintty are not supported.
 - **SIXEL Palette Handling**  
  By default the addon limits the palette size to 256 registers (as demanded by the DEC specification).
  The limit can be increased to a maximum of 4096 registers (via `sixelPaletteLimit`).
  The default palette is a mixture of VT340 colors (lower 16 registers), xterm colors (up to 256) and zeros (up to 4096).
  There is no private/shared palette distinction, palette colors are always carried over from a previous sixel image.
  Restoring the default palette size and colors is possible with `XTSMGRAPHICS 1 ; 2` (binary: `\x1b[?1;2S`).
  It gets also restored automatically on RIS and DECSTR.
  Other than on older terminals, the underlying SIXEL library applies colors immediately to individual pixels
  (*printer mode*), thus it is technically possible to use more colors in one image than the palette has color slots.
  This feature is called *high-color* in libsixel.
  A terminal wide shared palette mode with late indexed coloring of the output is not supported,
  therefore palette animations cannot be used.
 - **SIXEL Raster Attributes Handling**  
  If raster attributes were found in the SIXEL data (level 2), the image will always be truncated to the given height/width extend. We deviate here from the specification on purpose, as it allows several processing optimizations. For level 1 SIXEL data without any raster attributes the image can freely grow in width and height up to the last data byte, which has a much higher processing penalty. In general encoding libraries should not create level 1 data anymore and should not produce pixel information beyond the announced height/width extend. Both is discouraged by the >30 years old specification.
  Currently the SIXEL implementation of the addon does not take custom pixel sizes into account, a SIXEL pixel will map 1:1 to a screen pixel.
 - **IIP Support (iTerm's Inline Image Protocol)**  
  Set by default, change it with `{iipSupport: true}`.
  The IIP implementation has the following features / restrictions (sequence will silently fail for unmet conditions):
  - Supported formats: PNG, JPEG and GIF
  - No animation support.
  - Image type hinting is not supported (always deducted from data header).
  - File download is not supported.
  - Filename gets parsed but not used.
  - Strict base64 handling as of RFC4648 §4 (standard alphabet, optional padding, no separator bytes allowed).
  - Payload size may not exceed CEIL(sizeParameter * 4 / 3).
  - Image scaling beyond terminal viewport size is allowed (e.g. `width=200%`).
  - Image pixel size is restricted by `pixelLimit` (pre- and post resizing).
  - Size parameter is restricted by `iipSizeLimit`.
  - Cursor positioning behaves the same as for sixel (see above).
 ### Storage and Drawing Settings
 The internal storage holds images up to `storageLimit` (in MB, calculated as 4-channel RBGA unpacked, default 100 MB). Once hit images get evicted by FIFO rules. Furthermore images on the alternate buffer will always be erased on buffer changes.
 The addon exposes two properties to interact with the storage limits at runtime:
 - `storageLimit`  
  Change the value to your needs at runtime. This is especially useful, if you have multiple terminal
  instances running, that all add to one upper memory limit.
 - `storageUsage`  
  Inspect the current memory usage of the image storage.
 By default the addon will show a placeholder pattern for evicted images that are still part
 of the terminal (e.g. in the scrollback). The pattern can be deactivated by toggling `showPlaceholder`.
 ### Image Data Retrieval
 The addon provides the following API endpoints to retrieve raw image data as canvas:
 - `getImageAtBufferCell(x: number, y: number): HTMLCanvasElement | undefined`  
  Returns the canvas containing the original image data (not resized) at the given buffer position.
  The buffer position is the 0-based absolute index (including scrollback at top).
 - `extractTileAtBufferCell(x: number, y: number): HTMLCanvasElement | undefined`  
  Returns a canvas containing the actual single tile image data (maybe resized) at the given buffer position.
  The buffer position is the 0-based absolute index (including scrollback at top).
  Note that the canvas gets created and data copied over for every call, thus it is not suitable for performance critical actions.
 ### Memory Usage
 The addon does most image processing in Javascript and therefore can occupy a rather big amount of memory. To get an idea where the memory gets eaten, lets look at the data flow and processing steps:
 - Incomming image data chunk at `term.write` (terminal)  
  `term.write` might stock up incoming chunks. To circumvent this, you will need proper flow control (see xterm.js docs). Note that with image output it is more likely to run into this issue, as it can create lots of MBs in very short time.
 - Sequence Parser (terminal)  
  The parser operates on a buffer containing up to 2^17 codepoints (~0.5 MB).
 - Sequence Handler - Chunk Decoding (addon)  
  Image data chunks are processed immediately by the SIXEL decoder (streamlined). The decoder allocates memory for image
  pixels as needed. The allowed image size is restricted by `pixelLimit` (default 16M pixels), the decoder holds 2 pixel buffers at maximum during decoding (RGBA, ~128 MB for 16M pixels).
 - Sequence Handler - Image Finalization (addon) 
  After decoding the final pixel buffer is grabbed by the sequence handler and written to a canvas of the same size (~64 MB for 16M pixels) and added to the storage.
 - Image Storage (addon)  
  The image storage implements a FIFO cache, that will remove old images, if a new one arrives and `storageLimit` is hit (default 128 MB). The storage holds a canvas with the original image, and may additionally hold resized versions of images after a font rescaling. Both are accounted in `storageUsage` as a rough estimation of _pixels x 4 channels_.
 Following the steps above, a rough estimation of maximum memory usage by the addon can be calculated with these formulas (in bytes):
 ```typescript
 // storage alone
 const storageBytes = storageUsage * storageLimit * 1024 * 1024;
 // decoding alone
 const decodingBytes = sixelSizeLimit + 2 * (pixelLimit * 4);
 // totals
 // inactive decoding
 const totalInactive = storageBytes;
 // active decoding
 const totalActive = storageBytes + decodingBytes;
 ```
 Note that browsers have offloading tricks for rarely touched memory segments, esp. `storageBytes` might not directly translate into real memory usage. Usage peaks will happen during active decoding of multiple big images due to the need of 2 full pixel buffers at the same time, which cannot be offloaded. Thus you may want to keep an eye on `pixelLimit` under limited memory conditions.  
 Further note that the formulas above do not respect the Javascript object's overhead. Compared to the raw buffer needs the book keeping by these objects is rather small (<<5%).
 _Why should I care about memory usage at all?_  
 Well you don't have to, and it probably will just work fine with the addon defaults. But for bigger integrations, where much more data is held in the Javascript context (like multiple terminals on one page), it is likely to hit the engine's memory limit sooner or later under decoding and/or storage pressure.
 _How can I adjust the memory usage?_  
 - `pixelLimit`  
  A constructor setting, thus you would have to anticipate, whether (multiple) terminals in your page gonna do lots of concurrent decoding. Since this is normally not the case and the memory usage is only temporarily peaking, a rather high value should work even with multiple terminals in one page.
 - `storageLimit`  
  A constructor and a runtime setting. In conjunction with `storageUsage` you can do runtime checks and adjust the limit to your needs. If you have to lower the limit below the current usage, images will be removed in FIFO order and may turn into a placeholder in the terminal's scrollback (if `showPlaceholder` is set). When adjusting keep in mind to leave enough room for memory peaking for decoding.
 - `sixelSizeLimit`  
  A constructor setting. This has only a small impact on peaking memory during decoding. It is meant to avoid processing of overly big or broken SIXEL sequences at an earlier phase, thus may stop the decoder from entering its memory intensive task for potentially invalid data.
 ### Terminal Interaction
 - Images already on the terminal screen will reshape on font-rescaling to keep the terminal cell coverage intact.
  This behavior might diverge from other terminals, but is in general the more desired one.
 - On terminal resize images may expand to the right automatically, if they were right-truncated before.
  They never expand to the bottom, if they were bottom-truncated before (e.g. from scrolling-off).
 - Text autowrapping from terminal resize may break and wrap images into multiple parts. This is unfortunate,
  but cannot be avoided, while sticking to the stronger terminal text-grid mechanics.
  (Yes images are a second class citizen on a mainly text-driven interface.)
 - Characters written over an image will erase the image information for affected cells.
 - Images are painted above BG/FG data not erasing it. More advanced "composition tricks" like painting images
  below FG/BG data are not possible. (We currently dont hook into BG/FG rendering itself.)
 - Previous image data at a cell will be erased on new image data. (We currently have no transparency composition.)
 ### Performance & Latency
 - Performance should be good enough for occasional SIXEL output from REPLs, up to downscaled movies
  from `mpv` with its SIXEL renderer (tested in the demo). For 3rd party xterm.js integrations this
  furthermore depends highly on the overall incoming data throughput.
 - Image processing has a high latency. Most of the latency though is inherited from xterm.js' incoming data route
  (PTY -> server process -> websocket -> xterm.js async parsing), where every step creates more waiting time.
  Since we cannot do much about that "long line", keep that in mind when you try to run more demanding applications with realtime drawing and interactive response needs.
 ### Status
 - Sixel support and image handling in xterm.js is considered beta quality.
 - IIP support is in alpha stage. Please file a bug for any awkwardities.
 ### Changelog
 - 0.5.0 integrate with xtermjs base repo (at v0.4.3)
 - 0.4.3 defer canvas creation
 - 0.4.2 fix image canvas resize
 - 0.4.1 compat release for xterm.js 5.2.0
 - 0.4.0 IIP support
 - 0.3.1 compat release for xterm.js 5.1.0
 - 0.3.0 important change: worker removed from addon
 - 0.2.0 compat release for xterm.js 5.0.0
 - 0.1.3 bugfix: avoid striping
 - 0.1.2 bugfix: reset clear flag
 - 0.1.1 bugfixes:
  - clear sticky image tiles on render
  - create folder from bootstrap.sh
  - fix peer dependency in package.json
@@ -0,0 +1,22 @@
 #!/bin/bash
 # sixel endless mode
 # Should print an endless sine curve, abort with Ctrl-C.
 period=200
 amplitude=50
 sixels=(@\$ A\$ C\$ G\$ O\$ _\$-)
 pi=$(echo "scale=10; 4*a(1)" | bc -l)
 run=true
 trap run=false INT
 echo -ne "\x1bP0;0;0q\"1;1#1;2;100;0;0#1"
 y=0
 while $run
 do
  x=$(echo "s(2*${pi}*${y}/${period})*${amplitude}+2*${amplitude}+0.5" | bc -l)
  echo -ne "!${x%%.*}?${sixels[$((y%6))]}"
  (( y++ ))
 done
 echo -e "\x1b\\"
@@ -0,0 +1,52 @@
 #!/bin/bash
 # GLF should move the text cursor downwards,
 # even if no pixels were modified,
 # when sixel scrolling is on.
 echo -n $'\e[?80l'		# Ensure sixel scrolling is on (disable DECSDM)
 clear
 echo "A test of Sixel GLF (Graphics Line Feed) when sixel scrolling is on"
 echo
 # Move cursor down three using GLF ("-")
 echo -e '\x1bPq$-$-$-$-\x1b\\'
 # Show a single sixel line that says, "Your terminal ->"
 cat <<'EOF'
 P0;0;0q"1;1;244;21#0;2;0;0;0#1;2;80;80;80#0~~~NFFFN~~~n!4FN!68~NFN!64~bbb!42~rbbbBB!41~$#1???owwwo???O!4wo!68?owo!64?[[[!42?K[[[{{-#0!5~{woBFB`o{}!4~NFBpp!4xpbBF~~~x@@@~~~xxp@@!5~xxp@@b`pxwxpz!17~zpp???!5px!5~NFBpxxwxxpBBN!4~xxp@@b`pxwxpz~x@@@xxp@@pxx@@F!4~xppp@@!8~x@@@pxxwxp@B!5~zxXXXWXX@BF!10~??!24~!10^FNN^~~~$#1!5?BFN{w{]NB@!4?ow{MM!4EM[{w???E}}}???EEM}}!5?EEM}}[]MEFEMC!17?CMM~~~!5ME!5?ow{MEEFEEM{{o!4?EEM}}[]MEFEMC?E}}}EEM}}MEE}}w!4?EMMM}}!8?E}}}MEEFEM}{!5?CEeeefee}{w!10?~~!24?!10_woo_-#0!5~nFFF??FFN!5~wo_FF!4NFb_o!4~{o_!4Ffb??Fn~~~NFF??!4FN!23~_??!5NFFn~~~w__C!7KCC!4~NFF??!4FN!4~N???N~~??Fn~???N~~N!4F??!4Fn~~~F???Fn~~nF??Fn~~p??KMMMEE???Fn~~~N!4F??!4Fn!29~{{}!4~$#1!5?Owww~~wwo!5?FN^ww!4ow[^N!4?BN^!4wW[~~wO???oww~~!4wo!23?^~~!5owwO???F^^z!7rzz!4?oww~~!4wo!4?o~~~o??~~wO?~~~o??o!4w~~!4wO???w~~~wO??Ow~~wO??M~~rpppxx~~~wO???o!4w~~!4wO!29?BB@-#0!25FE!63FE!15FE!77FE!60F$#1!25?@!63?@!15?@!77?@-\
 EOF
 sleep 1
 tput cup 2 30
 # Show four lines saying, "<- A genuine VT340 would end here"
 cat <<'EOF'
 P0;0;0q"1;1;144;80#0;2;0;0;0#1;2;80;80;80#0~~rpp@@`@BN!25~!11^!5~^^^N^^^!6~!7^N^^^!5~!4^~~~!5^!6~^^^WWW!8~!7^N^^^!8~^^^N^^^!5~$#1??KMM}}]}{o!25?!11_!5?___o___!6?!7_o___!5?!4_???!5_!6?___fff!8?!7_o___!8?___o___-#0~~NB??EFE??@F^!19~B??{!4}{W??}}~~B@?K!5MK??B~~~}???{!4}{??!4~}???~~~}}{??!6~}{{{??!8~}???{!4}{??!4~B@?K!5MK??B~~$#1??o{~~xwx~~}w_!19?{~~B!4@Bf~~@@??{}~r!5pr~~{???@~~~B!4@B~~!4?@~~~???@@B~~!6?@BBB~~!8?@~~~B!4@B~~!4?{}~r!5pr~~{-#0rpoopr~~~zpooopr!17~}{ww!4pwW??!4~}wwprrb!4rpp~~~pooopz~~zpoopz!4~{w!4pxwoopz~~~r!4poo!4pz~~~pooopz~~zpoopz~~}wwprrb!4rpp~~$#1KMNNMK???CMNNNMK!17?@BFF!4MFf~~!4?@FFMKK[!4KMM???MNNNMC??CMNNMC!4?BF!4MEFNNMC???K!4MNN!4MC???MNNNMC??CMNNMC??@FFMKK[!4KMM-#0!32~^NNNKWwww[[MNNN^~!13N!5~NN!5FNN^!10~N!4F!8~NN!4FN^!36~$#1!32?_ooorfFFFbbpooo_?!13o!5?oo!5woo_!10?o!4w!8?oo!4wo_-#0!32~}{o?AM!4~E?_w}}~o_o}}???}}}__!5~}}~fFFFAOw!6~^FB_w{???!6~B??}!4~{??!35~$#1!32?@BN~|p!4?x~^F@@?N^N@@~~~@@@^^!5?@@?Wwww|nF!6?_w{^FB~~~!6?{~~@!4?B~~-#0!36~{_?FB?o}!7~^NN???NN^!6~!8NE?_x!4~poooP@@???X!5~{o?F!4NB_o!35~$#1!36?B^~w{~N@!7?_oo~~~oo_!6?!8ox~^E!4?MNNNm}}~~~e!5?BN~w!4o{^N-#0!38~}}}!11~!8}!8~!6}!13~!6}!9~!4}!38~$#1!38?@@@!11?!8@!8?!6@!13?!6@!9?!4@-#0!5^!5~!5^!5~!7^!6~!4^~~~!5^!6~{www??!11~^^^N^\W???!22~^^^N^^^!6~!7^N^^^!8~^^^N^\W???~~$#1!5_!5?!5_!5?!7_!6?!4_???!5_!6?BFFF~~!11?___o_af~~~!22?___o___!6?!7_o___!8?___o_af~~~-#0}{??CMB@@FM??o{~~B@?{{!4}{w?@~~~}???~~~}}{??!10~??!8~B??{!5}{???!19~B@?K!5MK??B~~~}???{!4}{??!4~B??{!5}{???~~$#1@B~~zp{}}wp~~NB??{}~BB!4@BF~}???@~~~???@@B~~!10?~~!8?{~~B!5@B~~~!19?{}~r!5pr~~{???@~~~B!4@B~~!4?{~~B!5@B~~~-#0~~~woow~}woo{!4~}{wpprbrrpww{!5~{w!4pxwoopz~~~r!4poo!4pz~~~}{ww!5pwooopz!17~}wwprrb!4rpp~~~pooopz~~zpoopz~~}{ww!5pwooopz$#1???FNNF?@FNNB!4?@BFMMK[KKMFFB!5?BF!4MEFNNMC???K!4MNN!4MC???@BFF!5MFNNNMC!17?@FFMKK[!4KMM???MNNNMC??CMNNMC??@BFF!5MFNNNMC-#0!40~n!4F!99~$#1!40?O!4w-#0!10~^^n!29~???b!4rbBF!4~^NFbrrprrbFF^!4~rrbBBFBbrrrbv~~^NFbrrprrbFF^!42~$#1!10?__O!29?~~~[!4K[{w!4?_ow[KKMKK[ww_!4?KK[{{w{[KKK[G??_ow[KKMKK[ww_-#0!9~}{wq!10}!18~N???N^~~^N??N^~~o??H!6XWGG!4~^NN??!4N^!5~o??H!6XWGG!42~$#1!9?@BFL!10@!18?o~~~o_??_o~~o_??N~~u!6efvv!4?_oo~~!4o_!5?N~~u!6efvv-#0!41B!6ABB!6A!5BAAA?!6A!4B!10A!8BAAA?!6A!42B$#1!41?!6@??!6@!5?@@@B!6@!4?!10@!8?@@@B!6@$-\This text should be indented.
 EOF
 # For more details, please see:
 # https://github.com/jerch/xterm-addon-image/issues/37
 # By default, sixel is in a 2:1 aspect ratio, which means
 # every sixel graphics linefeed (GLF) adds another 12 pixels.
 # With four GLFs, we have five sixel lines = 5 * 12 =  60 pixels.
 # Which text line that ends up on depends upon the height of your
 # font. On the VT340, the font is 20 pixels high. 
 # On a VT340 sixel scrolling is on by default. DEC refers to this by
 # two different names "sixel scrolling" and its negation, "DECSDM"
 # (Sixel Display Mode). They control the same thing, so when DECSDM is
 # on, sixel scrolling is off, and vice versa. 
 # When DECSDM is on, the graphic line feeds do not affect the text cursor.
 # How hackerb9 created the two sixel test images:
 #
 # convert -family "Courier" -style normal -density 72 -pointsize 26 -interline-spacing -12 -gravity center -fill gray80 -background none label:$'A genuine\nVT340\nwould end\n← here  '  +trim +dither -colors 2 sixel:- > reference.six
 #
 # convert -family "Courier" -style normal -density 72 -pointsize 26 -interline-spacing -12 -gravity center -fill gray80 -background none label:$'Your terminal →'  +trim -bordercolor none -border 2 +dither -colors 2 sixel:- > yourterminal.six
@@ -0,0 +1,44 @@
 const sixelEncode = require('../node_modules/sixel/lib/SixelEncoder').image2sixel;
 const toRGBA8888 = require('../node_modules/sixel/lib/Colors').toRGBA8888;
 function createRect(size, color) {
  const pixels = new Uint32Array(size * size);
  pixels.fill(toRGBA8888(...color));
  return sixelEncode(new Uint8ClampedArray(pixels.buffer), size, size);
 }
 function createRectMinusOne(size, color) {
  const pixels = new Uint32Array(size * size);
  if (size - 1) {
    const sub = new Uint32Array(size - 1);
    sub.fill(toRGBA8888(...color));
    const last = size * (size - 1);
    for (let y = 0; y < last; y += size) {
      pixels.set(sub, y);
    }
  }
  return sixelEncode(new Uint8ClampedArray(pixels.buffer), size, size);
 }
 async function main() {
  // clear + cursor and sixelScrolling off
  process.stdout.write('\x1b[2J\x1b[?25;80h');
  for (let i = 1; i < 300; ++i) {
    await new Promise(res => setTimeout(() => {
      process.stdout.write(createRect(i, [0, 255, 0]));
      res();
    }, 5));
  }
  for (let i = 299; i >= 1; --i) {
    await new Promise(res => setTimeout(() => {
      process.stdout.write(createRectMinusOne(i, [0, 255, 0]));
      res();
    }, 5));
  }
  // re-enable cursor and sixel scrolling
  process.stdout.write('\x1b[2J\x1b[?25;80l');
 }
 main();
@@ -0,0 +1 @@
 ]1337;File=inline=1;size=525;name=Li4vcGFsZXR0ZS5wbmc=:iVBORw0KGgoAAAANSUhEUgAAAoAAAABQCAYAAACJbMQlAAAABmJLR0QA/wD/AP+gvaeTAAABwklEQVR4nO3dwQnEMAwAQedIIem/yVwLBj0C3pm3uAO/Fj2ia631rh3P1lRu7vnof0+Z836zOe83m/N+sznvN5vzfrM57zeb+23+HAAAhxCAAAAxAhAAIEYAAgDECEAAgBgBCAAQIwABAGIEIABAjAAEAIi59z8tDQDACWwAAQBiBCAAQIwABACIEYAAADECEAAgRgACAMQIQACAGAEIABAjAAEAYlwCAQCIsQEEAIgRgAAAMQIQACBGAAIAxAhAAIAYAQgAECMAAQBiBCAAQIwABACIcQkEACDGBhAAIEYAAgDECEAAgBgBCAAQIwABAGIEIABAjAAEAIgRgAAAMQIQACDGJRAAgBgbQACAGAEIABAjAAEAYgQgAECMAAQAiBGAAAAxAhAAIEYAAgDECEAAgBiXQAAAYmwAAQBiBCAAQIwABACIEYAAADECEAAgRgACAMQIQACAGAEIABAjAAEAYlwCAQCIsQEEAIgRgAAAMQIQACBGAAIAxAhAAIAYAQgAECMAAQBiBCAAQIwABACIcQkEACDGBhAAIEYAAgDECEAAgBgBCAAQIwABAGIEIABAjAAEAIgRgAAAMQIQACDmDz4lC02AaqMRAAAAAElFTkSuQmCC
@@ -0,0 +1 @@
 ]1337;File=inline=1;size=1667;name=Li4vdGVzdGltYWdlcy93M2NfaG9tZV8yNTYuZ2lm:R0lGODlhSAAwAPcAAAQCBIyKjMzOzERGRHSOvAxCnLy6vNzm9DRmrCQiJGxubNze3HSWxJSq1JyenCRarPz+/FR+vBweHLzG5FxeXGSKxBROpOzu7ERytDw+PHx+fLTC5AwODIyOjExOTAxGnLy+vDxqtCwuLHR2dNTa7ISezKS23KyurMTO5GyKxOzy/ACCXwAAN7AAF+IAjIEAw8DPArtsAOSupIHW2HBvAsUBAHIAbwAAARwAiEdgA/caAr+CAgCIALAjAOMcJIGCAAB8EADGAAByiAAArcQcSrtHBOT3zYG/AaQA7sVgE3Ib9wCCv88AZ2wAAaIAANUAAG+M4wEjogAc9wCCv8SwGbvGBeRyAIEAAF/PrBZsxwCucgDWAIRvpMUBaHIAAQAAAFCMfEIjj/kcUb+CAAC4sLAZKOL3AIG/AECQoAfGowBy9wAAvwBQAABCAAD5UAC/ALgALBlguPcaUb+CAMRwpNUFaAAAAQAAAOAAAPgAAHIAAAAAAG24DBgZAPf3UL+/AM/QAGzWAKIAUNUAAADgfAD4jwByUQAAAKJtQNUYAH/3AFe/AGTPABNsAACuAADWAAAAMgAABUYAAAIAAACuGQDWBQh/AABXAAJH1AABx8QAcgsAAAMAUAAApTdG9wYCv3oAADMAAKUBULAAAEcCZwEApQCM9wDDv0ACAAcAAABfUAAWAKUAQ7AAAEelAAGwAPhHQ8UBAHIAAAAAABhwFIkFxX8AUIEAABClAtKwADxHAIIBABAUopPXKKZm99Iov/gf+MUXx3IAcgAAAAxwZsYFtHIA9wAAvxgAAIlgAH8aUIGCAHiM1QrDtD0C94IAvxAAAJMASqYChdIAgQxw78YFGXIA+AAAvw4AM6EAGvcA+L8AvyYAALMASveNhb+tgQBKLGAEuDzNUYIBAADRmwABbgAA9wAAv8+kFmzYxWYCUNYAAG+k4wHYKAACQgAAAAAAHmAAxTsoUIIAADwcvcZ6bnIC9wAAvxgAm4kAbn8A94EAv0QABAoAAD0MAIIXACH5BAAAAAAALAAAAABIADAABwj/AAEIHEiwoMGDCBMqXGgQgsOHECNKnEixosWLGDNq3Mixo8ePIEOKHCkxgMkRBkiq7BhAgEmXAlbKxBgAwoALAyDUnMlzYs0EA1LuVIGiKAoVEg8YRXFxQoOnJpZKLYpUY0wII2wKGLBg54EPYD+YkEgi7AemFS2AVRuW7Qe3aB8K8ACAA4UFDy+IcGhg54URFx4+CFthIlsLDCqiKGD2bWOzcSE4MOjAoQYAck0GCPyQweGJFcI+qMiA8eO2azFAFIDQwAUOAEBcRNGWhEQTZg9QRFDg8NrTkSUglKBAYOWLbhNHVGG2wcSvYVNE3GC28MPJA0VoUJCAIAfOFiOE/0UwEYPjCBMbmK0quC17CBkGHodwgcJADRlxO9YdMXTY9w6Jx1gIEZXg2AclQHSBfBLZ911GzIU1VkRufTCBRL8595AKbo0G0QkCUUCRdhuFEBZ6EJFQoXUPTWCWbQ/5B9aFEF0GAF4TCQAeRuqFVeBvH3gYo2gQ0eaYahHR5cFKZTm2AUQIPAajQ4OBpZxD5oXFH0TxzUdSlR9c+VWFFiToUJNgPemQfmCxyCUAO44ko5BsukWeQz1aYMGGg7kVwpQOZSDBTC46BqN4bxn4n0MmgoUiBD2iJhaXGfDUnENuHSCeWmNFCNaEEJRQoVmgalDpTIh+oBp1YJEXKXpsfv+wJQol1IqAbxZU5cCpMuHGlgoMrJUYdG9BEJpaBFKEQoVmLsDrSsSKBSaMYC4blpkUoVmsZT1FCVaj20Lg2bcvXnQsWDDKxtO4jbFoZGNCVsTqWxr2BEGTvtGIqaRuZmsWtvaO+sF7Moalr0VuAdxTwR88uuaBYAH43G8pqItRnBkVGla9DnmqlsOK/btkRhnguFGEbG35UJZg1TtBBHdGFCxbKHSA30UBAHCCRywnG1GksjrkrYXLgTnwAgB4KZEAsN3MUaRXQkSszzJaAGiwJzpUnNJywZa0R9BZEBlED6glpltlokDCuW+h9RoAO0EUgNd7fdQnaWBFpqjAWT9gBCIAxJ1wggLCCcSByR0F22+R4a7cWIUIAIjdQRxc9RFtoBq2uAopnPZBCBJL5jVBElgOUq4WVZB5kZt+u3pECygggkAZdICxvbjnrvvuvPfu++/ABy88Q8QXb/zxAgUEADs=
@@ -0,0 +1 @@
 ]1337;File=inline=1;size=2159;name=Li4vdGVzdGltYWdlcy93M2NfaG9tZV8yNTYuanBn:/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wAARCAAwAEgDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD33/hXPgn/AKE7w3/4K4P/AImj/hXPgn/oTvDf/grg/wDia8y/aLuNX0PWtB1nS7+8ghcGJ4o5mWPejbhlQcHIYj6LXr07J4l8IO1jM8K6lZboZUbayb0yrAjoRkH8K6J4flpwqX0l+BhGrzSlC2qM7/hXPgn/AKE7w3/4K4P/AImj/hXPgn/oTvDf/grg/wDia81/Zt8S313da3ousXk9xcR7biLz5S7DB2OMknvsrov2ifEEujeB0trSd4bq/uFiDRsVYIvzMQR9FH/AquWDlHELD3+ZMcQnS9qdR/wrnwT/ANCd4b/8FcH/AMTR/wAK58E/9Cd4b/8ABXB/8TXhFr4F8dL4SXX5fFCWOntbfays1/OrqhGRkKpGSMcZzyB1q7+z9D4g8QeKzqF3q2pSaZpwzIsty7LJIwIVME4Pcn0wPUVvPL4xhKaqJqJnHFNyUXFq57V/wrnwT/0J3hv/AMFcH/xNH/CufBP/AEJ3hv8A8FcH/wATXgnxP8YePPiB8Sr/AMI/DKe8tbLSG8u4ntZ/ILSKcOzy5BVQ2VCg87ScHoF0/wAcfE3T9Z8O/D7xJZSNr0mq20635YYuLJG3upZeGHycsOdoYEZ6+Ydh6Pd2fgW38Qvpn/CA+G2EaNKzfYoPMEStIrPs8voDDJ37D+JlUld9ceFNNnvzcyISGfzGjKoQW+Yn5iu8Al3yoYA73yPmbJQBzvx30X+2fhtqRRN01jtvE9tmdx/74L1ynw18Z/Y/gVqN20n+laMktuhJ5y3MX4ZdV/CvZ7qCO6tpredQ8UqGN1PdSMEfrXxPqb6hoD674WDExveKkygHLmJnC4Hvuz74Fexl8FiaToy6NP5dTz8VJ0Zqouqa/wAjb+Ed/P4c8f8Ah++uEeO0v2MIc8K6Oxjzn0DgH/gNdt8bpH8V/FnQ/DFu5KQeXC+P4GlIZz+CbD+FT/Grwf8A2L8NvCk1uu2fSQtvMyccuNzN/wB/F/8AH6p/AeO48V/E/VfE2ohWkgRpiQOFkk+VQPYLvH4V3SqQmnjV0TXzvoc6jKP+zPq0/wDM0P2k/FRt47Twnp+Y4QizXOOAQPuR/QY3H/gNdx8BtQ8PS+CoLDQJibm3G+9jlULIZW6uR3BxgEE8ADqK7nUdG0zUlcajp1pdb12t50KuSPqRXzl4bgTwP+0C2m2EhSwMxgKs/HlSR7wpP+ySp5/u1wUnDE4Z0Y6OKv6nTNSpVlUeqenoej/s26IuneAZdSmX/iY6xf3N3cuw+YkSsgB+gXOOxY16bNY2s17b3k1vE91bh1hlZQWjDY3BT2zgZ+lQ6JpcGj2H2O0GIfOllA9PMkaQgewLEVeJx1ryDvFooooAK8K8X+C/tf7QWjTCPNneKt9KSPl3QjDD8dsf/fdel/8ACxvBP/Q4+G//AAaQf/FVG3j/AMCNcJO3i3wwZ0VkSQ6lBuVWILAHdkA7VyO+B6V0YevKg249U0ZVaSqJJ9Hcu/EDRf8AhIfBesaYF3yT27eUP+mi/Mn/AI8BXm3wa8Panb/CDUbjRZ/sms6mzy28xUEgJ8qDDDAztbntuzXoH/CxvBP/AEOPhv8A8GkH/wAVUdv4/wDAltCkNv4t8MRRIMKialAqj6ANTp4mUKTpLun939IUqKlPn8rHkXg340XnhuwuNJ8Y2N9eX9s77ZWbEuSSdkm70PQjtgY4ql8KdCu/iD4+1LxNrVsTppMpkyPkd3QoI1Pfarfhgetet6n4l+F+qzCbVNa8F3soG0PcXVrIwHpliavW3j7wHawJBa+LPC8MKDCRx6jAqqPQANgV1SxtNRl7KFpS3/4BjHDTuueV0tjg0+LX/CvL5/DfxPivRNCT9i1iKHzI7+AfddgORJjAYAEZ54yM8xd/ETV/jN4v0zw/4Btrux8PWV3DealqU67WZY3DKMAkAZXhc5YgdADXrereMPhxrNr9m1fxF4Qv7bOfKur22lTPrhmIpdK8ZfDnSLRbXSfEfhGxtV5ENtfW0SD/AICrAV5h2HbUVyv/AAsbwT/0OPhv/wAGkH/xVFAH/9k=
@@ -0,0 +1 @@
 ]1337;File=inline=1;size=1658;name=Li4vdGVzdGltYWdlcy93M2NfaG9tZV8yNTYucG5n:iVBORw0KGgoAAAANSUhEUgAAAEgAAAAwCAMAAACFQszZAAADAFBMVEUEAgSMiozMzsxERkR0jrwMQpy8urzc5vQ0ZqwkIiRsbmzc3tx0lsSUqtScnpwkWqz8/vxUfrwcHhy8xuRcXlxkisQUTqTs7uxEcrQ8Pjx8fny0wuQMDgyMjoxMTkwMRpy8vrw8arQsLix0dnTU2uyEnsykttysrqzEzuRsisTs8vwAgl8AADewABfiAACBAAlwzwPVbADkrqSB1thwbwLFAQByAG8AAAEcADBHYAf3GgK/ggIA/ACwaADjHByBggAAfA4AxgAAchQAACB0HEbVRwTk98WBvwGkAO7FYBNyG/cAgr/PAGdsAAGiAADVAABvAOMBaaIAHPcAgr90sBXVxgXkcgCBAABfz6wWbMcArnIA1gCEb1TFARNyAAAAAABQANRCaU35HFG/ggAAuLCwGSji9wCBvwD4kKAIxqMAcvcAAL8AUAAAQgAA+VAAvwC4AIQZYHb3GlG/ggDElFTVDxMAAAAAAADgAAD4AAByAAAAAABtuAwYGQD391C/vwDP0ABs1gCiAFDVAAAA4NQA+E0AclEAAACibUDVGAB/9wBXvwBkzwATbAAArgAA1gAAABgAAAVGAAACAAAArhUA1gUIfwAAVwADR9QAAcd0AHIlAAADAFAAAKU3RvcGAr96AAAzAAClAVCwAABHA2cBAKUAAPcACb/4AwAIAAAAX1AAFgClAEOwAABHpQABsAD4R0PFAQByAAAAAAAYlByJD8V/AFCBAAAQpQLSsAA8RwCCAQAQFKKT1yimZvfSKL/4H/jFF8dyAHIAAAAMlGbGD7RyAPcAAL8YAACJYAB/GlCBggB4ANUKCbQ9A/eCAL8QAACTAEqmA4XSAIEMlO/GDxlyAPgAAL8OADOhABr3APi/AL8mAACzAEr3GoW/IIEARoRgBHY8xVGCAQAAz5sAAW4AAPcAAL/PpB5s2MVmAlDWAABvpOMB2CgAAkIAAAAAABZgAMU7KFCCAAA8HL3Gem5yAvcAAL8YAJuJAG5/APeBAL9EAAQKAAA9DACCFwCk+0jYAAAACXBIWXMAAAAAAAAAAACdYiYyAAADIElEQVR4nO2WW3OqQAyAAUehArJWXcDSUiwg3f//A8/msheU0/bBhzNnutMOEZKPJJtkCYJHLfGg9V+CwjD82DwAFEah/oseABKrciXCR4CeVhsEqUkvRXdjkD2tQ57n4+SWuqFEQnyIVbRKARS3eo30oAfZI8m2lXBL8j89it6C5phqobwIsQn19aOE0AqtcfIsM8uZ1q3B0ELQjkp5J8QZzHWywxJ3LQNrNj1p7cKCsrVFAE1W6I9pik3ZBO9GFUATqPX0ewSb2DxN1hSb9B16NqDnLbrlQBBPy/Eo0M/5IWbvE8WX1sSPgV3O2ye4NuUMtNdKCd+o9Ov3LOdgTRsFeZQo1pQeUR61cBYz0AjOxy5JbKxfsG47lAaIbgCpDGw8R88hAimvADAdB5KBj2EqaffgGgRHY3xxDnGvdVqP4umlTYY4gNhbN4l+DoLUGEflLQiTwTFAEIWNEqUJblZk8Ba8iaVFoB40X0BKaJ/Rj8JsZuXVRO12fAFkbWLuiEFwuwB9dNECqPwKZKIYuSESildCwasCb3VUsvXzIseADmDfY0XJgQvA7EBuOgT3ta6/BAkuaHh1vNdWo6uJwfYs/Dp/A4LirrAREnRh77puGoYhwYaD0t59AxrBd5XhEIEWkzptkssa1oRu6T1IvwHRdCto5+GCloNTxD2E3J+XMN5xBAXUsS4MqM6WEy/wEG6830NmoIxTCvUycXILXxPyJ/M7wB2o5wmGHcUj+uRr9u081r+BBHukKIzWGwKewk9AZEwzYKROmR0+MTj5eZOhm3mEC4cGT1mFoe1nNpi44ab1aztSHEhhWrjHKwM97M0MzuDx9Drb/TC43oPQ2FRgzmWd2EypAoNN/SkSNW5oe6DcnSVYnwCFxNFJlXEGt46kOTfHkTWW9rQuJM0nLIRh6rEc4bE+FEOOS3MuYgGkO0NaOePTcPAPbMz+FU7G63UL52STLoIyrwInA63MNNJzgcphZz9km0gsgiZzJMGSDFWfxp/OlNWu4SPb48w//aRXgScLnWDQtZ33knR7CYL6dTa8/6Wv2l/Qj0GPWn8AP2jx/kucqREAAAAASUVORK5CYII=
@@ -0,0 +1,67 @@
 #!/bin/bash
 function print_palette() {
  L=$(( LOWER / 256))
  U=$(( (UPPER-1) / 256))
  for ((p = $L; p <= $U; p++))
  do
    echo "slot $((p*256))..$((p*256+255)):"
    echo -ne "\x1bP;1q"
    for i in {0..15}
    do
      a=$((i * 16 + p * 256))
      for j in {0..15}
      do
        echo -ne "#$((a+j))!6~"
      done
      echo -ne "\$-"
    done
    echo -e "\x1b\\"
  done
 }
 colors=undefined
 max_colors=undefined
 echo "Terminal Reports (XTSMGRAPHICS):"
 IFS=";" read -a REPLY -s -t 1 -d "S" -p $'\e[?1;1;0S'
 [[ ${REPLY[1]} == "0" ]] && colors=${REPLY[2]}
 echo "active colors: ${colors}"
 IFS=";" read -a REPLY -s -t 1 -d "S" -p $'\e[?1;4;0S'
 [[ ${REPLY[1]} == "0" ]] && max_colors=${REPLY[2]}
 echo "max colors   : ${max_colors}"
 echo
 # query up to colors by default
 # if colors is undefined (no XTSMGRAPHICS), assume 256
 ARG1=${1:-${colors}}
 if [[ $colors == "undefined" ]]
 then
  ARG1=${1:-256}
 fi
 LOWER=0
 UPPER=$ARG1
 ARG2=${2:-undefined}
 if [[ $ARG2 != "undefined" ]]
 then
  LOWER=ARG1
  UPPER=ARG2
 fi
 if [[ $colors != "undefined" ]]
 then
  if [[ $colors -lt $UPPER ]] || [[ $colors -lt 256 ]]
  then
    echo -e "\x1b[33mNote: Active colors is smaller than test range."
    echo -e "A spec-conform terminal may repeat colors in 'slot mod ${colors}'.\x1b[m"
    echo
  fi
 else
  echo -e "\x1b[33mNote: Cannot query active colors."
  echo -e "The terminal may repeat colors beyond it max slot (e.g. slot mod 16).\x1b[m"
  echo
 fi
 print_palette
@@ -0,0 +1,141 @@
 #!/bin/bash
 function smiling_smiley() {
  echo -ne '\x1bP;2q"1;1;60;60
 #6!60~$-
 !60~$-
 !60~$
 !15?#1!4]!22?!4]$-
 #6!60~$-
 !60~$-
 !60~$-
 !60~$
 !15?#1!4~!22?!4~$-
 #6!60~$
 !15?#1!30N$-
 #6!60~$-
 !60~$-
 '
  echo -ne '\x1b\\'
 }
 function indifferent_smiley() {
  echo -ne '\x1bP;2q"1;1;60;60
 #6!60~$-
 !60~$-
 !60~$
 !15?#1!4]!22?!4]$-
 #6!60~$-
 !60~$-
 !60~$-
 !60~$-
 !60~$
 !15?#1!30N$-
 #6!60~$-
 !60~$-
 '
  echo -ne '\x1b\\'
 }
 function sad_smiley() {
  echo -ne '\x1bP;2q"1;1;60;60
 #6!60~$-
 !60~$-
 !60~$
 !15?#1!4]!22?!4]$-
 #6!60~$-
 !60~$-
 !60~$-
 !60~$-
 !60~$
 !15?#1!30N$
 !15?#1!4o!22?!4o$-
 #6!60~$
 !15?#1!4B!22?!4B$-
 #6!60~$-
 '
  echo -ne '\x1b\\'
 }
 function smiling_smiley_slim() {
  echo -ne '\x1bP;1q"1;1;60;60
 $-
 $-
 $-
 $-
 $-
 $-
 !15?#1!4~!22?!4~$-
 !15?#1!30N
 '
  echo -ne '\x1b\\'
 }
 function indifferent_smiley_slim() {
  echo -ne '\x1bP;1q"1;1;60;60
 $-
 $-
 $-
 $-
 $-
 $-
 !15?#6!4~!22?!4~$-
 !15?!4o!22?!4o$ !15?#1!30N$-
 !15?#6!4B!22?!4B
 '
  echo -ne '\x1b\\'
 }
 function sad_smiley_slim() {
  echo -ne '\x1bP;1q"1;1;60;60
 $-
 $-
 $-
 $-
 $-
 $-
 $-
 !15?#1!30N$
 !15?#1!4o!22?!4o$-
 !15?#1!4B!22?!4B$-
 '
  echo -ne '\x1b\\'
 }
 function full() {
  smiling_smiley
  sleep .5
  indifferent_smiley
  sleep .5
  sad_smiley
  sleep .5
  indifferent_smiley
  sleep .5
  smiling_smiley
 }
 function slim() {
  smiling_smiley
  sleep .5
  indifferent_smiley_slim
  sleep .5
  sad_smiley_slim
  sleep .5
  indifferent_smiley_slim
  sleep .5
  smiling_smiley_slim
 }
 # clear screen and place cursor to 1;10
 echo -ne '\x1b[2J\x1b[10;1H'
 # switch sixel scrolling off
 echo -ne '\x1b[?80h'
 case "$1" in
  full ) full ;;
  slim ) slim ;;
 esac
 # re-enable sixel scrolling
 echo -ne '\x1b[?80l'
@@ -0,0 +1,288 @@
 #!/bin/bash
 # Test cursor row, column placement after sixel image is sent.
 # After a sixel image is displayed, the text cursor is moved to the
 # row of the last sixel cursor position, but the column stays the same
 # as it was before the sixel image was sent.
 #
 # This can be thought of as sixel images always ending with an
 # implicit Graphics Carriage Return (`$`). 
 # ADDENDUM: It is not as simple as I thought. When a row of sixels
 # straddles two rows of text, the text cursor can be left on the upper row.
 # It seems up to three lines of pixels may be beneath any words printed.
 #
 # The rule for when this happens is not obvious to me, but can be seen
 # with images of height: 21, 22, 23, 24, 41, 42, 81, 82, 83, 84...
 #
 # My guess:
 # for a sixel image of height h, let a=(h-1)%6 and b=(h-1)%20,
 # then, the text will overlap the image when a>b.
 #
 # If that is the case, then the entire list of heights for which this
 # will happen on the VT340's 480 pixel high screen is:
 #
 #  21  22  23  24   41  42   81  82  83  84
 # 101 102  141 142 143 144  161 162 
 # 201 202 203 204  221 222  261 262 263 264  281 282 
 # 321 322 323 324  341 342  381 382 383 384
 # 401 402  441 442 443 444  461 462
 #
 # Note that there are 48 entries, so that means there's a 10% chance
 # if heights are chosen randomly from 1 to 480. However, if one were
 # to always pick heights which are a multiple of the character cell
 # height (20px), then the chances are 0% as there are no problematic
 # heights divisible by 20. 
 # Sixel images often do *not* end with a `-` (Graphics New Line = GNL)
 # which sends the sixel cursor down 6 pixels. Any text printed next
 # will potentially overlap the last row of sixels!
 # I am not yet positive, but I believe that, in general, applications
 # should send sixel images without a GNL but then send `^J`, a text
 # newline (NL), before displaying more text or graphics.
 # IMPORTANT: sometimes neither a graphics nor a text newline is wanted. 
 # For example, if an image is full screen, either newline would cause
 # the top line to scroll off the screen.
 #         | Text cursor column | Text cursor row
 # --------|--------------------|-------------------------------------
 # !GNL !NL| Unchanged	       | Overlapping last line of graphics
 # !GNL  NL| Column=1	       | First line immediately after graphic (usually)
 #  GNL !NL| Unchanged	       | _Sometimes_ overlapping graphics
 #  GNL  NL| Column=1	       | First *or* second line after graphic
 CSI=$'\e['			# Control Sequence Introducer 
 DCS=$'\eP'			# Device Control String
 ST=$'\e\\'			# String Terminator
 set_cursor_pos() {
    # Home, top left is row 1, col 1.
    local row=$1 col=$2
    echo -n ${CSI}${row}';'${col}'H'
 }
 reset_palette() {
    # Send DECRSTS to load colors from a Color Table Report
    echo -n ${DCS}'2$p'
    echo -n "0;2;0;0;0/"        # VT color #0 is black and BG text color
    echo -n "1;2;20;20;79/"	# VT color #1 is blue
    echo -n "2;2;79;13;13/"	# VT color #2 is red
    echo -n "3;2;20;79;20/"	# VT color #3 is green
    echo -n "4;2;79;20;79/"	# VT color #4 is magenta
    echo -n "5;2;20;79;79/"	# VT color #5 is cyan
    echo -n "6;2;79;79;20/"	# VT color #6 is yellow
    echo -n "7;2;46;46;46/"	# VT color #7 is gray 50% and FG text color
    echo -n "8;2;26;26;26/"	# VT color #8 is gray 25%
    echo -n "9;2;33;33;59/"	# VT color #9 is pastel blue
    echo -n "10;2;59;26;26/"	# VT color #10 is pastel red
    echo -n "11;2;33;59;33/"	# VT color #11 is pastel green
    echo -n "12;2;59;33;59/"	# VT color #12 is pastel magenta
    echo -n "13;2;33;59;59/"	# VT color #13 is pastel cyan
    echo -n "14;2;59;59;33/"	# VT color #14 is pastel yellow
    echo -n "15;2;79;79;79"	# VT color #15 is gray 75% and BOLD text color
    echo -n ${ST}		# String Terminator
 }
 # Generate square of size w with final graphics new line removed
 square() {
    # Given a color index number and (optionally) a size, row, and column, 
    # draw a square with top left corner at (row, column) and of size×size px.
    # Default size 100×100px  (10cols, 5 rows)
    local -i color=${1:-1}	# Default is color index 1 (blue)
    local -i size=${2:-100}	# Size in pixels (defaults to 100)
    local -i row=$3 column=$4	# If set to 0, cursor is not moved
    if [[ row -ne 0 && column -ne 0 ]]; then
 	set_cursor_pos $row $column
    fi
    # Draw a square of the right color & size 
    squaresize $color $size
 }
 squaresize() {
    # Helper for square() that uses convert to return a  sixel square of
    # the right color ($1) and size ($2).
    # Similar to this but with variable size squares:
    #    echo -n ${DCS}'0;0;0q"1;1;100;100#'${color}'!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100N'${ST}
    local color=${1:-1}			# Default color index is 1 (blue)
    local size=${2:-100}		# Default size is 100x100
    # Get a sixel string 
    local sq=$(convert -geometry ${size}x${size} xc:black sixel:-)
    # Remove ImageMagick's extraneous Graphic New Line at end of image.
    sq=${sq%-??}$'\e\\'
    # VT340s always used the same color register for the first sixel
    # color defined no matter what number it was assigned. That means,
    # each time we send a new sixel image, the previous one's color
    # palette gets changed. We don't want squares of all the same
    # color, so remove the color definition and just use the defaults.
    sq=${sq/\#0;2;0;0;0/}
    # And finally, switch to the proper index for the color we want.
    echo -n ${sq//\#0/#${color}}
 }
 squaregnl() {
    # Same as square(), but sends a graphics newline at the end of the sixels.
    # (Sticks a `-` before the String Terminator, "Esc \")
    sq=$(square "${@}")
    echo -n ${sq%??}$'-\e\\'
 }
 main() {
    clear
    reset_palette
    show_labels
    neither_graphic_nor_text 96 4 4 31 		# size, color, row, column
    text_newline_only 96 9 4 1
    text_newline_only 84 9 4 14
    graphics_new_line_only 100 1 4 51
    graphics_new_line_only 96 1 4 64
    set_cursor_pos 1000 1
 }
 neither_graphic_nor_text() {
    # Typically sixel images should not end with a Graphics New Line (GNL)
    # However, if a text newline isn't sent, there will be overlap.
    local -i size  color  row  column
    read size color row column <<<"$@"
    set_cursor_pos $((row++)) $column
    echo -n "Height $size"
    set_cursor_pos $((row++)) $column
    # Three squares sent as separate sixel images, indented +1 
    for i in {1..3}; do
 	square $((color++)) $size
 	tput cuf 1
    done
    echo -n "overlap?"
 }
 text_newline_only() {
    # USING A TEXT NEWLINE (NL) after an sixel image that does NOT
    # have GNL is probably the best way to be on the text line
    # immediately below the image. However, the text will still
    # occasionally overlap the last four rows of pixels.
    # Also, if multiple images are intended to be shown, there will
    # usually be a gap between them when using a text newline.
    # Overlap happens because the height of a text cell is 20 pixels
    # and the height of a sixel is 6. 
    # for (h=0; h<480; h++) if ((h-1)%6 > (h-1)%20 ) { h }
    # Let the pixel position of the top of the graphics cursor be 'Yg'
    # and let the pixel position of the top of the corresponding cell
    # of text which the text cursor will be placed on be 'Yt'. Note
    # that Yg is evenly divisible by 6 and Yt, by 20. Taking the
    # remainder, r, after dividing Yg by 20 tells us how many pixels
    # down into a row of text the last line of sixels started. When
    # r==0, the sixels started at the top of the text row.
    # When r = 14, the sixels covered the bottom six pixels on the row
    # of text. When 14 < r < 20, the sixel line impinged by r - 14
    # pixels into the text row below and there is a chance the next
    # text printed will overlap. 
    local -i size  color  row  column
    read size color row column <<<"$@"
    local -i offset
    offset=$((column-1))
    set_cursor_pos $row 1
    if ((offset)); then tput cuf $((offset)); fi
    echo "Height $size"
    # Three squares, separated by text new lines and indented +1 
    for i in {1..3}; do
 	if ((offset)); then tput cuf $offset; fi
 	square $((color++)) $size
 	offset=offset+1
 	echo
    done
    tput cuf $((offset))
    echo -n "overlap?"
 }
 graphics_new_line_only() {
    # However, some sixel images end with a `-`, a Graphics New Line.
    # This can be useful for writing another image starting at the same
    # column without having to reposition the cursor.
    #
    # However, this runs the risk of having occasional overlap.
    local -i size  color  row  column
    read size color row column <<<"$@"
    set_cursor_pos $((row++)) $column
    echo -n "Height $size"
    set_cursor_pos $((row++)) $column
    # Three squares, separated by graphics new lines and indented +1 
    for i in {1..3}; do
 	squaregnl $((color++))  $size
 	tput cuf 1
    done
    echo -n "overlap?"
 }
 show_labels() {
    set_cursor_pos 1 10
    echo -n "Should sixel images include a GNL ('-') at the end?"
    set_cursor_pos 3 29
    echo -n "Neither NL nor GNL"
    set_cursor_pos 3 1
    echo -n "Text New Line only"
    set_cursor_pos 3 51
    echo -n "Graphics New Line only"
    set_cursor_pos 22 29
    echo -n "Always overlaps"		# Neither NL nor GNL
    set_cursor_pos 22 3
    echo -n "Overlaps a little"		# NL only
    set_cursor_pos 23 3
    echo -n "    Gaps a little"		# NL only
    set_cursor_pos 22 54
    echo -n "Overlaps badly"		# GNL only
    set_cursor_pos 23 54
    echo -n "Never gaps"		# GNL only
 }
 main
--- a/Show More
+++ b/Show More
		`@@ -0,0 +1 @@`
							]1337;File=inline=1;size=525;name=Li4vcGFsZXR0ZS5wbmc=:iVBORw0KGgoAAAANSUhEUgAAAoAAAABQCAYAAACJbMQlAAAABmJLR0QA/wD/AP+gvaeTAAABwklEQVR4nO3dwQnEMAwAQedIIem/yVwLBj0C3pm3uAO/Fj2ia631rh3P1lRu7vnof0+Z836zOe83m/N+sznvN5vzfrM57zeb+23+HAAAhxCAAAAxAhAAIEYAAgDECEAAgBgBCAAQIwABAGIEIABAjAAEAIi59z8tDQDACWwAAQBiBCAAQIwABACIEYAAADECEAAgRgACAMQIQACAGAEIABAjAAEAYlwCAQCIsQEEAIgRgAAAMQIQACBGAAIAxAhAAIAYAQgAECMAAQBiBCAAQIwABACIcQkEACDGBhAAIEYAAgDECEAAgBgBCAAQIwABAGIEIABAjAAEAIgRgAAAMQIQACDGJRAAgBgbQACAGAEIABAjAAEAYgQgAECMAAQAiBGAAAAxAhAAIEYAAgDECEAAgBiXQAAAYmwAAQBiBCAAQIwABACIEYAAADECEAAgRgACAMQIQACAGAEIABAjAAEAYlwCAQCIsQEEAIgRgAAAMQIQACBGAAIAxAhAAIAYAQgAECMAAQBiBCAAQIwABACIcQkEACDGBhAAIEYAAgDECEAAgBgBCAAQIwABAGIEIABAjAAEAIgRgAAAMQIQACDmDz4lC02AaqMRAAAAAElFTkSuQmCC
		`@@ -0,0 +1 @@`
							]1337;File=inline=1;size=1667;name=Li4vdGVzdGltYWdlcy93M2NfaG9tZV8yNTYuZ2lm:R0lGODlhSAAwAPcAAAQCBIyKjMzOzERGRHSOvAxCnLy6vNzm9DRmrCQiJGxubNze3HSWxJSq1JyenCRarPz+/FR+vBweHLzG5FxeXGSKxBROpOzu7ERytDw+PHx+fLTC5AwODIyOjExOTAxGnLy+vDxqtCwuLHR2dNTa7ISezKS23KyurMTO5GyKxOzy/ACCXwAAN7AAF+IAjIEAw8DPArtsAOSupIHW2HBvAsUBAHIAbwAAARwAiEdgA/caAr+CAgCIALAjAOMcJIGCAAB8EADGAAByiAAArcQcSrtHBOT3zYG/AaQA7sVgE3Ib9wCCv88AZ2wAAaIAANUAAG+M4wEjogAc9wCCv8SwGbvGBeRyAIEAAF/PrBZsxwCucgDWAIRvpMUBaHIAAQAAAFCMfEIjj/kcUb+CAAC4sLAZKOL3AIG/AECQoAfGowBy9wAAvwBQAABCAAD5UAC/ALgALBlguPcaUb+CAMRwpNUFaAAAAQAAAOAAAPgAAHIAAAAAAG24DBgZAPf3UL+/AM/QAGzWAKIAUNUAAADgfAD4jwByUQAAAKJtQNUYAH/3AFe/AGTPABNsAACuAADWAAAAMgAABUYAAAIAAACuGQDWBQh/AABXAAJH1AABx8QAcgsAAAMAUAAApTdG9wYCv3oAADMAAKUBULAAAEcCZwEApQCM9wDDv0ACAAcAAABfUAAWAKUAQ7AAAEelAAGwAPhHQ8UBAHIAAAAAABhwFIkFxX8AUIEAABClAtKwADxHAIIBABAUopPXKKZm99Iov/gf+MUXx3IAcgAAAAxwZsYFtHIA9wAAvxgAAIlgAH8aUIGCAHiM1QrDtD0C94IAvxAAAJMASqYChdIAgQxw78YFGXIA+AAAvw4AM6EAGvcA+L8AvyYAALMASveNhb+tgQBKLGAEuDzNUYIBAADRmwABbgAA9wAAv8+kFmzYxWYCUNYAAG+k4wHYKAACQgAAAAAAHmAAxTsoUIIAADwcvcZ6bnIC9wAAvxgAm4kAbn8A94EAv0QABAoAAD0MAIIXACH5BAAAAAAALAAAAABIADAABwj/AAEIHEiwoMGDCBMqXGgQgsOHECNKnEixosWLGDNq3Mixo8ePIEOKHCkxgMkRBkiq7BhAgEmXAlbKxBgAwoALAyDUnMlzYs0EA1LuVIGiKAoVEg8YRXFxQoOnJpZKLYpUY0wII2wKGLBg54EPYD+YkEgi7AemFS2AVRuW7Qe3aB8K8ACAA4UFDy+IcGhg54URFx4+CFthIlsLDCqiKGD2bWOzcSE4MOjAoQYAck0GCPyQweGJFcI+qMiA8eO2azFAFIDQwAUOAEBcRNGWhEQTZg9QRFDg8NrTkSUglKBAYOWLbhNHVGG2wcSvYVNE3GC28MPJA0VoUJCAIAfOFiOE/0UwEYPjCBMbmK0quC17CBkGHodwgcJADRlxO9YdMXTY9w6Jx1gIEZXg2AclQHSBfBLZ911GzIU1VkRufTCBRL8595AKbo0G0QkCUUCRdhuFEBZ6EJFQoXUPTWCWbQ/5B9aFEF0GAF4TCQAeRuqFVeBvH3gYo2gQ0eaYahHR5cFKZTm2AUQIPAajQ4OBpZxD5oXFH0TxzUdSlR9c+VWFFiToUJNgPemQfmCxyCUAO44ko5BsukWeQz1aYMGGg7kVwpQOZSDBTC46BqN4bxn4n0MmgoUiBD2iJhaXGfDUnENuHSCeWmNFCNaEEJRQoVmgalDpTIh+oBp1YJEXKXpsfv+wJQol1IqAbxZU5cCpMuHGlgoMrJUYdG9BEJpaBFKEQoVmLsDrSsSKBSaMYC4blpkUoVmsZT1FCVaj20Lg2bcvXnQsWDDKxtO4jbFoZGNCVsTqWxr2BEGTvtGIqaRuZmsWtvaO+sF7Moalr0VuAdxTwR88uuaBYAH43G8pqItRnBkVGla9DnmqlsOK/btkRhnguFGEbG35UJZg1TtBBHdGFCxbKHSA30UBAHCCRywnG1GksjrkrYXLgTnwAgB4KZEAsN3MUaRXQkSszzJaAGiwJzpUnNJywZa0R9BZEBlED6glpltlokDCuW+h9RoAO0EUgNd7fdQnaWBFpqjAWT9gBCIAxJ1wggLCCcSByR0F22+R4a7cWIUIAIjdQRxc9RFtoBq2uAopnPZBCBJL5jVBElgOUq4WVZB5kZt+u3pECygggkAZdICxvbjnrvvuvPfu++/ABy88Q8QXb/zxAgUEADs=
		`@@ -0,0 +1 @@`
							]1337;File=inline=1;size=2159;name=Li4vdGVzdGltYWdlcy93M2NfaG9tZV8yNTYuanBn:/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wAARCAAwAEgDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD33/hXPgn/AKE7w3/4K4P/AImj/hXPgn/oTvDf/grg/wDia8y/aLuNX0PWtB1nS7+8ghcGJ4o5mWPejbhlQcHIYj6LXr07J4l8IO1jM8K6lZboZUbayb0yrAjoRkH8K6J4flpwqX0l+BhGrzSlC2qM7/hXPgn/AKE7w3/4K4P/AImj/hXPgn/oTvDf/grg/wDia81/Zt8S313da3ousXk9xcR7biLz5S7DB2OMknvsrov2ifEEujeB0trSd4bq/uFiDRsVYIvzMQR9FH/AquWDlHELD3+ZMcQnS9qdR/wrnwT/ANCd4b/8FcH/AMTR/wAK58E/9Cd4b/8ABXB/8TXhFr4F8dL4SXX5fFCWOntbfays1/OrqhGRkKpGSMcZzyB1q7+z9D4g8QeKzqF3q2pSaZpwzIsty7LJIwIVME4Pcn0wPUVvPL4xhKaqJqJnHFNyUXFq57V/wrnwT/0J3hv/AMFcH/xNH/CufBP/AEJ3hv8A8FcH/wATXgnxP8YePPiB8Sr/AMI/DKe8tbLSG8u4ntZ/ILSKcOzy5BVQ2VCg87ScHoF0/wAcfE3T9Z8O/D7xJZSNr0mq20635YYuLJG3upZeGHycsOdoYEZ6+Ydh6Pd2fgW38Qvpn/CA+G2EaNKzfYoPMEStIrPs8voDDJ37D+JlUld9ceFNNnvzcyISGfzGjKoQW+Yn5iu8Al3yoYA73yPmbJQBzvx30X+2fhtqRRN01jtvE9tmdx/74L1ynw18Z/Y/gVqN20n+laMktuhJ5y3MX4ZdV/CvZ7qCO6tpredQ8UqGN1PdSMEfrXxPqb6hoD674WDExveKkygHLmJnC4Hvuz74Fexl8FiaToy6NP5dTz8VJ0Zqouqa/wAjb+Ed/P4c8f8Ah++uEeO0v2MIc8K6Oxjzn0DgH/gNdt8bpH8V/FnQ/DFu5KQeXC+P4GlIZz+CbD+FT/Grwf8A2L8NvCk1uu2fSQtvMyccuNzN/wB/F/8AH6p/AeO48V/E/VfE2ohWkgRpiQOFkk+VQPYLvH4V3SqQmnjV0TXzvoc6jKP+zPq0/wDM0P2k/FRt47Twnp+Y4QizXOOAQPuR/QY3H/gNdx8BtQ8PS+CoLDQJibm3G+9jlULIZW6uR3BxgEE8ADqK7nUdG0zUlcajp1pdb12t50KuSPqRXzl4bgTwP+0C2m2EhSwMxgKs/HlSR7wpP+ySp5/u1wUnDE4Z0Y6OKv6nTNSpVlUeqenoej/s26IuneAZdSmX/iY6xf3N3cuw+YkSsgB+gXOOxY16bNY2s17b3k1vE91bh1hlZQWjDY3BT2zgZ+lQ6JpcGj2H2O0GIfOllA9PMkaQgewLEVeJx1ryDvFooooAK8K8X+C/tf7QWjTCPNneKt9KSPl3QjDD8dsf/fdel/8ACxvBP/Q4+G//AAaQf/FVG3j/AMCNcJO3i3wwZ0VkSQ6lBuVWILAHdkA7VyO+B6V0YevKg249U0ZVaSqJJ9Hcu/EDRf8AhIfBesaYF3yT27eUP+mi/Mn/AI8BXm3wa8Panb/CDUbjRZ/sms6mzy28xUEgJ8qDDDAztbntuzXoH/CxvBP/AEOPhv8A8GkH/wAVUdv4/wDAltCkNv4t8MRRIMKialAqj6ANTp4mUKTpLun939IUqKlPn8rHkXg340XnhuwuNJ8Y2N9eX9s77ZWbEuSSdkm70PQjtgY4ql8KdCu/iD4+1LxNrVsTppMpkyPkd3QoI1Pfarfhgetet6n4l+F+qzCbVNa8F3soG0PcXVrIwHpliavW3j7wHawJBa+LPC8MKDCRx6jAqqPQANgV1SxtNRl7KFpS3/4BjHDTuueV0tjg0+LX/CvL5/DfxPivRNCT9i1iKHzI7+AfddgORJjAYAEZ54yM8xd/ETV/jN4v0zw/4Btrux8PWV3DealqU67WZY3DKMAkAZXhc5YgdADXrereMPhxrNr9m1fxF4Qv7bOfKur22lTPrhmIpdK8ZfDnSLRbXSfEfhGxtV5ENtfW0SD/AICrAV5h2HbUVyv/AAsbwT/0OPhv/wAGkH/xVFAH/9k=
		`@@ -0,0 +1 @@`
							]1337;File=inline=1;size=1658;name=Li4vdGVzdGltYWdlcy93M2NfaG9tZV8yNTYucG5n:iVBORw0KGgoAAAANSUhEUgAAAEgAAAAwCAMAAACFQszZAAADAFBMVEUEAgSMiozMzsxERkR0jrwMQpy8urzc5vQ0ZqwkIiRsbmzc3tx0lsSUqtScnpwkWqz8/vxUfrwcHhy8xuRcXlxkisQUTqTs7uxEcrQ8Pjx8fny0wuQMDgyMjoxMTkwMRpy8vrw8arQsLix0dnTU2uyEnsykttysrqzEzuRsisTs8vwAgl8AADewABfiAACBAAlwzwPVbADkrqSB1thwbwLFAQByAG8AAAEcADBHYAf3GgK/ggIA/ACwaADjHByBggAAfA4AxgAAchQAACB0HEbVRwTk98WBvwGkAO7FYBNyG/cAgr/PAGdsAAGiAADVAABvAOMBaaIAHPcAgr90sBXVxgXkcgCBAABfz6wWbMcArnIA1gCEb1TFARNyAAAAAABQANRCaU35HFG/ggAAuLCwGSji9wCBvwD4kKAIxqMAcvcAAL8AUAAAQgAA+VAAvwC4AIQZYHb3GlG/ggDElFTVDxMAAAAAAADgAAD4AAByAAAAAABtuAwYGQD391C/vwDP0ABs1gCiAFDVAAAA4NQA+E0AclEAAACibUDVGAB/9wBXvwBkzwATbAAArgAA1gAAABgAAAVGAAACAAAArhUA1gUIfwAAVwADR9QAAcd0AHIlAAADAFAAAKU3RvcGAr96AAAzAAClAVCwAABHA2cBAKUAAPcACb/4AwAIAAAAX1AAFgClAEOwAABHpQABsAD4R0PFAQByAAAAAAAYlByJD8V/AFCBAAAQpQLSsAA8RwCCAQAQFKKT1yimZvfSKL/4H/jFF8dyAHIAAAAMlGbGD7RyAPcAAL8YAACJYAB/GlCBggB4ANUKCbQ9A/eCAL8QAACTAEqmA4XSAIEMlO/GDxlyAPgAAL8OADOhABr3APi/AL8mAACzAEr3GoW/IIEARoRgBHY8xVGCAQAAz5sAAW4AAPcAAL/PpB5s2MVmAlDWAABvpOMB2CgAAkIAAAAAABZgAMU7KFCCAAA8HL3Gem5yAvcAAL8YAJuJAG5/APeBAL9EAAQKAAA9DACCFwCk+0jYAAAACXBIWXMAAAAAAAAAAACdYiYyAAADIElEQVR4nO2WW3OqQAyAAUehArJWXcDSUiwg3f//A8/msheU0/bBhzNnutMOEZKPJJtkCYJHLfGg9V+CwjD82DwAFEah/oseABKrciXCR4CeVhsEqUkvRXdjkD2tQ57n4+SWuqFEQnyIVbRKARS3eo30oAfZI8m2lXBL8j89it6C5phqobwIsQn19aOE0AqtcfIsM8uZ1q3B0ELQjkp5J8QZzHWywxJ3LQNrNj1p7cKCsrVFAE1W6I9pik3ZBO9GFUATqPX0ewSb2DxN1hSb9B16NqDnLbrlQBBPy/Eo0M/5IWbvE8WX1sSPgV3O2ye4NuUMtNdKCd+o9Ov3LOdgTRsFeZQo1pQeUR61cBYz0AjOxy5JbKxfsG47lAaIbgCpDGw8R88hAimvADAdB5KBj2EqaffgGgRHY3xxDnGvdVqP4umlTYY4gNhbN4l+DoLUGEflLQiTwTFAEIWNEqUJblZk8Ba8iaVFoB40X0BKaJ/Rj8JsZuXVRO12fAFkbWLuiEFwuwB9dNECqPwKZKIYuSESildCwasCb3VUsvXzIseADmDfY0XJgQvA7EBuOgT3ta6/BAkuaHh1vNdWo6uJwfYs/Dp/A4LirrAREnRh77puGoYhwYaD0t59AxrBd5XhEIEWkzptkssa1oRu6T1IvwHRdCto5+GCloNTxD2E3J+XMN5xBAXUsS4MqM6WEy/wEG6830NmoIxTCvUycXILXxPyJ/M7wB2o5wmGHcUj+uRr9u081r+BBHukKIzWGwKewk9AZEwzYKROmR0+MTj5eZOhm3mEC4cGT1mFoe1nNpi44ab1aztSHEhhWrjHKwM97M0MzuDx9Drb/TC43oPQ2FRgzmWd2EypAoNN/SkSNW5oe6DcnSVYnwCFxNFJlXEGt46kOTfHkTWW9rQuJM0nLIRh6rEc4bE+FEOOS3MuYgGkO0NaOePTcPAPbMz+FU7G63UL52STLoIyrwInA63MNNJzgcphZz9km0gsgiZzJMGSDFWfxp/OlNWu4SPb48w//aRXgScLnWDQtZ33knR7CYL6dTa8/6Wv2l/Qj0GPWn8AP2jx/kucqREAAAAASUVORK5CYII=