Lib.rs

Running a reference implementation

In addition to the tooling, Webkitten includes two reference implementations of the browser interface:

• webkitten-cocoa: A Cocoa WebKit implementation of Webkitten with Lua scripting
• webkitten-gtk: [WIP] A WebKit2 GTK+3 implementation of Webkitten with Lua scripting

Use make run to run the default implementation for your platform, and see the User Guide and the contrib directory for commands to kick start your configuration. Use make install to install the binary into your PATH.

Building your own browser

Using the webkitten toolkit requires implementing the ui module and starting the application with an implementation of ui::ApplicationUI:

// Create runtime configuration
let run_config = RunConfiguration {
  path: path_to_config_toml,
  start_pages: vec!["https://example.com"]
};

// Create engine
let engine = Engine::new(run_config);

// Create UI
let mut ui = MyCustomUI::new(engine);

// Go go go
ui.run();

Then the UI should notify the EventHandler when events occur, such as pressing the Return key in the command bar or web content failing to load. Provided this contract is met, the scripting engine can automate interactions with the UI, making it easy to customize.

While named "webkitten", new UI bindings do not necessarily need to be WebKit-based, though the bindings were designed with WebKit in mind.

Development

Webkitten is largely written in Rust and uses Cargo for dependency management. Questions, suggestions, and patches welcome - see the Contribution Guide for more information.