Struct Scripting

Source

pub struct Scripting { /* private fields */ }

Expand description

With this you register your script sources and global/“merged” scripts for the whole page

You usually only use it during bundle initialization. There are already handlers for /scripting/path_to_your_script.js and /scripting/script.js.

Implementations§

Source §

impl Scripting

Source

pub fn try_new() -> Result<Self>

Source

pub fn register_embedded_scripts<E: RustEmbed + Send + Sync + 'static>( &mut self, )

Registers a script from a rust_embed struct

§Example

use quokka_templating::Scripting;

#[derive(rust_embed::RustEmbed)]
#[folder = "../test_resources/scripts"]
#[include = "*.js"]
struct Scripts;

let mut scripting = Scripting::try_new().unwrap();

assert!(scripting.get_script("test.js").is_none());

scripting.register_embedded_scripts::<Scripts>();
assert_eq!(scripting.get_script("test.js").unwrap(), "console.log(\"Hello World\");\n");

Source

pub fn add_merged_script(&mut self, script: &str)

Adds a script to the default group. Same as Scripting.add_merged_script_group("default", path)

Source

pub fn add_merged_script_group(&mut self, group: &str, script: &str)

Adds a global script.

The merged scripts are supposed to be loaded on all pages. Adding a big or a lot of scripts will impact the sites performance and reduce the user experiance. Use with caution.

§Note

The script name has to be a valid import part. Relative paths in the current directory need to start with a ./. An alphanumeric “word” will be seen as an item of an import map more details here

§Example

use quokka_templating::Scripting;

#[derive(rust_embed::RustEmbed)]
#[folder = "../test_resources/scripts"]
#[include = "*.js"]
struct Scripts;

let mut scripting = Scripting::try_new().unwrap();

assert!(scripting.get_merged_script().is_empty());

scripting.add_merged_script_group("default", "./test.js");
assert_eq!(scripting.get_merged_script(), "import \"./test.js\";\n");

Source

pub fn get_script(&self, path: &str) -> Option<String>

Gets a script by its path

§Example

use quokka_templating::Scripting;

#[derive(rust_embed::RustEmbed)]
#[folder = "../test_resources/scripts"]
#[include = "*.js"]
struct Scripts;

let mut scripting = Scripting::try_new().unwrap();

assert!(scripting.get_script("test.js").is_none());

scripting.register_embedded_scripts::<Scripts>();
assert_eq!(scripting.get_script("test.js").unwrap(), "console.log(\"Hello World\");\n");

Source

pub fn get_merged_script(&self) -> String

Gets the default merged scripts. Same as Scripting.get_merged_script_group("default")

Source

pub fn get_merged_script_group(&self, group: &str) -> String

Gets the merged script. Merged scripts are supposed to be used on all sides. The merged script will rely on ECMAScript imports to get all the required scripts.

§Example

use quokka_templating::Scripting;

#[derive(rust_embed::RustEmbed)]
#[folder = "../test_resources/scripts"]
#[include = "*.js"]
struct Scripts;

let mut scripting = Scripting::try_new().unwrap();

assert!(scripting.get_merged_script().is_empty());

scripting.add_merged_script("test.js");
assert_eq!(scripting.get_merged_script(), "import \"test.js\";\n");