@battlefieldduck/xterm-svelte 0.0.5 → 1.0.0

package/README.md

@@ -1,17 +1,28 @@
 # xterm-svelte
 
-[![Node.js Build](https://github.com/BattlefieldDuck/xterm-svelte/actions/workflows/node-build.yml/badge.svg)](https://github.com/BattlefieldDuck/xterm-svelte/actions/workflows/node-build.yml)
+<img align="right" width="100" height="100" src="https://github.com/BattlefieldDuck/xterm-svelte/assets/29337428/e1055940-ae66-48b5-9a1f-1965949b5757">
 
+[![Node.js Build](https://github.com/BattlefieldDuck/xterm-svelte/actions/workflows/node-build.yml/badge.svg)](https://github.com/BattlefieldDuck/xterm-svelte/actions/workflows/node-build.yml)
+[![NPM Version](https://img.shields.io/npm/v/%40battlefieldduck%2Fxterm-svelte)](https://www.npmjs.com/package/@battlefieldduck/xterm-svelte)
+![NPM Downloads](https://img.shields.io/npm/dw/%40battlefieldduck%2Fxterm-svelte)
 
 xterm-svelte is a wrapper for the [xterm.js](https://github.com/xtermjs/xterm.js) library, designed to work seamlessly with SvelteKit. This library allows you to embed a fully functional terminal in your SvelteKit application.
 
-Live Demo: https://xterm-svelte.pages.dev
+Check it out: https://xterm-svelte.pages.dev
 
 ## Features
 
-- Full integration with SvelteKit.
-- Xterm addons is managed in xterm-svelte
-- Continuous package updates: xterm-svelte is regularly updated to ensure compatibility with the latest versions of SvelteKit and Xterm.js.
+- **Full integration with SvelteKit**
+
+  Xterm-Svelte is designed to work seamlessly with SvelteKit, allowing you to easily incorporate terminal functionality into your SvelteKit projects.
+
+- **Xterm addons management**
+
+  Xterm addons are managed within Xterm-Svelte, providing a unified and consistent interface for working with Xterm and its addons.
+
+- **Continuous package updates**
+
+  Xterm-Svelte is regularly updated to ensure compatibility with the latest versions of SvelteKit and Xterm.js. This means you can always use the latest features and improvements from these libraries in your projects.
 
 ## Installation
 
@@ -27,33 +38,38 @@ Here's a basic example of how to use xterm-svelte in your SvelteKit application:
 
 ```svelte
 <script lang="ts">
-    import { Xterm } from '@battlefieldduck/xterm-svelte';
-    import type { ITerminalOptions, ITerminalInitOnlyOptions, Terminal } from '@battlefieldduck/xterm-svelte';
-
-    let options: ITerminalOptions & ITerminalInitOnlyOptions = {};
-
-    async function onLoad(event: CustomEvent<{ terminal: Terminal }>) {
-        console.log('Child component has loaded');
-        const terminal = event.detail.terminal;
-
-        // FitAddon Usage
-        const { FitAddon } = await XtermAddon.FitAddon();
-        const fitAddon = new FitAddon();
-        terminal.loadAddon(fitAddon);
-        fitAddon.fit();
-
-        terminal.write('Hello World');
-    }
-
-    function onData(event: CustomEvent<string>) {
-        const data = event.detail;
-        console.log('onData()', data);
-    }
-
-    function onKey(event: CustomEvent<{ key: string; domEvent: KeyboardEvent }>) {
-        const data = event.detail;
-        console.log('onKey()', data);
-    }
+	import { Xterm, XtermAddon } from '@battlefieldduck/xterm-svelte';
+	import type {
+		ITerminalOptions,
+		ITerminalInitOnlyOptions,
+		Terminal
+	} from '@battlefieldduck/xterm-svelte';
+
+	let options: ITerminalOptions & ITerminalInitOnlyOptions = {
+		fontFamily: 'Consolas'
+	};
+
+	async function onLoad(event: CustomEvent<{ terminal: Terminal }>) {
+		console.log('Child component has loaded');
+		const terminal = event.detail.terminal;
+
+		// FitAddon Usage
+		const fitAddon = new (await XtermAddon.FitAddon()).FitAddon();
+		terminal.loadAddon(fitAddon);
+		fitAddon.fit();
+
+		terminal.write('Hello World');
+	}
+
+	function onData(event: CustomEvent<string>) {
+		const data = event.detail;
+		console.log('onData()', data);
+	}
+
+	function onKey(event: CustomEvent<{ key: string; domEvent: KeyboardEvent }>) {
+		const data = event.detail;
+		console.log('onKey()', data);
+	}
 </script>
 
 <Xterm {options} on:load={onLoad} on:data={onData} on:key={onKey} />

package/dist/XtermAddonType.d.ts

@@ -0,0 +1,11 @@
+export type * from '@xterm/addon-attach';
+export type * from '@xterm/addon-canvas';
+export type * from '@xterm/addon-clipboard';
+export type * from '@xterm/addon-fit';
+export type * from '@xterm/addon-image';
+export type * from '@xterm/addon-ligatures';
+export type * from '@xterm/addon-search';
+export type * from '@xterm/addon-serialize';
+export type * from '@xterm/addon-unicode11';
+export type * from '@xterm/addon-web-links';
+export type * from '@xterm/addon-webgl';

package/dist/XtermAddonType.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -4,4 +4,5 @@ import { XtermAddon } from './XtermAddon.js';
 import type { XtermEvent } from './XtermEvent.js';
 export { Xterm, XtermAddon };
 export type * from '@xterm/xterm';
+export type * from './XtermAddonType.js';
 export type { XtermEvent };

package/dist/index.js

@@ -1,3 +1,5 @@
+// Imports
 import Xterm from './Xterm.svelte';
 import { XtermAddon } from './XtermAddon.js';
+// Exports
 export { Xterm, XtermAddon };

package/package.json

@@ -1,6 +1,23 @@
 {
 	"name": "@battlefieldduck/xterm-svelte",
-	"version": "0.0.5",
+	"version": "1.0.0",
+	"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.",
+	"keywords": [
+		"svelte",
+		"xterm",
+		"xterm-js",
+		"sveltekit",
+		"xterm-svelte"
+	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/BattlefieldDuck/xterm-svelte.git"
+	},
+	"homepage": "https://xterm-svelte.pages.dev",
+	"bugs": {
+		"url": "https://github.com/BattlefieldDuck/xterm-svelte/issues"
+	},
+	"license": "MIT",
 	"scripts": {
 		"dev": "vite dev",
 		"build": "vite build && npm run package",
@@ -68,4 +85,4 @@
 		"@xterm/addon-webgl": "^0.18.0",
 		"@xterm/xterm": "^5.5.0"
 	}
-}
+}