Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webview/webview_deno
🌐 Deno bindings for webview, a tiny library for creating web-based desktop GUIs
https://github.com/webview/webview_deno
deno deno-bindings deno-module deno-plugin deno-plugins deno-webview gui hacktoberfest typescript webview
Last synced: 22 days ago
JSON representation
🌐 Deno bindings for webview, a tiny library for creating web-based desktop GUIs
- Host: GitHub
- URL: https://github.com/webview/webview_deno
- Owner: webview
- License: mit
- Created: 2020-03-05T19:52:18.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-08T08:12:38.000Z (6 months ago)
- Last Synced: 2024-08-04T00:06:29.095Z (3 months ago)
- Topics: deno, deno-bindings, deno-module, deno-plugin, deno-plugins, deno-webview, gui, hacktoberfest, typescript, webview
- Language: TypeScript
- Homepage: https://deno.land/x/webview
- Size: 961 KB
- Stars: 1,388
- Watchers: 24
- Forks: 71
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-list - webview_deno - based desktop GUIs | webview | 849 | (Rust)
- awesome-electron-alternatives - webview_deno - based desktop GUIs (👓 Alternatives to the [Electron.js](https://electronjs.org) ⚛ / Javascript)
README
# webview_deno
[](https://github.com/webview/webview_deno/stargazers)
[](https://github.com/webview/webview_deno/issues)
[](https://github.com/webview/webview_deno/actions)
[](https://github.com/webview/webview_deno/releases/latest/)
[](https://jsr.io/@webview/webview)
[](https://github.com/denoland/deno)
[](https://doc.deno.land/https/deno.land/x/webview/mod.ts)
[](https://github.com/webview/webview_deno/blob/master/LICENSE)
[deno](https://github.com/denoland/deno) bindings for
[webview](https://github.com/webview/webview)
Webview is a tiny cross-platform library to make **web-based GUIs for desktop
applications**.
---
> ⚠️ This project is still in development. Expect breaking changes.
---
## Installation
Webview is published to [jsr.io](https://jsr.io/@webview/webview) and
[deno.land](https://deno.land/x/webview). The recommended way to use it is to
use JSR:
```bash
deno add @webview/webview
```
or without the CLI:
```typescript
import { Webview } from "jsr:@webview/webview";
```
## Example
```typescript
import { Webview } from "@webview/webview";
const html = `
Hello from deno v${Deno.version.deno}
`;
const webview = new Webview();
webview.navigate(`data:text/html,${encodeURIComponent(html)}`);
webview.run();
```
You can run this example directly from the web:
```bash
deno run -Ar --unstable https://deno.land/x/webview/examples/local.ts
```
or in your development environment:
```bash
deno run -Ar --unstable examples/local.ts
```
you can find other examples in the [`examples/`](examples) directory.
## Documentation
You can find the official documentation
[here](https://jsr.io/@webview/webview/doc).
## Development
### Prerequisites
#### Linux
- [webkit2gtk](https://webkitgtk.org/) (to install using apt:
`sudo apt-get install libwebkit2gtk-4.0-dev`)
### Building
Make sure to init the webview submodule with:
```bash
$ git submodule update --init --recursive
```
Building on Windows requires admin privileges.
```bash
$ deno task build
```
### Running
To run webview_deno without automatically downloading the binaries from
[releases](https://github.com/webview/webview_deno/releases) you will need to
use the environment variable `PLUGIN_URL` and set it to the path where the built
binaries are located. This is usually `file://./target/release`.
```bash
$ deno task build
$ PLUGIN_URL=./build/
$ deno run --unstable -A examples/local.ts
```
or
```bash
$ deno task run examples/local.ts
```
or if you have the webview library already built and didn't make any changes to
it, you can skip the building step with:
```bash
$ deno task run:fast examples/local.ts
```
## Environment variables
- `PLUGIN_URL` - Set a custom library URL. Defaults to the latest release assets
on Github. Setting this also disables cache for `plug`.
## Dependencies
- [plug](https://jsr.io/@denosaurs/plug)
- [webview](https://github.com/webview/webview)
## Other
### Contribution
Pull request, issues and feedback are very welcome. Code style is formatted with
`deno task fmt`, linted with `deno task lint` and commit messages are done
following [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
spec.
### Licence
Copyright 2020-2022, the webview_deno team. All rights reserved. MIT license.