🚚 Renombra ThemeRegion por DefaultRegions

This commit is contained in:
Manuel Cillero 2025-11-17 22:51:34 +01:00
parent dea994e8ca
commit d4be1362fc
7 changed files with 43 additions and 39 deletions

View file

@ -1,4 +1,4 @@
//! Temas básicos soportados por PageTop.
mod basic;
pub use basic::{Basic, BasicRegion};
pub use basic::{Basic, BasicRegions};

View file

@ -1,8 +1,8 @@
/// Es el tema básico que incluye PageTop por defecto.
use crate::prelude::*;
/// El tema básico usa las mismas regiones predefinidas por [`ThemeRegion`].
pub type BasicRegion = ThemeRegion;
/// El tema básico usa las mismas regiones predefinidas por [`DefaultRegions`].
pub type BasicRegions = DefaultRegions;
/// Tema básico por defecto que extiende el funcionamiento predeterminado de [`Theme`].
pub struct Basic;

View file

@ -9,13 +9,14 @@
//! tipografías, espaciados y cualquier otro detalle visual o de comportamiento (comoanimaciones,
//! scripts de interfaz, etc.).
//!
//! Los temas son extensiones que implementan [`Extension`](crate::core::extension::Extension); por
//! lo que se instancian, declaran sus dependencias y se inician igual que el resto de extensiones;
//! pero serán temas si además implementan [`theme()`](crate::core::extension::Extension::theme) y
//! [`Theme`].
//! Los temas son extensiones que implementan [`Extension`](crate::core::extension::Extension), por
//! lo que se instancian, declaran dependencias y se inician igual que cualquier otra extensión.
//! También deben implementar [`Theme`] y sobrescribir el método
//! [`Extension::theme()`](crate::core::extension::Extension::theme) para que PageTop pueda
//! registrarlos como temas
mod definition;
pub use definition::{Theme, ThemePage, ThemeRef, ThemeRegion};
pub use definition::{Theme, ThemePage, ThemeRef, DefaultRegions};
mod regions;
pub(crate) use regions::{ChildrenInRegions, REGION_CONTENT};

View file

@ -4,7 +4,7 @@ use crate::core::theme::{Region, RegionRef, REGION_CONTENT};
use crate::html::{html, Markup, StyleSheet};
use crate::locale::L10n;
use crate::response::page::Page;
use crate::{global, join};
use crate::{global, join, AutoDefault};
use std::sync::LazyLock;
@ -14,16 +14,17 @@ use std::sync::LazyLock;
/// implementen [`Theme`] y, a su vez, [`Extension`].
pub type ThemeRef = &'static dyn Theme;
/// Conjunto de regiones que los temas pueden exponer para el renderizado.
/// Conjunto de regiones predefinidas que los temas pueden exponer para el renderizado.
///
/// `ThemeRegion` define un conjunto de regiones predefinidas para estructurar un documento HTML.
/// `DefaultRegions` define un conjunto de regiones predefinidas para estructurar un documento HTML.
/// Proporciona **identificadores estables** (vía [`Region::key()`]) y **etiquetas localizables**
/// (vía [`Region::label()`]) a las regiones donde se añadirán los componentes.
///
/// Se usa por defecto en [`Theme::page_regions()`](crate::core::theme::Theme::page_regions) y sus
/// variantes representan el conjunto mínimo recomendado para cualquier tema. Sin embargo, cada tema
/// podría exponer su propio conjunto de regiones.
pub enum ThemeRegion {
#[derive(AutoDefault)]
pub enum DefaultRegions {
/// Cabecera de la página.
///
/// Clave: `"header"`. Suele contener *branding*, navegación principal o avisos globales.
@ -32,6 +33,7 @@ pub enum ThemeRegion {
/// Contenido principal de la página (**obligatoria**).
///
/// Clave: `"content"`. Es el destino por defecto para insertar componentes a nivel de página.
#[default]
Content,
/// Pie de página.
@ -40,12 +42,12 @@ pub enum ThemeRegion {
Footer,
}
impl Region for ThemeRegion {
impl Region for DefaultRegions {
fn key(&self) -> &str {
match self {
ThemeRegion::Header => "header",
ThemeRegion::Content => REGION_CONTENT,
ThemeRegion::Footer => "footer",
Self::Header => "header",
Self::Content => REGION_CONTENT,
Self::Footer => "footer",
}
}
@ -60,16 +62,17 @@ impl Region for ThemeRegion {
/// implementa automáticamente para cualquier tipo que implemente [`Theme`], por lo que normalmente
/// no requiere implementación explícita.
///
/// Si un tema **sobrescribe** uno o más de estos métodos de [`Theme`]:
/// Si un tema **sobrescribe** uno o más de los siguientes métodos de [`Theme`]:
///
/// - [`render_page_region()`](Theme::render_page_region),
/// - [`render_page_head()`](Theme::render_page_head), o
/// - [`render_page_body()`](Theme::render_page_body);
///
/// es posible volver al comportamiento por defecto usando FQS (*Fully Qualified Syntax*):
/// puede volver al comportamiento por defecto con una llamada FQS (*Fully Qualified Syntax*) a:
///
/// - `<Self as ThemePage>::render_body(self, page, self.page_regions())`
/// - `<Self as ThemePage>::render_head(self, page)`
/// - `<Self as ThemePage>::render_region(self, page, region)`,
/// - `<Self as ThemePage>::render_body(self, page, self.page_regions())`, o
/// - `<Self as ThemePage>::render_head(self, page)`.
pub trait ThemePage {
/// Renderiza el **contenedor** de una región concreta del `<body>` de la página.
///
@ -206,9 +209,9 @@ pub trait Theme: Extension + ThemePage + Send + Sync {
/// fn page_regions(&self) -> &'static [RegionRef] {
/// static REGIONS: LazyLock<[RegionRef; 4]> = LazyLock::new(|| {
/// [
/// &ThemeRegion::Header,
/// &ThemeRegion::Content,
/// &ThemeRegion::Footer,
/// &DefaultRegions::Header,
/// &DefaultRegions::Content,
/// &DefaultRegions::Footer,
/// ]
/// });
/// &*REGIONS
@ -217,9 +220,9 @@ pub trait Theme: Extension + ThemePage + Send + Sync {
fn page_regions(&self) -> &'static [RegionRef] {
static REGIONS: LazyLock<[RegionRef; 3]> = LazyLock::new(|| {
[
&ThemeRegion::Header,
&ThemeRegion::Content,
&ThemeRegion::Footer,
&DefaultRegions::Header,
&DefaultRegions::Content,
&DefaultRegions::Footer,
]
});
&*REGIONS

View file

@ -31,25 +31,25 @@ pub const REGION_CONTENT: &str = "content";
/// `aria-label` o en descripciones semánticas del contenedor).
///
/// Las implementaciones típicas son *enumeraciones estáticas* declaradas por cada tema (ver como
/// ejemplo [`ThemeRegion`](crate::core::theme::ThemeRegion)), de modo que las claves y etiquetas
/// permanecen inmutables y fácilmente referenciables.
/// ejemplo [`DefaultRegions`](crate::core::theme::DefaultRegions)), de modo que las claves y
/// etiquetas permanecen inmutables y fácilmente referenciables.
///
/// # Ejemplo
///
/// ```rust
/// # use pagetop::prelude::*;
/// pub enum MyThemeRegion {
/// pub enum MyThemeRegions {
/// Header,
/// Content,
/// Footer,
/// }
///
/// impl Region for MyThemeRegion {
/// impl Region for MyThemeRegions {
/// fn key(&self) -> &str {
/// match self {
/// MyThemeRegion::Header => "header",
/// MyThemeRegion::Content => "content",
/// MyThemeRegion::Footer => "footer",
/// Self::Header => "header",
/// Self::Content => "content",
/// Self::Footer => "footer",
/// }
/// }
///
@ -111,7 +111,7 @@ impl ChildrenInRegions {
}
}
/// Punto de acceso para añadir componentes a regiones globales o específicas de un tema.
/// Permite añadir componentes a regiones globales o específicas de un tema.
///
/// Según la variante, se pueden añadir componentes ([`add()`](Self::add)) que permanecerán
/// disponibles durante toda la ejecución.