✨ Añade gestión de regiones en temas
This commit is contained in:
parent
126fe3a8ea
commit
0748261692
5 changed files with 137 additions and 1 deletions
|
@ -1,6 +1,24 @@
|
|||
//! API para añadir y gestionar nuevos temas.
|
||||
//!
|
||||
//! En `PageTop` un tema es la *piel* de la aplicación, decide cómo se muestra cada documento HTML,
|
||||
//! especialmente las páginas de contenido ([`Page`](crate::response::page::Page)), sin alterar la
|
||||
//! lógica interna de sus componentes.
|
||||
//!
|
||||
//! Un tema **declara las regiones** (*cabecera*, *barra lateral*, *pie*, etc.) que estarán
|
||||
//! disponibles para colocar contenido. Los temas son responsables últimos de los estilos,
|
||||
//! tipografías, espaciados y cualquier otro detalle visual o de comportamiento (como animaciones,
|
||||
//! *scripts* de interfaz, etc.).
|
||||
//!
|
||||
//! Es una extensión más (implementando [`ExtensionTrait`](crate::core::extension::ExtensionTrait)).
|
||||
//! Se instala, activa y declara dependencias igual que el resto de extensiones; y se señala a sí
|
||||
//! misma como tema (implementando [`theme()`](crate::core::extension::ExtensionTrait::theme)
|
||||
//! y [`ThemeTrait`]).
|
||||
|
||||
mod definition;
|
||||
pub use definition::{ThemeRef, ThemeTrait};
|
||||
|
||||
mod regions;
|
||||
pub(crate) use regions::ChildrenInRegions;
|
||||
pub use regions::InRegion;
|
||||
|
||||
pub(crate) mod all;
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
use crate::core::extension::ExtensionTrait;
|
||||
use crate::locale::L10n;
|
||||
|
||||
/// Representa una referencia a un tema.
|
||||
///
|
||||
|
@ -27,4 +28,8 @@ pub type ThemeRef = &'static dyn ThemeTrait;
|
|||
///
|
||||
/// impl ThemeTrait for MyTheme {}
|
||||
/// ```
|
||||
pub trait ThemeTrait: ExtensionTrait + Send + Sync {}
|
||||
pub trait ThemeTrait: ExtensionTrait + Send + Sync {
|
||||
fn regions(&self) -> Vec<(&'static str, L10n)> {
|
||||
vec![("content", L10n::l("content"))]
|
||||
}
|
||||
}
|
||||
|
|
111
src/core/theme/regions.rs
Normal file
111
src/core/theme/regions.rs
Normal file
|
@ -0,0 +1,111 @@
|
|||
use crate::core::component::{Child, ChildOp, Children};
|
||||
use crate::core::theme::ThemeRef;
|
||||
use crate::{builder_fn, AutoDefault, UniqueId};
|
||||
|
||||
use parking_lot::RwLock;
|
||||
|
||||
use std::collections::HashMap;
|
||||
use std::sync::LazyLock;
|
||||
|
||||
static THEME_REGIONS: LazyLock<RwLock<HashMap<UniqueId, ChildrenInRegions>>> =
|
||||
LazyLock::new(|| RwLock::new(HashMap::new()));
|
||||
|
||||
static COMMON_REGIONS: LazyLock<RwLock<ChildrenInRegions>> =
|
||||
LazyLock::new(|| RwLock::new(ChildrenInRegions::default()));
|
||||
|
||||
// Estructura interna para mantener los componentes de cada región dada.
|
||||
#[derive(AutoDefault)]
|
||||
pub struct ChildrenInRegions(HashMap<&'static str, Children>);
|
||||
|
||||
impl ChildrenInRegions {
|
||||
pub fn new() -> Self {
|
||||
ChildrenInRegions::default()
|
||||
}
|
||||
|
||||
pub fn with(region_id: &'static str, child: Child) -> Self {
|
||||
ChildrenInRegions::default().with_in_region(region_id, ChildOp::Add(child))
|
||||
}
|
||||
|
||||
#[builder_fn]
|
||||
pub fn with_in_region(mut self, region_id: &'static str, op: ChildOp) -> Self {
|
||||
if let Some(region) = self.0.get_mut(region_id) {
|
||||
region.alter_child(op);
|
||||
} else {
|
||||
self.0.insert(region_id, Children::new().with_child(op));
|
||||
}
|
||||
self
|
||||
}
|
||||
|
||||
pub fn all_in_region(&self, theme: ThemeRef, region_id: &str) -> Children {
|
||||
let common = COMMON_REGIONS.read();
|
||||
if let Some(r) = THEME_REGIONS.read().get(&theme.type_id()) {
|
||||
Children::merge(&[
|
||||
common.0.get(region_id),
|
||||
self.0.get(region_id),
|
||||
r.0.get(region_id),
|
||||
])
|
||||
} else {
|
||||
Children::merge(&[common.0.get(region_id), self.0.get(region_id)])
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Permite añadir componentes a regiones globales o regiones de temas concretos.
|
||||
///
|
||||
/// Dada una región, según la variante seleccionada, se le podrán añadir ([`add()`](Self::add))
|
||||
/// componentes que se mantendrán durante la ejecución de la aplicación.
|
||||
///
|
||||
/// Estas estructuras de componentes se renderizarán automáticamente al procesar los documentos HTML
|
||||
/// que las usan, como las páginas de contenido ([`Page`](crate::response::page::Page)), por
|
||||
/// ejemplo.
|
||||
pub enum InRegion {
|
||||
/// Representa la región por defecto en la que se pueden añadir componentes.
|
||||
Content,
|
||||
/// Representa la región con el nombre del argumento.
|
||||
Named(&'static str),
|
||||
/// Representa la región con el nombre y del tema especificado en los argumentos.
|
||||
OfTheme(&'static str, ThemeRef),
|
||||
}
|
||||
|
||||
impl InRegion {
|
||||
/// Permite añadir un componente en la región de la variante seleccionada.
|
||||
///
|
||||
/// # Ejemplo
|
||||
///
|
||||
/// ```rust
|
||||
/// use pagetop::prelude::*;
|
||||
///
|
||||
/// // Banner global, en la región por defecto de cualquier página.
|
||||
/// InRegion::Content.add(Child::with(Html::with(
|
||||
/// html! { ("🎉 ¡Bienvenido!") }
|
||||
/// )));
|
||||
///
|
||||
/// // Texto en la región "sidebar".
|
||||
/// InRegion::Named("sidebar").add(Child::with(Html::with(
|
||||
/// html! { ("Publicidad") }
|
||||
/// )));
|
||||
/// ```
|
||||
pub fn add(&self, child: Child) -> &Self {
|
||||
match self {
|
||||
InRegion::Content => {
|
||||
COMMON_REGIONS
|
||||
.write()
|
||||
.alter_in_region("region-content", ChildOp::Add(child));
|
||||
}
|
||||
InRegion::Named(name) => {
|
||||
COMMON_REGIONS
|
||||
.write()
|
||||
.alter_in_region(name, ChildOp::Add(child));
|
||||
}
|
||||
InRegion::OfTheme(region, theme) => {
|
||||
let mut regions = THEME_REGIONS.write();
|
||||
if let Some(r) = regions.get_mut(&theme.type_id()) {
|
||||
r.alter_in_region(region, ChildOp::Add(child));
|
||||
} else {
|
||||
regions.insert(theme.type_id(), ChildrenInRegions::with(region, child));
|
||||
}
|
||||
}
|
||||
}
|
||||
self
|
||||
}
|
||||
}
|
1
src/locale/en-US/theme.ftl
Normal file
1
src/locale/en-US/theme.ftl
Normal file
|
@ -0,0 +1 @@
|
|||
content = Content
|
1
src/locale/es-ES/theme.ftl
Normal file
1
src/locale/es-ES/theme.ftl
Normal file
|
@ -0,0 +1 @@
|
|||
content = Contenido
|
Loading…
Add table
Add a link
Reference in a new issue