react-xterm-shell 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +3 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,11 +1,13 @@
1
1
  # react-xterm-shell
2
2
 
3
- [npm package](https://www.npmjs.com/package/react-xterm-shell)
3
+ [Demo](https://react-xterm-shell-example.pages.dev) | [npm package](https://www.npmjs.com/package/react-xterm-shell) | [Example source](https://github.com/noah-wardlow/react-xterm-shell/tree/main/example)
4
4
 
5
5
  > **Beta** — under active development; the API may change between minor versions until 1.0.
6
6
 
7
7
  A small React shell around [xterm.js](https://xtermjs.org/). It is a **React shell around xterm, not a React renderer for terminal cells** — xterm owns the grid, parsing, and rendering; this gives you the lifecycle, a stable imperative controller, automatic fitting, and opt-in addons as ordinary React.
8
8
 
9
+ The demo is a Vite web page with theme switching, transport telemetry, and a mock backend filesystem users can mutate from the terminal.
10
+
9
11
  - `useXTerm()` — creates and owns the xterm instance behind a stable controller.
10
12
  - `<XTerm />` — the DOM mount point.
11
13
  - `TerminalProvider` / `useTerminalController()` — drive the terminal from surrounding UI without prop drilling.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "react-xterm-shell",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "description": "A small React shell around xterm.js: a useXTerm hook + XTerm component with a stable imperative controller, automatic fitting, and opt-in webgl/web-links/unicode11 addons.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",