Struct ViewTransitionsPlugin 

pub struct ViewTransitionsPlugin;

Plugin that injects the View Transitions API client + style hooks.

Opt-in via SsgConfig::transitions; when false the plugin is never registered (see core::pipeline::register_default_plugins).

Examples

use ssg::plugin::Plugin;
use ssg::view_transitions::ViewTransitionsPlugin;
assert_eq!(ViewTransitionsPlugin::new().name(), "view-transitions");

Implementations

impl ViewTransitionsPlugin

pub const fn new() -> Self

Creates a new instance.

Examples

use ssg::view_transitions::ViewTransitionsPlugin;
let _plugin = ViewTransitionsPlugin::new();

pub const fn enabled(cfg: &SsgConfig) -> bool

Returns whether cfg opts in to transitions.

Examples

use ssg::cmd::SsgConfig;
use ssg::view_transitions::ViewTransitionsPlugin;
let cfg = SsgConfig::builder()
    .site_name("t".into())
    .base_url("http://example.com".into())
    .build()
    .unwrap();
assert!(!ViewTransitionsPlugin::enabled(&cfg));

Trait Implementations

impl Clone for ViewTransitionsPlugin

fn clone(&self) -> ViewTransitionsPlugin

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ViewTransitionsPlugin

impl Debug for ViewTransitionsPlugin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ViewTransitionsPlugin

fn default() -> ViewTransitionsPlugin

Returns the “default value” for a type.

impl Plugin for ViewTransitionsPlugin

fn name(&self) -> &'static str

Returns the unique name of this plugin.

fn has_transform(&self) -> bool

Returns true if this plugin implements transform_html. Override to true to opt in to the fused transform pass.

fn transform_html( &self, html: &str, _path: &Path, _ctx: &PluginContext, ) -> Result<String, SsgError>

Per-file HTML transform hook — called once per HTML file during the fused transform pass.

fn after_compile(&self, ctx: &PluginContext) -> Result<(), SsgError>

Called after site compilation completes.

fn before_compile(&self, _ctx: &PluginContext) -> Result<(), SsgError>

Called before site compilation begins.

fn needs_all_files(&self) -> bool

Returns true if this plugin must always observe the full cache.html_files() list — even during --incremental rebuilds that only invalidated a handful of pages.

fn on_serve(&self, _ctx: &PluginContext) -> Result<(), SsgError>

Called before the development server starts serving files.