Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maciejhirsz/kobold
Easy declarative web interfaces.
https://github.com/maciejhirsz/kobold
declarative rust ui wasm wasm-bindgen
Last synced: about 2 months ago
JSON representation
Easy declarative web interfaces.
- Host: GitHub
- URL: https://github.com/maciejhirsz/kobold
- Owner: maciejhirsz
- License: mpl-2.0
- Created: 2019-11-25T12:06:00.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T10:22:23.000Z (5 months ago)
- Last Synced: 2024-07-09T10:39:52.771Z (3 months ago)
- Topics: declarative, rust, ui, wasm, wasm-bindgen
- Language: Rust
- Homepage: https://docs.rs/kobold/
- Size: 905 KB
- Stars: 385
- Watchers: 5
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kobold
[](https://discord.gg/tgNX5VYSWF)
[](https://github.com/maciejhirsz/kobold/actions/workflows/ci.yml)
[](https://docs.rs/kobold)
[](https://crates.io/crates/kobold)
[](https://www.mozilla.org/en-US/MPL/)
_Easy declarative web interfaces._
Key features:
* Declarative [`view!`](https://docs.rs/kobold/latest/kobold/macro.view.html) macro that uses HTML-esque syntax complete with optional closing tags.
* Functional [components](https://docs.rs/kobold/latest/kobold/attr.component.html) with optional parameters.
* State management and event handling.
* High performance and consistently the lowest Wasm footprint in the Rust ecosystem.
### Zero-Cost Static HTML
The `view!` macro produces opaque `impl View` types that by default do no allocations.
All static [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model) elements compile to
inline JavaScript code that constructs them. Expressions are injected into the constructed DOM on first render.
Kobold keeps track of the DOM node references for these expressions.
Since the exact types the expressions evaluate to are known to the Rust compiler, update calls can diff them by
value (or pointer) and surgically update the DOM should they change. Changing a
string or an integer only updates the exact [`Text` node](https://developer.mozilla.org/en-US/docs/Web/API/Text)
that string or integer was rendered to.
_If the `view!` macro invocation contains DOM elements with no expressions, the constructed `View`
type will be zero-sized, and its `View::update` method will be empty, making updates of static
DOM literally zero-cost._
### Hello World!
Components in **Kobold** are created by annotating a _render function_ with a `#[component]` attribute.
```rust
use kobold::prelude::*;
#[component]
fn hello(name: &str) -> impl View + '_ {
view! {
"Hello "{ name }"!"
}
}
fn main() {
kobold::start(view! {
});
}
```
The component function must return a type that implements the `View` trait. Since the `view!` macro
produces transient locally defined types the best approach here is to always use the opaque `impl View` return type.
Everything here is statically typed and the macro doesn't delete any information when manipulating the
token stream, so the Rust compiler can tell you when you've made a mistake:
```text
error[E0560]: struct `Hello` has no field named `nam`
--> examples/hello_world/src/main.rs:12:16
|
12 |
| ^^^ help: there is a method with a similar name: `name`
```
You can even use [rust-analyzer](https://rust-analyzer.github.io/) to refactor component or field names,
and it will change the invocations inside the macros for you.
### State management
The `stateful` function can be used to create views that own and manipulate
their state:
```rust
use kobold::prelude::*;
#[component]
fn counter(init: u32) -> impl View {
stateful(init, |count| {
bind! { count:
// Create an event handler with access to `&mut u32`
let onclick = move |_event| *count += 1;
}
view! {
"You clicked the "
// `{onclick}` here is shorthand for `onclick={onclick}`
"Button"
" "{ count }" times."
}
})
}
fn main() {
kobold::start(view! {
});
}
```
The `stateful` function takes two parameters:
* State constructor that implements the `IntoState` trait. **Kobold** comes with default
implementations for most primitive types, so we can use `u32` here.
* The anonymous render closure that uses the constructed state, in our case its argument is `&Hook`.
The `Hook` here is a smart pointer to the state itself that allows non-mutable access to the
state. The `bind!` macro can be invoked for any `Hook` to create closures with `&mut` references to the
underlying state.
For more details visit the [`stateful` module documentation](https://docs.rs/kobold/latest/kobold/stateful/index.html).
### Optional parameters
Use `#[component(?)]` syntax to set a component parameter as default:
```rust
// `code` will default to `200` if omitted
#[component(code?: 200)]
fn status(code: u32) -> impl View {
view! {
"Status code was "{ code }
}
}
view! {
// Status code was 200
// Status code was 404
}
```
For more details visit the [`#[component]` macro documentation](https://docs.rs/kobold/latest/kobold/attr.component.html#optional-parameters-componentparam).
### Conditional Rendering
Because the `view!` macro produces unique transient types, `if` and `match` expressions that invoke
the macro will naturally fail to compile.
Using the `auto_branch` flag on the `#[component]` attribute
**Kobold** will scan the body of of your component render function, and make all `view!` macro invocations
inside an `if` or `match` expression, and wrap them in an enum making them the same type:
```rust
#[component(auto_branch)]
fn conditional(illuminatus: bool) -> impl View {
if illuminatus {
view! {
"It was the year when they finally immanentized the Eschaton." }
} else {
view! {
"It was love at first sight." }
}
}
```
For more details visit the [`branching` module documentation](https://docs.rs/kobold/latest/kobold/branching/index.html).
### Lists and Iterators
To render an iterator use the `for` keyword:
```rust
use kobold::prelude::*;
#[component]
fn iterate_numbers(count: u32) -> impl View {
view! {
{
for (1..=count).map(|n| view! { - "Item #"{n} })
}
}
}
```
On updates the iterator is consumed once and all items are diffed with the previous version.
No allocations are made by **Kobold** when updating such a list, unless the rendered list needs
to grow past its original capacity.
For more information about keywords visit the [`keywords` module documentation](https://docs.rs/kobold/latest/kobold/keywords/index.html).
### Borrowed Values
`View` types are truly transient and only need to live for the duration of the initial render,
or for the duration of the subsequent update. This means that you can easily and cheaply render borrowed
state without unnecessary clones:
```rust
#[component]
fn users<'a>(names: &'a [&'a str]) -> impl View + 'a {
view! {
{
for names.iter().map(|name| view! { - { name } })
}
}
}
```
### Components with Children
If you wish to capture children from parent `view!` invocation, simply change
`#[component]` to `#[component(children)]`:
```rust
use kobold::prelude::*;
#[component(children)]
fn header(children: impl View) -> impl View {
view! {
{ children }
}
}
fn main() {
kobold::start(view! {
"Hello Kobold"!header>
});
}
```
You can change the name of the parameter used and even set it to a concrete:
```rust
use kobold::prelude::*;
// Capture children into the argument `n`
#[component(children: n)]
fn add_ten(n: i32) -> i32 {
// integers implement `View` so they can be passed by value
n + 10
}
fn main() {
kobold::start(view! {
"Meaning of life is "
{ 32 }!add_ten>
});
}
```
## More Examples
To run **Kobold** you'll need to install [`trunk`](https://trunkrs.dev/):
```sh
cargo install --locked trunk
```
You might also need to add the Wasm target to Rust:
```sh
rustup target add wasm32-unknown-unknown
```
Then just run an example:
```sh
## Go to an example
cd examples/todomvc
## Run with trunk
trunk serve
```
## Acknowledgements
+ [Pedrors](https://pedrors.pt/) for the **Kobold** logo.
## License
Kobold is free software, and is released under the terms of the [Mozilla Public License](https://www.mozilla.org/en-US/MPL/) version 2.0. See [LICENSE](LICENSE).