README
- ::add_windowApp::add_window
- ::newApp::new
- ::runApp::run
- ::window_countApp::window_count
- ::with_windowsApp::with_windows
- ::equalMemoryFile::equal
- ::from_bytesMemoryFile::from_bytes
- ::from_jsonMemoryFile::from_json
- ::from_stringMemoryFile::from_string
- ::hashMemoryFile::hash
- ::hash_combineMemoryFile::hash_combine
- ::not_equalMemoryFile::not_equal
- ::to_jsonMemoryFile::to_json
- ::to_reprMemoryFile::to_repr
- ::MemorySourceMemorySource::MemorySource
- ::equalMemorySource::equal
- ::from_jsonMemorySource::from_json
- ::hashMemorySource::hash
- ::hash_combineMemorySource::hash_combine
- ::not_equalMemorySource::not_equal
- ::to_jsonMemorySource::to_json
- ::to_reprMemorySource::to_repr
- ::equalSource::equal
- ::from_jsonSource::from_json
- ::hashSource::hash
- ::hash_combineSource::hash_combine
- ::htmlSource::html
- ::not_equalSource::not_equal
- ::to_jsonSource::to_json
- ::to_reprSource::to_repr
- ::zipSource::zip
- ::equalTitleBarStyle::equal
- ::from_jsonTitleBarStyle::from_json
- ::hashTitleBarStyle::hash
- ::hash_combineTitleBarStyle::hash_combine
- ::not_equalTitleBarStyle::not_equal
- ::to_jsonTitleBarStyle::to_json
- ::to_reprTitleBarStyle::to_repr
- ::WindowWindow::Window
- ::navigateWindow::navigate
- ::runWindow::run
- ::set_sourceWindow::set_source
- ::equalWindowConfig::equal
- ::from_jsonWindowConfig::from_json
- ::hashWindowConfig::hash
- ::hash_combineWindowConfig::hash_combine
- ::navigateWindowConfig::navigate
- ::newWindowConfig::new
- ::not_equalWindowConfig::not_equal
- ::set_sourceWindowConfig::set_source
- ::to_jsonWindowConfig::to_json
- ::to_reprWindowConfig::to_repr

lepus

A modern desktop application framework based on web technologies.

webview

desktop

app

framework

Download zip

Author

lepus-apps

Version

0.1.9

License

Apache-2.0

Repository

github.com/lepus-apps/lepus

Last updated

7 hours ago

Downloads

Dependencies

#Lepus

Lepus is a desktop application toolkit for MoonBit.

It provides:

a native MoonBit application host
a WebView-based rendering runtime
a plugin system for exposing platform features to frontend code
a MoonBit CLI for scaffolding and local workflows

#Status

Lepus is still in an early stage.

What is already in this repository:

the core app API in lepus.mbt
the WebView runtime in webview/
the CLI in cli/lepus/
official plugin packages in plugins/
runnable examples in examples/

What is not finished yet:

many plugins are still example-backed or placeholders
dev and build are still being expanded
packaging and distribution are not production-ready yet

#Quick Start

#Requirements

You need:

moon
a native toolchain that can build MoonBit native targets
a local environment where the bundled webview library can be loaded

Check your environment:

moon run --target native cli/lepus -- doctor

#Run an Example

Run the basic example:

moon run --target native examples/hello

Run a plugin example:

moon run --target native examples/dialog

#Create a New App

moon run --target native cli/lepus -- init my-app

#API

The current top-level API is centered around:

WindowConfig::new(...)
App::new(main_window, plugins?)
App::with_windows(windows, plugins?)
App::add_window(config)

Minimal app:

///|
async fn main {
  let main_window = @lepus.WindowConfig::new(
    title="Hello Lepus",
    html=(
      #|<!doctype html>
      #|<html><body><h1>Hello Lepus</h1></body></html>,
    ),
  )
  @lepus.App(main_window).run()
}

Plugin-enabled app:

///|
async fn main {
  let main_window = @lepus.WindowConfig::new(
    title="Dialog Example",
    html=@lepus_plugin_support.example_html("dialog", "Dialog Plugin Example"),
  )
  @lepus.App(main_window, plugins=[@lepus_plugin_dialog.plugin()]).run()
}

Window customization example:

///|
async fn main {
  let window = @lepus.WindowConfig::new(
    title="Custom Window",
    frameless=true,
    transparent=true,
    title_bar_style=1, // hidden
    title_bar_overlay=true, // overlay controls
    html="<div class='lepus-titlebar'>Drag me</div>",
  )
  @lepus.App(window).run()
}

#Plugins

Plugins live in plugins/.

Each plugin package exports:

plugin()

Each example installs plugins through:

plugins=[@lepus_plugin_x.plugin()]

The current plugin status matrix is in PLUGINS.md.

#Repository Layout

.
├── cli/lepus/   # CLI implementation
├── examples/    # runnable native examples
├── plugins/     # official plugin packages
├── webview/     # WebView runtime and bridge
├── lepus.mbt    # top-level Lepus API
├── moon.pkg     # root package definition
└── moon.mod

#Development

Useful commands:

moon check
moon test --target native -p lepus-apps/lepus/webview
moon info && moon fmt

CLI help:

moon run --target native cli/lepus -- --help

#License

Apache License 2.0

App

source

pub struct App {
  windows : Array[WindowConfig]
  plugins : Array[@lepus-apps/lepus/webview.Plugin
Plugin]
}

App::add_window

source

fn App::add_window(self : App, config : WindowConfig) -> Unit

App::new

source

fn App::new(windows : Array[WindowConfig], plugins? : Array[@lepus-apps/lepus/webview.Plugin
Plugin]) -> App

App::run

source

async fn App::run(self : App, window_index? : Int) -> Unit

App::window_count

source

fn App::window_count(self : App) -> Int

App::with_windows

source

fn App::with_windows(windows : Array[WindowConfig], plugins? : Array[@lepus-apps/lepus/webview.Plugin
Plugin]) -> App

MemoryFile

source

pub struct MemoryFile {
  path : String
  content : Bytes
} derive(Eq, Hash, ToJson, @moonbitlang/core/debug.Debug
Debug, @moonbitlang/core/json.FromJson
FromJson)

MemoryFile::equal

source

fn MemoryFile::equal(MemoryFile, MemoryFile) -> Bool

MemoryFile::from_bytes

source

fn MemoryFile::from_bytes(path : String, content : Bytes) -> MemoryFile

MemoryFile::from_json

source

fn MemoryFile::from_json(Json, @moonbitlang/core/json.JsonPath
JsonPath) -> MemoryFile raise @moonbitlang/core/json.JsonDecodeError
JsonDecodeError

MemoryFile::from_string

source

fn MemoryFile::from_string(path : String, content : String) -> MemoryFile

MemoryFile::hash

source

fn MemoryFile::hash(self : MemoryFile) -> Int

MemoryFile::hash_combine

source

fn MemoryFile::hash_combine(MemoryFile, Hasher) -> Unit

MemoryFile::not_equal

source

fn MemoryFile::not_equal(x : MemoryFile, y : MemoryFile) -> Bool

MemoryFile::to_json

source

fn MemoryFile::to_json(MemoryFile) -> Json

MemoryFile::to_repr

source

fn MemoryFile::to_repr(MemoryFile) -> @moonbitlang/core/debug.Repr
Repr

MemorySource

source

pub struct MemorySource {
  entry : String
  files : Array[MemoryFile]
} derive(Eq, Hash, ToJson, @moonbitlang/core/debug.Debug
Debug, @moonbitlang/core/json.FromJson
FromJson)

MemorySource::MemorySource

source

#alias(new, deprecated="Use `MemorySource()` instead")
fn MemorySource::MemorySource(files : Array[MemoryFile], entry? : String) -> MemorySource

MemorySource::equal

source

fn MemorySource::equal(MemorySource, MemorySource) -> Bool

MemorySource::from_json

source

fn MemorySource::from_json(Json, @moonbitlang/core/json.JsonPath
JsonPath) -> MemorySource raise @moonbitlang/core/json.JsonDecodeError
JsonDecodeError

MemorySource::hash

source

fn MemorySource::hash(self : MemorySource) -> Int

MemorySource::hash_combine

source

fn MemorySource::hash_combine(MemorySource, Hasher) -> Unit

MemorySource::not_equal

source

fn MemorySource::not_equal(x : MemorySource, y : MemorySource) -> Bool

MemorySource::to_json

source

fn MemorySource::to_json(MemorySource) -> Json

MemorySource::to_repr

source

fn MemorySource::to_repr(MemorySource) -> @moonbitlang/core/debug.Repr
Repr

Source

source

pub(all) enum Source {
  Url(String)
  Local(String)
  Memory(MemorySource)
} derive(Eq, Hash, ToJson, @moonbitlang/core/debug.Debug
Debug, @moonbitlang/core/json.FromJson
FromJson)

Source::equal

source

fn Source::equal(Source, Source) -> Bool

Source::from_json

source

fn Source::from_json(Json, @moonbitlang/core/json.JsonPath
JsonPath) -> Source raise @moonbitlang/core/json.JsonDecodeError
JsonDecodeError

Source::hash

source

fn Source::hash(self : Source) -> Int

Source::hash_combine

source

fn Source::hash_combine(Source, Hasher) -> Unit

Source::html

source

fn Source::html(html : String) -> Source

Source::not_equal

source

fn Source::not_equal(x : Source, y : Source) -> Bool

Source::to_json

source

fn Source::to_json(Source) -> Json

Source::to_repr

source

fn Source::to_repr(Source) -> @moonbitlang/core/debug.Repr
Repr

Source::zip

source

fn Source::zip(zip : Bytes) -> Source raise

TitleBarStyle

source

pub enum TitleBarStyle {
  Default
  Hidden
} derive(Eq, Hash, ToJson, @moonbitlang/core/debug.Debug
Debug, @moonbitlang/core/json.FromJson
FromJson)

TitleBarStyle::equal

source

fn TitleBarStyle::equal(TitleBarStyle, TitleBarStyle) -> Bool

TitleBarStyle::from_json

source

fn TitleBarStyle::from_json(Json, @moonbitlang/core/json.JsonPath
JsonPath) -> TitleBarStyle raise @moonbitlang/core/json.JsonDecodeError
JsonDecodeError

TitleBarStyle::hash

source

fn TitleBarStyle::hash(self : TitleBarStyle) -> Int

TitleBarStyle::hash_combine

source

fn TitleBarStyle::hash_combine(TitleBarStyle, Hasher) -> Unit

TitleBarStyle::not_equal

source

fn TitleBarStyle::not_equal(x : TitleBarStyle, y : TitleBarStyle) -> Bool

TitleBarStyle::to_json

source

fn TitleBarStyle::to_json(TitleBarStyle) -> Json

TitleBarStyle::to_repr

source

fn TitleBarStyle::to_repr(TitleBarStyle) -> @moonbitlang/core/debug.Repr
Repr

Window

source

pub struct Window {
  config : WindowConfig
  plugins : Array[@lepus-apps/lepus/webview.Plugin
Plugin]
}

Window::Window

source

#alias(new, deprecated="Use `Window()` instead")
fn Window::Window(title? : String, width? : Int, height? : Int, debug? : Int, devtools? : Bool, frameless? : Bool, resizable? : Bool, always_on_top? : Bool, transparent? : Bool, title_bar_style? : TitleBarStyle, title_bar_overlay? : Bool, traffic_light_position? : (Int, Int), source? : Source, plugins? : Array[@lepus-apps/lepus/webview.Plugin
Plugin]) -> Window

Window::navigate

source

fn Window::navigate(self : Window, url : String) -> Window

Window::run

source

async fn Window::run(self : Window) -> Unit

Window::set_source

source

fn Window::set_source(self : Window, source : Source) -> Window

WindowConfig

source

pub struct WindowConfig {
  title : String
  width : Int
  height : Int
  debug : Int
  devtools : Bool
  frameless : Bool
  resizable : Bool
  always_on_top : Bool
  transparent : Bool
  title_bar_style : TitleBarStyle
  title_bar_overlay : Bool
  traffic_light_position : (Int, Int)
  source : Source?
} derive(Eq, Hash, ToJson, @moonbitlang/core/debug.Debug
Debug, @moonbitlang/core/json.FromJson
FromJson)

WindowConfig::equal

source

fn WindowConfig::equal(WindowConfig, WindowConfig) -> Bool

WindowConfig::from_json

source

fn WindowConfig::from_json(Json, @moonbitlang/core/json.JsonPath
JsonPath) -> WindowConfig raise @moonbitlang/core/json.JsonDecodeError
JsonDecodeError

WindowConfig::hash

source

fn WindowConfig::hash(self : WindowConfig) -> Int

WindowConfig::hash_combine

source

fn WindowConfig::hash_combine(WindowConfig, Hasher) -> Unit

WindowConfig::navigate

source

fn WindowConfig::navigate(self : WindowConfig, url : String) -> WindowConfig

WindowConfig::new

source

fn WindowConfig::new(title? : String, width? : Int, height? : Int, debug? : Int, devtools? : Bool, frameless? : Bool, resizable? : Bool, always_on_top? : Bool, transparent? : Bool, title_bar_style? : TitleBarStyle, title_bar_overlay? : Bool, traffic_light_position? : (Int, Int), source? : Source) -> WindowConfig

WindowConfig::not_equal

source

fn WindowConfig::not_equal(x : WindowConfig, y : WindowConfig) -> Bool

WindowConfig::set_source

source

fn WindowConfig::set_source(self : WindowConfig, source : Source) -> WindowConfig

WindowConfig::to_json

source

fn WindowConfig::to_json(WindowConfig) -> Json

WindowConfig::to_repr

source

fn WindowConfig::to_repr(WindowConfig) -> @moonbitlang/core/debug.Repr
Repr

Source Files

Site source Report issue Packages Build queue Skills Statistics

lepus

#Lepus

#Status

#Quick Start

#Requirements

#Run an Example

#Create a New App

#API

#Plugins

#Repository Layout

#Development

#License

#App

#App::add_window

#App::new

#App::run

#App::window_count

#App::with_windows

#MemoryFile

#MemoryFile::equal

#MemoryFile::from_bytes

#MemoryFile::from_json

#MemoryFile::from_string

#MemoryFile::hash

#MemoryFile::hash_combine

#MemoryFile::not_equal

#MemoryFile::to_json

#MemoryFile::to_repr

#MemorySource

#MemorySource::MemorySource

#MemorySource::equal

#MemorySource::from_json

#MemorySource::hash

#MemorySource::hash_combine

#MemorySource::not_equal

#MemorySource::to_json

#MemorySource::to_repr

#Source

#Source::equal

#Source::from_json

#Source::hash

#Source::hash_combine

#Source::html

#Source::not_equal

#Source::to_json

#Source::to_repr

#Source::zip

#TitleBarStyle

#TitleBarStyle::equal

#TitleBarStyle::from_json

#TitleBarStyle::hash

#TitleBarStyle::hash_combine

#TitleBarStyle::not_equal

#TitleBarStyle::to_json

#TitleBarStyle::to_repr

#Window

#Window::Window

#Window::navigate

#Window::run

#Window::set_source

#WindowConfig

#WindowConfig::equal

#WindowConfig::from_json

#WindowConfig::hash

#WindowConfig::hash_combine

#WindowConfig::navigate

#WindowConfig::new

#WindowConfig::not_equal

#WindowConfig::set_source

#WindowConfig::to_json

#WindowConfig::to_repr

Source Files

App

App::add_window

App::new

App::run

App::window_count

App::with_windows

MemoryFile

MemoryFile::equal

MemoryFile::from_bytes

MemoryFile::from_json

MemoryFile::from_string

MemoryFile::hash

MemoryFile::hash_combine

MemoryFile::not_equal

MemoryFile::to_json

MemoryFile::to_repr

MemorySource

MemorySource::MemorySource

MemorySource::equal

MemorySource::from_json

MemorySource::hash

MemorySource::hash_combine

MemorySource::not_equal

MemorySource::to_json

MemorySource::to_repr

Source

Source::equal

Source::from_json

Source::hash

Source::hash_combine

Source::html

Source::not_equal

Source::to_json

Source::to_repr

Source::zip

TitleBarStyle

TitleBarStyle::equal

TitleBarStyle::from_json

TitleBarStyle::hash

TitleBarStyle::hash_combine

TitleBarStyle::not_equal

TitleBarStyle::to_json

TitleBarStyle::to_repr

Window

Window::Window

Window::navigate

Window::run

Window::set_source

WindowConfig

WindowConfig::equal

WindowConfig::from_json

WindowConfig::hash

WindowConfig::hash_combine

WindowConfig::navigate

WindowConfig::new

WindowConfig::not_equal

WindowConfig::set_source

WindowConfig::to_json

WindowConfig::to_repr