rsiot/components/cmp_leptos/mod.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
#![allow(rustdoc::bare_urls)]
//! Компонент для интеграции веб-приложения на основе фреймворка Leptos
//!
//! # Подготовка среды разработки
//!
//! ## Таргеты
//!
//! - [wasm32-unknown-unknown](`crate::doc::dev_prepare::wasm32_unknown_unknown`)
//! - [aarch64-linux-android](`crate::doc::dev_prepare::aarch64_linux_android`) (Tauri / Android)
//! - [armv7-linux-androideabi](`crate::doc::dev_prepare::armv7_linux_androideabi`) (Tauri / Android)
//! - [i686-linux-android](`crate::doc::dev_prepare::i686_linux_android`) (Tauri / Android)
//! - [x86_64-linux-android](`crate::doc::dev_prepare::x8664_linux_android`) (Tauri / Android)
//!
//! ## Tauri
//!
//! Если требуется разработка приложения Tauri (https://beta.tauri.app/guides/prerequisites/).
//!
//! ```bash
//! (sudo apt install libwebkit2gtk-4.1-dev
//! build-essential
//! curl
//! wget
//! file
//! libssl-dev
//! libayatana-appindicator3-dev
//! librsvg2-dev)
//! ```
//!
//! ### Tauri CLI
//!
//! ```bash
//! cargo install tauri-cli --version "^2.0.0-beta"
//! ```
//!
//! ### Create tauri apps
//!
//! ```bash
//! cargo install create-tauri-app
//! ```
//!
//! ### Android Studio
//!
//! ```bash
//! sudo snap install android-studio --classic
//! ```
//! Запустить Android Studio, поставить пакеты по-умолчанию. Открыть SDK Manager и установить NDK (Side by side) и Android SDK CLI.
//!
//! ### Env variables
//!
//! `~/.config/nushell/config.nu`:
//!
//! ```toml
//! $env.JAVA_HOME = "/snap/android-studio/current/jbr"
//! $env.ANDROID_HOME = "/home/konstantin/Android/Sdk"
//! $env.NDK_HOME = $"($env.ANDROID_HOME)/ndk/26.2.11394342"
//! ```
//!
//! Проверить пути
//!
//! ## Rustiwind
//!
//! Для сортировки классов Tailwind можно поставить утилиту:
//!
//! ```bash
//! cargo install rustywind
//! ```
//!
//! Вызов:
//!
//! ```bash
//! rustywind --write src/
//! ```
//!
//! ## Leptosfmt
//!
//! Установка
//!
//! ```bash
//! cargo install leptosfmt
//! ```
//!
//! # Создание проекта
//!
//! ## `.zed/settings.json`
//!
//! ```json
//! {
//! "lsp": {
//! "rust-analyzer": {
//! "initialization_options": {
//! "check": {
//! "command": "clippy"
//! },
//! "cargo": {
//! "target": "wasm32-unknown-unknown"
//! }
//! }
//! }
//! }
//! }
//! ```
//!
//! ## Tauri
//!
//! ```bash
//! cargo create-tauri-app --rc
//!
//! # добавить поддержку Android
//! cargo tauri android init
//! ```
//!
//! ## Tailwind
//!
//! Установить:
//!
//! ```bash
//! npm install -D tailwindcss
//! npm install -D @tailwindcss/forms
//! npx tailwindcss init
//! ```
//!
//! Создать файл `tailwind.config.js`:
//!
//! ```json
//! /** @type {import('tailwindcss').Config} */
//!
//! module.exports = {
//! content: {
//! files: [
//! "*.html",
//! "./src/**/*.rs",
//! "../../rsiot/src/components/cmp_leptos/components/**/*.rs"
//! ],
//! },
//! plugins: [require('@tailwindcss/forms'),],
//! }
//! ```
//!
//! Создать файл `input.css` в корне проекта:
//!
//! ```css
//! @tailwind base;
//! @tailwind components;
//! @tailwind utilities;
//! ```
//!
//! Добавить в `index.html`:
//!
//! ```html
//! <html>
//! <head>
//! <!-- Подключаем стили Tailwind -->
//! <link data-trunk rel="tailwind-css" href="input.css" />
//! <meta name="viewport" content="width=device-width, initial-scale=1.0" />
//! </head>
//! </html>
//! ```
//!
//! ## Material Theme
//!
//! Создаем тему в [Material Theme Builder](https://material-foundation.github.io/material-theme-builder/).
//!
//! Скачиваем набор файлов css, распаковываем в папку `material-theme`. В начале файла `input.css` прописываем:
//!
//! ```css
//! /* Material theme */
//! @import "./material-theme/dark.css";
//! @import "./material-theme/dark-hc.css";
//! @import "./material-theme/dark-mc.css";
//! @import "./material-theme/light.css";
//! @import "./material-theme/light-hc.css";
//! @import "./material-theme/light-mc.css";
//! ```
//!
//! Прописать секцию `theme` в `tailwind.config.json`:
//!
//! ```json
#![doc = include_str!("./doc/tailwind.config.json")]
//! ```
//! Для выбора темы применяем класс к элементу `html.body`:
//!
//! ```html
//! <body class="dark"></body>
//! ```
//!
//! Допустимые классы:
//!
//! - dark-high-contrast
//! - dark-medium-contrast
//! - dark
//! - light-high-contrast
//! - light-medium-contrast
//! - light
//!
//!
//! Добавить в файл `input.css`:
//!
//! ```css
//! :root {
//! --md-ref-typeface-brand: "Roboto";
//! --md-ref-typeface-plain: system-ui;
//! }
//! ```
//!
//! Material theme builder почему-то не экспортирует настройки шрифтов. Когда пофиксят - пересмотреть.
//!
//! ## Iconify
//!
//! ```bash
//! npm i -D @iconify/tailwind
//! npm i -D @iconify/json
//! ```
//!
//! Добавить в файл `tailwind.config.js`:
//!
//! ```json
//! const { addIconSelectors } = require("@iconify/tailwind");
//!
//! module.exports = {
//! plugins: [addIconSelectors(["mdi", "material-symbols"])],
//! }
//! ```
//!
//! Добавить в параметры `addIconSelectors` семейства иконок.
//!
//! Далее в проекте иконки можно вставлять:
//!
//! ```html
//! <span class="iconify material-symbols--menu-rounded h-5 w-5"></span>
//! ```
#![warn(rustdoc::bare_urls)]
mod component;
pub mod components;
pub mod create_signal_from_msg;
mod error;
mod global_state;
pub mod utils;
pub use component::{Cmp, Config, StoreBound};
pub use error::Error;
pub use global_state::GlobalState;
pub use rsiot_macros::create_signal_from_msg;
type Result = std::result::Result<(), Error>;