Incorpora is_renderable en Component

This commit is contained in:
Manuel Cillero 2025-11-17 22:50:56 +01:00
parent 682ed7cc45
commit dea994e8ca
4 changed files with 78 additions and 110 deletions

View file

@ -1,8 +1,5 @@
//! Acciones que operan sobre componentes. //! Acciones que operan sobre componentes.
mod is_renderable;
pub use is_renderable::*;
mod before_render_component; mod before_render_component;
pub use before_render_component::*; pub use before_render_component::*;

View file

@ -1,96 +0,0 @@
use crate::prelude::*;
/// Tipo de función para determinar si un componente se renderiza o no.
///
/// Se usa en la acción [`IsRenderable`] para controlar dinámicamente la visibilidad del componente
/// `component` según el contexto `cx`. El componente **no se renderiza** en cuanto una de las
/// funciones devuelva `false`.
pub type FnIsRenderable<C> = fn(component: &C, cx: &Context) -> bool;
/// Con la función [`FnIsRenderable`] se puede decidir si se renderiza o no un componente.
pub struct IsRenderable<C: Component> {
f: FnIsRenderable<C>,
referer_type_id: Option<UniqueId>,
referer_id: AttrId,
weight: Weight,
}
/// Filtro para despachar [`FnIsRenderable`] para decidir si se renderiza o no un componente `C`.
impl<C: Component> ActionDispatcher for IsRenderable<C> {
/// Devuelve el identificador de tipo ([`UniqueId`]) del componente `C`.
fn referer_type_id(&self) -> Option<UniqueId> {
self.referer_type_id
}
/// Devuelve el identificador del componente.
fn referer_id(&self) -> Option<String> {
self.referer_id.get()
}
/// Devuelve el peso para definir el orden de ejecución.
fn weight(&self) -> Weight {
self.weight
}
}
impl<C: Component> IsRenderable<C> {
/// Permite [registrar](Extension::actions) una nueva acción [`FnIsRenderable`].
pub fn new(f: FnIsRenderable<C>) -> Self {
IsRenderable {
f,
referer_type_id: Some(UniqueId::of::<C>()),
referer_id: AttrId::default(),
weight: 0,
}
}
/// Afina el registro para ejecutar la acción [`FnIsRenderable`] sólo para el componente `C`
/// con identificador `id`.
pub fn filter_by_referer_id(mut self, id: impl AsRef<str>) -> Self {
self.referer_id.alter_value(id);
self
}
/// Opcional. Acciones con pesos más bajos se aplican antes. Se pueden usar valores negativos.
pub fn with_weight(mut self, value: Weight) -> Self {
self.weight = value;
self
}
// Despacha las acciones. Se detiene en cuanto una [`FnIsRenderable`] devuelve `false`.
#[inline]
pub(crate) fn dispatch(component: &C, cx: &mut Context) -> bool {
let mut renderable = true;
dispatch_actions(
&ActionKey::new(
UniqueId::of::<Self>(),
None,
Some(UniqueId::of::<C>()),
None,
),
|action: &Self| {
if renderable && !(action.f)(component, cx) {
renderable = false;
}
},
);
if renderable {
if let Some(id) = component.id() {
dispatch_actions(
&ActionKey::new(
UniqueId::of::<Self>(),
None,
Some(UniqueId::of::<C>()),
Some(id),
),
|action: &Self| {
if renderable && !(action.f)(component, cx) {
renderable = false;
}
},
);
}
}
renderable
}
}

View file

@ -11,6 +11,59 @@ pub use children::{Typed, TypedOp};
mod context; mod context;
pub use context::{Context, ContextError, ContextOp, Contextual}; pub use context::{Context, ContextError, ContextOp, Contextual};
/// Alias de función (*callback*) para **determinar si un componente se renderiza o no**.
///
/// Puede usarse para permitir que una instancia concreta de un tipo de componente dado decida
/// dinámicamente durante el proceso de renderizado ([`Component::is_renderable()`]) si se renderiza
/// o no.
///
/// # Ejemplo
///
/// ```rust
/// # use pagetop::prelude::*;
/// #[derive(AutoDefault)]
/// struct SampleComponent {
/// renderable: Option<FnIsRenderable>,
/// }
///
/// impl Component for SampleComponent {
/// fn new() -> Self {
/// Self::default()
/// }
///
/// fn is_renderable(&self, cx: &mut Context) -> bool {
/// // Si hay callback, se usa; en caso contrario, se renderiza por defecto.
/// self.renderable.map_or(true, |f| f(cx))
/// }
///
/// fn prepare_component(&self, _cx: &mut Context) -> PrepareMarkup {
/// PrepareMarkup::Escaped("Visible component".into())
/// }
/// }
///
/// impl SampleComponent {
/// /// Asigna una función que decidirá si el componente se renderiza o no.
/// #[builder_fn]
/// pub fn with_renderable(mut self, f: Option<FnIsRenderable>) -> Self {
/// self.renderable = f;
/// self
/// }
/// }
///
/// fn sample() {
/// let mut cx = Context::default().with_param("user_logged_in", true);
///
/// // Se instancia un componente que sólo se renderiza si `user_logged_in` es `true`.
/// let mut component = SampleComponent::new().with_renderable(Some(|cx: &Context| {
/// cx.param::<bool>("user_logged_in").copied().unwrap_or(false)
/// }));
///
/// // Aquí simplemente se comprueba que compila y se puede invocar.
/// let _markup = component.render(&mut cx);
/// }
/// ```
pub type FnIsRenderable = fn(cx: &Context) -> bool;
/// Alias de función (*callback*) para **resolver una URL** según el contexto de renderizado. /// Alias de función (*callback*) para **resolver una URL** según el contexto de renderizado.
/// ///
/// Se usa para generar enlaces dinámicos en función del contexto (petición, idioma, etc.). Debe /// Se usa para generar enlaces dinámicos en función del contexto (petición, idioma, etc.). Debe

View file

@ -45,6 +45,20 @@ pub trait Component: AnyInfo + ComponentRender + Send + Sync {
None 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 usarse junto con un alias de función como
/// ([`FnIsRenderable`](crate::core::component::FnIsRenderable)) para permitir que instancias
/// concretas del componente decidan 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. /// Configura el componente justo antes de preparar el renderizado.
/// ///
/// Este método puede sobrescribirse para modificar la estructura interna del componente o el /// Este método puede sobrescribirse para modificar la estructura interna del componente o el
@ -72,30 +86,30 @@ pub trait Component: AnyInfo + ComponentRender + Send + Sync {
/// Implementa [`render()`](ComponentRender::render) para todos los componentes. /// Implementa [`render()`](ComponentRender::render) para todos los componentes.
/// ///
/// Y para cada componente ejecuta la siguiente secuencia: /// El proceso de renderizado de cada componente sigue esta secuencia:
/// ///
/// 1. Despacha [`action::component::IsRenderable`](crate::base::action::component::IsRenderable) /// 1. Ejecuta [`is_renderable()`](Component::is_renderable) para ver si puede renderizarse en el
/// para ver si se puede renderizar. Si no es así, devuelve un [`Markup`] vacío. /// contexto actual. Si no es así, devuelve un [`Markup`] vacío.
/// 2. Ejecuta [`setup_before_prepare()`](Component::setup_before_prepare) para que el componente /// 2. Ejecuta [`setup_before_prepare()`](Component::setup_before_prepare) para que el componente
/// pueda ajustar su estructura interna o modificar el contexto. /// pueda ajustar su estructura interna o modificar el contexto.
/// 3. Despacha [`action::theme::BeforeRender<C>`](crate::base::action::theme::BeforeRender) para /// 3. Despacha [`action::theme::BeforeRender<C>`](crate::base::action::theme::BeforeRender) para
/// que el tema pueda hacer ajustes en el componente o el contexto. /// permitir que el tema realice ajustes previos.
/// 4. Despacha [`action::component::BeforeRender<C>`](crate::base::action::component::BeforeRender) /// 4. Despacha [`action::component::BeforeRender<C>`](crate::base::action::component::BeforeRender)
/// para que otras extensiones puedan hacer ajustes. /// para que otras extensiones puedan también hacer ajustes previos.
/// 5. **Prepara el renderizado del componente**: /// 5. **Prepara el renderizado del componente**:
/// - Despacha [`action::theme::PrepareRender<C>`](crate::base::action::theme::PrepareRender) /// - Despacha [`action::theme::PrepareRender<C>`](crate::base::action::theme::PrepareRender)
/// para permitir al tema preparar un renderizado diferente al predefinido. /// para permitir al tema generar un renderizado alternativo.
/// - Si no es así, ejecuta [`prepare_component()`](Component::prepare_component) para preparar /// - Si el tema no lo modifica, llama a [`prepare_component()`](Component::prepare_component)
/// el renderizado predefinido del componente. /// para obtener el renderizado por defecto del componente.
/// 6. Despacha [`action::theme::AfterRender<C>`](crate::base::action::theme::AfterRender) para /// 6. Despacha [`action::theme::AfterRender<C>`](crate::base::action::theme::AfterRender) para
/// que el tema pueda hacer sus últimos ajustes. /// que el tema pueda aplicar ajustes finales.
/// 7. Despacha [`action::component::AfterRender<C>`](crate::base::action::component::AfterRender) /// 7. Despacha [`action::component::AfterRender<C>`](crate::base::action::component::AfterRender)
/// para que otras extensiones puedan hacer sus últimos ajustes. /// para que otras extensiones puedan hacer sus últimos ajustes.
/// 8. Finalmente devuelve un [`Markup`] del renderizado preparado en el paso 5. /// 8. Devuelve el [`Markup`] generado en el paso 5.
impl<C: Component> ComponentRender for C { impl<C: Component> ComponentRender for C {
fn render(&mut self, cx: &mut Context) -> Markup { fn render(&mut self, cx: &mut Context) -> Markup {
// Si no es renderizable, devuelve un bloque HTML vacío. // Si no es renderizable, devuelve un bloque HTML vacío.
if !action::component::IsRenderable::dispatch(self, cx) { if !self.is_renderable(cx) {
return html! {}; return html! {};
} }