https://github.com/segeljakt/xterm-js-rs

Rust-WebAssembly bindings to the xterm-js Javascript library
https://github.com/segeljakt/xterm-js-rs

command-line javascript rust-wasm web xterm-js

Last synced: 2 months ago
JSON representation

Rust-WebAssembly bindings to the xterm-js Javascript library

• Host: GitHub
• URL: https://github.com/segeljakt/xterm-js-rs
• Owner: segeljakt
• License: mit
• Created: 2020-05-08T20:25:08.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T21:51:26.000Z (about 2 years ago)
• Last Synced: 2024-10-12T19:14:56.481Z (3 months ago)
• Topics: command-line, javascript, rust-wasm, web, xterm-js
• Language: Rust
• Homepage: https://xtermjs.org/
• Size: 756 KB
• Stars: 32
• Watchers: 2
• Forks: 8
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
🕸 xterm-js-rs 🦀




  

    

  



This crate provides **Rust-WebAssembly** bindings to the [`xterm-js`](https://github.com/xtermjs/xterm.js) **Javascript** library and can be used to setup a custom web-based [**command-line**](https://segeljakt.github.io/xterm-js-rs) for your crate, without much effort, running at the client-side.

## 🎥 Example

To see it running in action on **GitHub Pages**: https://segeljakt.github.io/xterm-js-rs. Code for the example can be found [here](https://github.com/segeljakt/xterm-js-rs/blob/master/example/src/lib.rs).

## 🚀 GitHub Actions and GitHub Pages

The **GitHub Actions** workflow for automatically deploying the website to **GitHub Pages** can be found [here](https://github.com/segeljakt/xterm-js-rs/blob/master/.github/workflows/gh-pages.yml) along with instructions to setup **GitHub Pages**.

## 🔬 Documentation

For an overview of what the bindings do, checkout the official [API](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts).

## 🎚 Addons

Conditionally, [addons](https://github.com/xtermjs/xterm.js/tree/master/addons) of `xterm-js` can be activated by compiling this crate with the corresponding features enabled:

  - `xterm-addon-attach`

  - `xterm-addon-fit`

  - `xterm-addon-ligatures`

  - `xterm-addon-search`

  - `xterm-addon-serialize`

  - `xterm-addon-unicode11`

  - `xterm-addon-web-links`

  - `xterm-addon-webgl`

## ⚠️ Information

If your npm-crate depends on this crate, then it must contain a `package.json` in the root directory and `www` directory which specifies the dependencies to the `xterm-js` library. As in the example:

  - [example/package.json](https://github.com/segeljakt/xterm-js-rs/blob/c5c1a2ab5ba605c83d517330b41a90f658b2c123/example/package.json#L3-L4)

  - [example/www/package.json](https://github.com/segeljakt/xterm-js-rs/blob/c5c1a2ab5ba605c83d517330b41a90f658b2c123/example/www/package.json#L31-L32)

## 👷 Help Wanted

Help with adding support for `xterm-js-rs` in existing Rust-REPL-libraries ([linefeed](https://github.com/murarth/linefeed), [liner](https://github.com/redox-os/liner), [rustyline](https://github.com/kkawakam/rustyline), [termwiz](https://github.com/wez/wezterm/tree/master/termwiz)) is greatly appreciated!

## 😕 TODO

* Add proper documentation, tests, and cleaner API.