Expand description
§Light — реактивный графический интерфейс для Rust
Light — библиотека со своим окном (winit + программная отрисовка) и реактивностью в духе Vue 3:
- атрибут
#[proxy]превращает структуру в реактивный класс: свойства читаются и записываются через геттеры/сеттеры, которые уведомляют обозревателя; - атрибут
#[template("...")]компилирует HTML-шаблон с директивами ({{ … }},v-model,@click,v-if,:disabled,<include>) на этапе сборки — шаблон полностью замещает форму компонента; - отрисовка построена на виртуальном дереве: каждое изменение свойства
приводит к пересборке дерева и сравнению с предыдущим
(
vdom::diff), в результате чего обновляются только реально изменившиеся элементы — неизменённые узлы не перерисовываются; - шаблоны могут включать другие шаблоны через
<include src="...">— так главная форма собирается из внутренних страниц и разделов.
§Компоненты
Ядро библиотеки — крейт light-fw-core. Дополнительные
возможности подключаются как отдельные компоненты и фичи:
light-fw-element-form(фичаelements-form) — элементы<checkbox>,<radio>,<select>/<option>;light-fw-behavior-validation(фичаvalidation) —required,:validatorи@validate.
§Пример
use light::prelude::*;
#[template("templates/doc_example.html")]
#[proxy]
struct App {
title: String,
count: i64,
name: String,
show_greeting: bool,
}
impl App {
fn increment(&self) {
self.set_count(self.count() + 1);
}
fn is_zero(&self) -> bool {
self.count() == 0
}
fn reset(&self) {
self.set_count(0);
}
fn toggle_greeting(&self) {
self.set_show_greeting(!self.show_greeting());
}
}
fn main() -> light::Result<()> {
light::run(App::new())
}Шаблон templates/doc_example.html:
<div>
<text>{{ title }}</text>
<button @click="increment" :disabled="is_zero">+1 ({{ count }})</button>
<button @click="reset">Сброс</button>
</div>Re-exports§
pub use serde_json;
Modules§
- a11y
- Доступность интерфейса (Accessibility / a11y).
- collection
- Коллекция значений в духе
Illuminate\Support\Collectionиз Laravel. - component
- Компонент: виртуальное дерево интерфейса, обработка событий и описание системного окна.
- control
- Канал команд управления окном.
- dom
- Глобальный доступ к виртуальному дереву приложения.
- error
- Типы ошибок библиотеки.
- layout
- Раскладка виртуального дерева в прямоугольники, поиск узлов по точке и вычисление областей перерисовки.
- prelude
- Перечень того, что принято подключать в прикладном коде:
use light::prelude::*;. - reactive
- Реактивное ядро Light: свойства, обозреватели, эффекты и подписки.
- render
- Абстракция бэкенда рендеринга.
- runtime
- Шаблоны во время выполнения (фича
runtime-templates). - serde
- Serde
- serde_
json - Serde JSON
- validation
- Валидация форм: стандартная проверка
requiredи пользовательские правила. - vdom
- Виртуальное дерево интерфейса и его сравнение.
- window
- Оконная обвязка поверх
winitи сменного бэкенда рендеринга.
Structs§
- Collection
- Упорядоченная коллекция значений.
- Dom
- Глобальный доступ к виртуальному дереву приложения.
- Edges
- Отступы по четырём сторонам (
padding-*,margin-*). - KeyInfo
- Данные о клавише, связанные с событием
@keydown/@keyup. - Property
- Реактивное свойство (аналог
refв Vue). - Proxy
State - Состояние реактивного класса: имя типа и список свойств.
- Select
Option - Вариант выпадающего списка (
<option>внутри<select>). - Style
- Стиль узла: размеры, выравнивание, отступы, цвета и рамка.
- VElement
- Узел виртуального дерева.
- Watcher
- Подписка (
watch), переживающая доstopили удаления. - Window
Config - Настройки системного окна — из корневого элемента
<window>шаблона.
Enums§
- Align
- Выравнивание узла внутри родителя по оси (
position-x,position-y). - Error
- Ошибка библиотеки Light.
- Event
- Событие, которое бэкенд доставляет узлу по его ключу.
- Focus
Command - Программный запрос клавиатурного фокуса от компонента.
- Mouse
Button - Кнопка мыши, связанная с событием нажатия или отпускания.
- Node
Kind - Тип элемента интерфейса.
- Offset
- Смещение узла относительно его выравнивания
(
position-offset-x,position-offset-y). - Overflow
- Режим переполнения контейнера по оси (
overflow,overflow-x,overflow-y). - Position
- Участие узла в нормальном потоке (
position). - Resize
- Возможность изменения размера текстового поля (
resize). - Size
- Размер узла по одной оси (атрибуты
width/height/left/top). - White
Space - Режим переноса текста (
white-space). - Window
Command - Команда управления окном.
Constants§
- FEATURE_
RUNTIME_ TEMPLATES - Флаг runtime-templates: доступен ли парсинг HTML-шаблонов во время выполнения.
- RUNTIME_
TEMPLATES_ ENABLED - Публичная константа для диагностики: включён ли hot HTML reload.
Traits§
- Component
- UI-компонент: структура, описывающая свойства и интерфейс.
- Proxy
- Реактивный класс (аналог
reactive-объекта в Vue). - Renderer
Backend - Низкоуровневый бэкенд окна.
- VNode
- Общий интерфейс любого элемента дерева: чтение и изменение свойств плюс отправка действий оконному бэкенду.
- VWindow
- Операции над окном — расширение интерфейса узла
VNode.
Functions§
- blur
- Запрашивает снятие клавиатурного фокуса.
- current_
window_ token - Токен «текущего» окна для кросспоточного доступа.
- focus
- Запрашивает клавиатурный фокус на узле с ключом
key. - focused_
key - Ключ узла, находящегося в клавиатурном фокусе в данный момент.
- run
- Открывает окно с интерфейсом компонента и запускает цикл событий.
- run_
with_ config - Запускает приложение по конфигурации из
light.config.json. - set_
current_ window_ token - Запоминает токен «текущего» окна для кросспоточного доступа.
- watch
- Создаёт наблюдателя (аналог
watchEffectв Vue): выполняетfодин раз, запоминает прочитанные свойства и повторяетfпри их изменении.
Type Aliases§
- Result
- Результат операций библиотеки.
- Window
Token - Непрозрачный идентификатор окна, присваиваемый оконным бэкендом.