use crate::base::action; use crate::core::component::{ComponentError, Context, Contextual}; use crate::core::{AnyInfo, TypeInfo}; use crate::html::{html, Markup}; /// Define la función de renderizado para todos los componentes. /// /// Este *trait* se implementa automáticamente en cualquier tipo (componente) que implemente /// [`Component`], por lo que no requiere ninguna codificación manual. pub trait ComponentRender { /// Renderiza el componente usando el contexto proporcionado. fn render(&mut self, cx: &mut Context) -> Markup; } /// Interfaz común que debe implementar un componente renderizable en PageTop. /// /// Se recomienda que los componentes declaren sus campos como privados, que deriven /// [`AutoDefault`](crate::AutoDefault) o implementen [`Default`] para inicializarlos por defecto, y /// [`Getters`](crate::Getters) para acceder a sus datos. Deberán implementar explícitamente el /// método [`new()`](Self::new) y podrán sobrescribir los demás métodos para personalizar su /// comportamiento. pub trait Component: AnyInfo + ComponentRender + Send + Sync { /// Crea una nueva instancia del componente. /// /// Por convención suele devolver `Self::default()`. fn new() -> Self where Self: Sized; /// Devuelve el nombre del componente. /// /// Por defecto se obtiene del nombre corto del tipo usando [`TypeInfo::ShortName`]. fn name(&self) -> &'static str { TypeInfo::ShortName.of::() } /// Devuelve una descripción del componente, si existe. /// /// Por defecto, no se proporciona ninguna descripción (`None`). fn description(&self) -> Option { None } /// 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`). fn id(&self) -> Option { None } /// Indica si el componente es renderizable. /// /// Por defecto, todos los componentes son renderizables (`true`). Sin embargo, este método /// puede sobrescribirse para decidir dinámicamente si los componentes de este tipo se /// renderizan o no en función del contexto de renderizado. /// /// También puede asignarse una función [`FnIsRenderable`](super::FnIsRenderable) a un campo del /// componente para permitir que instancias concretas del mismo puedan decidir dinámicamente si /// se renderizan o no. #[allow(unused_variables)] fn is_renderable(&self, cx: &mut Context) -> bool { true } /// Configura el componente justo antes de preparar el renderizado. /// /// Este método puede sobrescribirse para modificar la estructura interna del componente o el /// contexto antes de renderizarlo. Por defecto no hace nada. #[allow(unused_variables)] fn setup_before_prepare(&mut self, cx: &mut Context) {} /// Devuelve el marcado HTML del componente usando el contexto proporcionado. /// /// 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. Cada componente lo implementa para generar /// su propio contenido HTML. Los temas hijo pueden sobrescribir opcionalmente su resultado /// mediante la acción [`PrepareRender`](crate::base::action::theme::PrepareRender). /// /// Se recomienda obtener los datos del componente a través de sus propios métodos para que los /// temas hijo que implementen dicha acción puedan generar el nuevo HTML sin depender de los /// detalles internos del componente. /// /// Por defecto, devuelve un [`Markup`] vacío (`Ok(html! {})`). /// /// En caso de error, devuelve un [`ComponentError`] que puede incluir un marcado alternativo /// (*fallback*) para sustituir al componente fallido. #[allow(unused_variables)] fn prepare_component(&self, cx: &mut Context) -> Result { Ok(html! {}) } } /// Implementa [`render()`](ComponentRender::render) para todos los componentes. /// /// El proceso de renderizado de cada componente sigue esta secuencia: /// /// 1. Ejecuta [`is_renderable()`](Component::is_renderable) para ver si puede renderizarse en el /// contexto actual. Si no es así, devuelve un [`Markup`] vacío. /// 2. Ejecuta [`setup_before_prepare()`](Component::setup_before_prepare) para que el componente /// pueda ajustar su estructura interna o modificar el contexto. /// 3. Despacha [`action::theme::BeforeRender`](crate::base::action::theme::BeforeRender) para /// permitir que el tema realice ajustes previos. /// 4. Despacha [`action::component::BeforeRender`](crate::base::action::component::BeforeRender) /// para que otras extensiones puedan también hacer ajustes previos. /// 5. **Prepara el renderizado del componente**: /// - Despacha [`action::theme::PrepareRender`](crate::base::action::theme::PrepareRender) /// para permitir al tema generar un renderizado alternativo. /// - Si el tema no lo modifica, llama a [`prepare_component()`](Component::prepare_component) /// para obtener el renderizado por defecto del componente. /// 6. Despacha [`action::theme::AfterRender`](crate::base::action::theme::AfterRender) para /// que el tema pueda aplicar ajustes finales. /// 7. Despacha [`action::component::AfterRender`](crate::base::action::component::AfterRender) /// para que otras extensiones puedan hacer sus últimos ajustes. /// 8. Devuelve el [`Markup`] generado en el paso 5. impl ComponentRender for C { fn render(&mut self, cx: &mut Context) -> Markup { // Si no es renderizable, devuelve un bloque HTML vacío. if !self.is_renderable(cx) { return html! {}; } // Configura el componente antes de preparar. self.setup_before_prepare(cx); // Acciones específicas del tema antes de renderizar el componente. action::theme::BeforeRender::dispatch(self, cx); // Acciones de las extensiones antes de renderizar el componente. action::component::BeforeRender::dispatch(self, cx); // Prepara el renderizado del componente. let prepare = match action::theme::PrepareRender::dispatch(self, cx) { Ok(markup) if !markup.is_empty() => markup, Ok(_) => match self.prepare_component(cx) { Ok(markup) => markup, Err(error) => { crate::trace::error!( path = cx.request().map(|r| r.path()).unwrap_or(""), component = self.name(), id = self.id().as_deref().unwrap_or(""), source = "prepare_component", "render failed, using fallback: {}", error.message() ); error.into_fallback() } }, Err(error) => { crate::trace::error!( path = cx.request().map(|r| r.path()).unwrap_or(""), component = self.name(), id = self.id().as_deref().unwrap_or(""), source = "PrepareRender", "render failed, using fallback: {}", error.message() ); error.into_fallback() } }; // Acciones específicas del tema después de renderizar el componente. action::theme::AfterRender::dispatch(self, cx); // Acciones de las extensiones después de renderizar el componente. action::component::AfterRender::dispatch(self, cx); // Devuelve el marcado final. prepare } }