🚧 [welcome] Crea página de bienvenida desde intro
- Implementa un nuevo *layout* en el tema `Basic` para crear una plantilla de páginas de introducción. - Añade nuevo fichero CSS `intro.css` para los estilos globales de la página de introducción. - Incorpora nuevos recursos gráficos para la cabecera de la página de introducción en varios formatos (AVIF, WebP, JPEG). - Revisa los ficheros de localización.
This commit is contained in:
parent
fe3bbcb131
commit
8274519405
17 changed files with 420 additions and 258 deletions
|
|
@ -29,14 +29,14 @@ pub trait Component: AnyInfo + ComponentRender + Send + Sync {
|
|||
TypeInfo::ShortName.of::<Self>()
|
||||
}
|
||||
|
||||
/// Devuelve una descripción opcional del componente.
|
||||
/// Devuelve una descripción del componente, si existe.
|
||||
///
|
||||
/// Por defecto, no se proporciona ninguna descripción (`None`).
|
||||
fn description(&self) -> Option<String> {
|
||||
None
|
||||
}
|
||||
|
||||
/// Devuelve un identificador opcional para el componente.
|
||||
/// Devuelve el identificador del componente, si existe.
|
||||
///
|
||||
/// Este identificador puede usarse para referenciar el componente en el HTML. Por defecto, no
|
||||
/// tiene ningún identificador (`None`).
|
||||
|
|
@ -51,7 +51,7 @@ pub trait Component: AnyInfo + ComponentRender + Send + Sync {
|
|||
#[allow(unused_variables)]
|
||||
fn setup_before_prepare(&mut self, cx: &mut Context) {}
|
||||
|
||||
/// Devuelve una representación estructurada del componente preparada para el renderizado.
|
||||
/// Devuelve una representación renderizada del componente.
|
||||
///
|
||||
/// Este método forma parte del ciclo de vida de los componentes y se invoca automáticamente
|
||||
/// durante el proceso de construcción del documento. Puede sobrescribirse para generar
|
||||
|
|
|
|||
|
|
@ -15,10 +15,10 @@
|
|||
//! [`Theme`].
|
||||
|
||||
mod definition;
|
||||
pub use definition::{Theme, ThemeRef};
|
||||
pub use definition::{Theme, ThemePage, ThemeRef};
|
||||
|
||||
mod regions;
|
||||
pub(crate) use regions::ChildrenInRegions;
|
||||
pub use regions::{InRegion, Region, REGION_CONTENT};
|
||||
pub(crate) use regions::{ChildrenInRegions, REGION_CONTENT};
|
||||
pub use regions::{InRegion, Region};
|
||||
|
||||
pub(crate) mod all;
|
||||
|
|
|
|||
|
|
@ -7,88 +7,34 @@ use crate::response::page::Page;
|
|||
|
||||
use std::sync::LazyLock;
|
||||
|
||||
/// Representa una referencia a un tema.
|
||||
/// Referencia estática a un tema.
|
||||
///
|
||||
/// Los temas son también extensiones. Por tanto se deben definir igual, es decir, como instancias
|
||||
/// estáticas globales que implementan [`Theme`], pero también [`Extension`].
|
||||
/// Los temas son también extensiones. Por tanto, deben declararse como **instancias estáticas** que
|
||||
/// implementen [`Theme`] y, a su vez, [`Extension`].
|
||||
pub type ThemeRef = &'static dyn Theme;
|
||||
|
||||
/// Interfaz común que debe implementar cualquier tema de `PageTop`.
|
||||
/// Métodos predefinidos de renderizado para las páginas de un tema.
|
||||
///
|
||||
/// Un tema implementará [`Theme`] y los métodos que sean necesarios de [`Extension`], aunque el
|
||||
/// único obligatorio será [`theme()`](Extension::theme).
|
||||
/// Contiene las implementaciones base de las **secciones** `<head>` y `<body>`. Se implementa
|
||||
/// automáticamente para cualquier tipo que implemente [`Theme`], por lo que normalmente no requiere
|
||||
/// implementación explícita.
|
||||
///
|
||||
/// ```rust
|
||||
/// use pagetop::prelude::*;
|
||||
/// Si un tema **sobrescribe** [`render_page_head()`](Theme::render_page_head) o
|
||||
/// [`render_page_body()`](Theme::render_page_body), se puede volver al comportamiento por defecto
|
||||
/// cuando se necesite usando FQS (*Fully Qualified Syntax*):
|
||||
///
|
||||
/// pub struct MyTheme;
|
||||
///
|
||||
/// impl Extension for MyTheme {
|
||||
/// fn name(&self) -> L10n {
|
||||
/// L10n::n("My theme")
|
||||
/// }
|
||||
///
|
||||
/// fn description(&self) -> L10n {
|
||||
/// L10n::n("A personal theme")
|
||||
/// }
|
||||
///
|
||||
/// fn theme(&self) -> Option<ThemeRef> {
|
||||
/// Some(&Self)
|
||||
/// }
|
||||
/// }
|
||||
///
|
||||
/// impl Theme for MyTheme {}
|
||||
/// ```
|
||||
pub trait Theme: Extension + Send + Sync {
|
||||
/// **Obsoleto desde la versión 0.4.0**: usar [`declared_regions()`](Self::declared_regions) en
|
||||
/// su lugar.
|
||||
#[deprecated(since = "0.4.0", note = "Use `declared_regions()` instead")]
|
||||
fn regions(&self) -> Vec<(&'static str, L10n)> {
|
||||
vec![("content", L10n::l("content"))]
|
||||
}
|
||||
|
||||
/// Declaración ordenada de las regiones disponibles en la página.
|
||||
///
|
||||
/// Devuelve una lista estática de pares `(Region, L10n)` que se usará para renderizar en el
|
||||
/// orden indicado todas las regiones que componen una página. Los identificadores deben ser
|
||||
/// **estables** como `"sidebar-left"` o `"content"`. La etiqueta `L10n` devuelve el nombre de la
|
||||
/// región en el idioma activo de la página.
|
||||
///
|
||||
/// Si el tema requiere un conjunto distinto de regiones, se puede sobrescribir este método para
|
||||
/// devolver una lista diferente. Si no, se usará la lista predeterminada:
|
||||
///
|
||||
/// - `"header"`: cabecera.
|
||||
/// - `"content"`: contenido principal (**obligatoria**).
|
||||
/// - `"footer"`: pie.
|
||||
///
|
||||
/// Sólo la región `"content"` es obligatoria, usa [`Region::default()`] para declararla.
|
||||
#[inline]
|
||||
fn declared_regions(&self) -> &'static [(Region, L10n)] {
|
||||
static REGIONS: LazyLock<[(Region, L10n); 3]> = LazyLock::new(|| {
|
||||
[
|
||||
(Region::declare("header"), L10n::l("region_header")),
|
||||
(Region::default(), L10n::l("region_content")),
|
||||
(Region::declare("footer"), L10n::l("region_footer")),
|
||||
]
|
||||
});
|
||||
®IONS[..]
|
||||
}
|
||||
|
||||
/// Acciones específicas del tema antes de renderizar el `<body>` de la página.
|
||||
///
|
||||
/// Útil para preparar clases, inyectar recursos o ajustar metadatos.
|
||||
#[allow(unused_variables)]
|
||||
fn before_render_page_body(&self, page: &mut Page) {}
|
||||
|
||||
/// - `<Self as ThemePage>::render_body(self, page, self.page_regions())`
|
||||
/// - `<Self as ThemePage>::render_head(self, page)`
|
||||
pub trait ThemePage {
|
||||
/// Renderiza el contenido del `<body>` de la página.
|
||||
///
|
||||
/// Por defecto, recorre [`declared_regions()`](Self::declared_regions) **en el orden que se han
|
||||
/// declarado** y, para cada región con contenido, genera un contenedor con `role="region"` y
|
||||
/// `aria-label` localizado.
|
||||
fn render_page_body(&self, page: &mut Page) -> Markup {
|
||||
/// Recorre `regions` en el **orden declarado** y, para cada región con contenido, genera un
|
||||
/// contenedor con `role="region"` y un `aria-label` localizado. Se asume que cada identificador
|
||||
/// de región es **único** dentro de la página.
|
||||
fn render_body(&self, page: &mut Page, regions: &[(Region, L10n)]) -> Markup {
|
||||
html! {
|
||||
body id=[page.body_id().get()] class=[page.body_classes().get()] {
|
||||
@for (region, region_label) in self.declared_regions() {
|
||||
@for (region, region_label) in regions {
|
||||
@let output = page.render_region(region.key());
|
||||
@if !output.is_empty() {
|
||||
@let region_name = region.name();
|
||||
|
|
@ -96,7 +42,7 @@ pub trait Theme: Extension + Send + Sync {
|
|||
id=(region_name)
|
||||
class={ "region region--" (region_name) }
|
||||
role="region"
|
||||
aria-label=[region_label.using(page)]
|
||||
aria-label=[region_label.lookup(page)]
|
||||
{
|
||||
(output)
|
||||
}
|
||||
|
|
@ -106,17 +52,12 @@ pub trait Theme: Extension + Send + Sync {
|
|||
}
|
||||
}
|
||||
|
||||
/// Acciones específicas del tema después de renderizar el `<body>` de la página.
|
||||
///
|
||||
/// Útil para *tracing*, métricas o ajustes finales del estado de la página.
|
||||
#[allow(unused_variables)]
|
||||
fn after_render_page_body(&self, page: &mut Page) {}
|
||||
|
||||
/// Renderiza el contenido del `<head>` de la página.
|
||||
///
|
||||
/// Por defecto, genera las etiquetas básicas (`charset`, `title`, `description`, `viewport`,
|
||||
/// `X-UA-Compatible`), los metadatos y propiedades de la página y los recursos (CSS/JS).
|
||||
fn render_page_head(&self, page: &mut Page) -> Markup {
|
||||
/// Por defecto incluye las etiquetas básicas (`charset`, `title`, `description`, `viewport`,
|
||||
/// `X-UA-Compatible`), los metadatos (`name/content`) y propiedades (`property/content`),
|
||||
/// además de los recursos CSS/JS de la página.
|
||||
fn render_head(&self, page: &mut Page) -> Markup {
|
||||
let viewport = "width=device-width, initial-scale=1, shrink-to-fit=no";
|
||||
html! {
|
||||
head {
|
||||
|
|
@ -146,18 +87,115 @@ pub trait Theme: Extension + Send + Sync {
|
|||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Página de error "*403 – Forbidden*" predeterminada.
|
||||
/// Interfaz común que debe implementar cualquier tema de PageTop.
|
||||
///
|
||||
/// Un tema implementa [`Theme`] y los métodos necesarios de [`Extension`]. El único método
|
||||
/// **obligatorio** de `Extension` para un tema es [`theme()`](Extension::theme).
|
||||
///
|
||||
/// ```rust
|
||||
/// use pagetop::prelude::*;
|
||||
///
|
||||
/// pub struct MyTheme;
|
||||
///
|
||||
/// impl Extension for MyTheme {
|
||||
/// fn name(&self) -> L10n {
|
||||
/// L10n::n("My theme")
|
||||
/// }
|
||||
///
|
||||
/// fn description(&self) -> L10n {
|
||||
/// L10n::n("A personal theme")
|
||||
/// }
|
||||
///
|
||||
/// fn theme(&self) -> Option<ThemeRef> {
|
||||
/// Some(&Self)
|
||||
/// }
|
||||
/// }
|
||||
///
|
||||
/// impl Theme for MyTheme {}
|
||||
/// ```
|
||||
pub trait Theme: Extension + ThemePage + Send + Sync {
|
||||
/// **Obsoleto desde la versión 0.4.0**: usar [`page_regions()`](Self::page_regions) en su
|
||||
/// lugar.
|
||||
#[deprecated(since = "0.4.0", note = "Use `page_regions()` instead")]
|
||||
fn regions(&self) -> Vec<(&'static str, L10n)> {
|
||||
vec![("content", L10n::l("content"))]
|
||||
}
|
||||
|
||||
/// Declaración ordenada de las regiones disponibles en la página.
|
||||
///
|
||||
/// Devuelve una **lista estática** de pares `(Region, L10n)` que se usará para renderizar en el
|
||||
/// orden indicado todas las regiones que componen una página.
|
||||
///
|
||||
/// Requisitos y recomendaciones:
|
||||
///
|
||||
/// - Los identificadores deben ser **estables** (p. ej. `"sidebar-left"`, `"content"`).
|
||||
/// - La región `"content"` es **obligatoria**. Se puede usar [`Region::default()`] para
|
||||
/// declararla.
|
||||
/// - La etiqueta `L10n` se evalúa con el idioma activo de la página.
|
||||
///
|
||||
/// Si tu tema define un conjunto distinto, se puede **sobrescribir** este método. Por defecto
|
||||
/// devuelve:
|
||||
///
|
||||
/// - `"header"`: cabecera.
|
||||
/// - `"content"`: contenido principal (**obligatoria**).
|
||||
/// - `"footer"`: pie.
|
||||
fn page_regions(&self) -> &'static [(Region, L10n)] {
|
||||
static REGIONS: LazyLock<[(Region, L10n); 3]> = LazyLock::new(|| {
|
||||
[
|
||||
(Region::declare("header"), L10n::l("region_header")),
|
||||
(Region::default(), L10n::l("region_content")),
|
||||
(Region::declare("footer"), L10n::l("region_footer")),
|
||||
]
|
||||
});
|
||||
®IONS[..]
|
||||
}
|
||||
|
||||
/// Acciones específicas del tema antes de renderizar el `<body>` de la página.
|
||||
///
|
||||
/// Útil para preparar clases, inyectar recursos o ajustar metadatos.
|
||||
#[allow(unused_variables)]
|
||||
fn before_render_page_body(&self, page: &mut Page) {}
|
||||
|
||||
/// Renderiza el contenido del `<body>` de la página.
|
||||
///
|
||||
/// Si se sobrescribe este método, se puede volver al comportamiento base con:
|
||||
/// `<Self as ThemePage>::render_body(self, page, self.page_regions())`.
|
||||
#[inline]
|
||||
fn render_page_body(&self, page: &mut Page) -> Markup {
|
||||
<Self as ThemePage>::render_body(self, page, self.page_regions())
|
||||
}
|
||||
|
||||
/// Acciones específicas del tema después de renderizar el `<body>` de la página.
|
||||
///
|
||||
/// Útil para *tracing*, métricas o ajustes finales del estado de la página.
|
||||
#[allow(unused_variables)]
|
||||
fn after_render_page_body(&self, page: &mut Page) {}
|
||||
|
||||
/// Renderiza el contenido del `<head>` de la página.
|
||||
///
|
||||
/// Si se sobrescribe este método, se puede volver al comportamiento base con:
|
||||
/// `<Self as ThemePage>::render_head(self, page)`.
|
||||
#[inline]
|
||||
fn render_page_head(&self, page: &mut Page) -> Markup {
|
||||
<Self as ThemePage>::render_head(self, page)
|
||||
}
|
||||
|
||||
/// Contenido predeterminado para la página de error "*403 – Forbidden*".
|
||||
///
|
||||
/// Se puede sobrescribir este método para personalizar y adaptar este contenido al tema.
|
||||
fn error403(&self, page: &mut Page) -> Markup {
|
||||
html! { div { h1 { (L10n::l("error403_notice").to_markup(page)) } } }
|
||||
html! { div { h1 { (L10n::l("error403_notice").using(page)) } } }
|
||||
}
|
||||
|
||||
/// Página de error "*404 – Not Found*" predeterminada.
|
||||
/// Contenido predeterminado para la página de error "*404 – Not Found*".
|
||||
///
|
||||
/// Se puede sobrescribir este método para personalizar y adaptar este contenido al tema.
|
||||
fn error404(&self, page: &mut Page) -> Markup {
|
||||
html! { div { h1 { (L10n::l("error404_notice").to_markup(page)) } } }
|
||||
html! { div { h1 { (L10n::l("error404_notice").using(page)) } } }
|
||||
}
|
||||
}
|
||||
|
||||
/// Se implementa automáticamente `ThemePage` para cualquier tema.
|
||||
impl<T: Theme> ThemePage for T {}
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ pub const REGION_CONTENT: &str = "content";
|
|||
/// (p.ej., clases `region__{name}`).
|
||||
///
|
||||
/// Se utiliza para declarar las regiones que componen una página en un tema (ver
|
||||
/// [`declared_regions()`](crate::core::theme::Theme::declared_regions)).
|
||||
/// [`page_regions()`](crate::core::theme::Theme::page_regions)).
|
||||
pub struct Region {
|
||||
key: &'static str,
|
||||
name: String,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue