@battlefieldduck/xterm-svelte 0.1.0 → 1.0.1

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.
package/README.md CHANGED
@@ -38,32 +38,38 @@ Here's a basic example of how to use xterm-svelte in your SvelteKit application:
38
38
 
39
39
  ```svelte
40
40
  <script lang="ts">
41
- import { Xterm } from '@battlefieldduck/xterm-svelte';
42
- import type { ITerminalOptions, ITerminalInitOnlyOptions, Terminal } from '@battlefieldduck/xterm-svelte';
43
-
44
- let options: ITerminalOptions & ITerminalInitOnlyOptions = {};
45
-
46
- async function onLoad(event: CustomEvent<{ terminal: Terminal }>) {
47
- console.log('Child component has loaded');
48
- const terminal = event.detail.terminal;
49
-
50
- // FitAddon Usage
51
- const fitAddon = new (await XtermAddon.FitAddon()).FitAddon();
52
- terminal.loadAddon(fitAddon);
53
- fitAddon.fit();
54
-
55
- terminal.write('Hello World');
56
- }
57
-
58
- function onData(event: CustomEvent<string>) {
59
- const data = event.detail;
60
- console.log('onData()', data);
61
- }
62
-
63
- function onKey(event: CustomEvent<{ key: string; domEvent: KeyboardEvent }>) {
64
- const data = event.detail;
65
- console.log('onKey()', data);
66
- }
41
+ import { Xterm, XtermAddon } from '@battlefieldduck/xterm-svelte';
42
+ import type {
43
+ ITerminalOptions,
44
+ ITerminalInitOnlyOptions,
45
+ Terminal
46
+ } from '@battlefieldduck/xterm-svelte';
47
+
48
+ let options: ITerminalOptions & ITerminalInitOnlyOptions = {
49
+ fontFamily: 'Consolas'
50
+ };
51
+
52
+ async function onLoad(event: CustomEvent<{ terminal: Terminal }>) {
53
+ console.log('Child component has loaded');
54
+ const terminal = event.detail.terminal;
55
+
56
+ // FitAddon Usage
57
+ const fitAddon = new (await XtermAddon.FitAddon()).FitAddon();
58
+ terminal.loadAddon(fitAddon);
59
+ fitAddon.fit();
60
+
61
+ terminal.write('Hello World');
62
+ }
63
+
64
+ function onData(event: CustomEvent<string>) {
65
+ const data = event.detail;
66
+ console.log('onData()', data);
67
+ }
68
+
69
+ function onKey(event: CustomEvent<{ key: string; domEvent: KeyboardEvent }>) {
70
+ const data = event.detail;
71
+ console.log('onKey()', data);
72
+ }
67
73
  </script>
68
74
 
69
75
  <Xterm {options} on:load={onLoad} on:data={onData} on:key={onKey} />
@@ -1,4 +1,3 @@
1
- /// <reference types="@xterm/xterm" />
2
1
  import { SvelteComponent } from "svelte";
3
2
  import '@xterm/xterm/css/xterm.css';
4
3
  import type { ITerminalOptions, ITerminalInitOnlyOptions } from './index.js';
@@ -36,6 +35,8 @@ declare const __propDef: {
36
35
  [evt: string]: CustomEvent<any>;
37
36
  };
38
37
  slots: {};
38
+ exports?: undefined;
39
+ bindings?: undefined;
39
40
  };
40
41
  export type XtermProps = typeof __propDef.props;
41
42
  export type XtermEvents = typeof __propDef.events;
package/dist/index.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="@xterm/xterm" />
2
1
  import Xterm from './Xterm.svelte';
3
2
  import { XtermAddon } from './XtermAddon.js';
4
3
  import type { XtermEvent } from './XtermEvent.js';
package/package.json CHANGED
@@ -1,8 +1,14 @@
1
1
  {
2
2
  "name": "@battlefieldduck/xterm-svelte",
3
- "version": "0.1.0",
3
+ "version": "1.0.1",
4
4
  "description": "A SvelteKit wrapper for Xterm.js, enabling terminal embedding in SvelteKit apps, managing Xterm addons, and providing seamless updates with the latest SvelteKit and Xterm.js versions.",
5
- "keywords": ["svelte", "xterm", "xterm-js", "sveltekit", "xterm-svelte"],
5
+ "keywords": [
6
+ "svelte",
7
+ "xterm",
8
+ "xterm-js",
9
+ "sveltekit",
10
+ "xterm-svelte"
11
+ ],
6
12
  "repository": {
7
13
  "type": "git",
8
14
  "url": "git+https://github.com/BattlefieldDuck/xterm-svelte.git"
@@ -60,7 +66,7 @@
60
66
  "tslib": "^2.4.1",
61
67
  "typescript": "^5.0.0",
62
68
  "vite": "^5.2.10",
63
- "vitest": "^1.5.2"
69
+ "vitest": "^2.0.3"
64
70
  },
65
71
  "svelte": "./dist/index.js",
66
72
  "types": "./dist/index.d.ts",