Skip to main content

HtmlIntegration

Struct HtmlIntegration 

Source
pub struct HtmlIntegration<'m> { /* private fields */ }
Expand description

HTML integration.

Builds links, preloads for specified chunks.

// Create `HtmlIntegration` struct:
let html = HtmlIntegration::new(MyViteStatic.boxed())
    // add imports of chunks: (<script> tags)
    .import("src/main.tsx")
    // add preloads of assets (fonts, images, etc).
    // arguments: (preload's as="..." attribute, chunk input filename),
    .preload("image", "src/images/500GB_image.png")
    // add stylesheets
    .stylesheet("src/style.scss")
    // and then, you can build `String` of HTML (tags, joined by '\n')
    .build();
    // or you can build array of tags/lines
    // .build_lines();

// The result will contain `<script>` tags, `<link rel="stylesheet" ...>` for CSS,
// `<link rel="preload" ...>` for image and <link rel="modulepreload" ...> for dependencies.

Implementations§

Source§

impl<'m> HtmlIntegration<'m>

Source

pub fn new(manifest: DynManifest<'m>) -> Self

Create new HtmlIntegration builder.

Takes DynManifest (boxed Manifest) and returns HtmlIntegration.

Source

pub fn import(self, chunk: &str) -> Self

Import ESM ManifestChunk by key (input filename).

This function:

  • adds <script type="module" ...> for specified chunk;
  • adds module preloads for all script dependencies.
.import("src/main.tsx")
.import("src/components/MyCoolComponent.tsx")
.import("src/or/some/styles.scss")
§Panics

This function will panic if:

  • Failed to find chunk by specified key
  • Failed to find dependency (AKA imported chunk)
Source

pub fn preload(self, as_filetype: &'static str, chunk: &str) -> Self

Preload ManifestChunk as type by key (input filename).

.preload("font", "src/assets/CoolFancyFont.ttf")
.preload("image", "src/assets/500GB_image.png")
.preload("script", "src/importantScript.js")
§Panics

This function will panic if specified chunk was not found.

Source

pub fn stylesheet(self, chunk: &str) -> Self

Import stylesheet by key (input filename).

.stylesheet("src/style.css")
.stylesheet("src/style.scss")
.stylesheet("src/style.less")
.stylesheet("src/style.whatever")
§Panics

This function will panic if specified chunk was not found.

Source

pub fn build_lines(self) -> Vec<String>

Builds HTML and returns array of lines.

let html_lines = HtmlIntegration::new(MyViteStatic.boxed())
    .import("src/main.tsx")
    .build_lines();

assert_eq!(html_lines.len(), 3);
// `src/main.tsx` script tag, `src/shared.ts` preload and `src/style.scss` stylesheet.
Source

pub fn build(self) -> String

Builds HTML and returns String.

let html = HtmlIntegration::new(MyViteStatic.boxed())
    .import("src/main.tsx")
    .build();

Trait Implementations§

Source§

impl Clone for HtmlIntegration<'_>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<'m> !RefUnwindSafe for HtmlIntegration<'m>

§

impl<'m> !UnwindSafe for HtmlIntegration<'m>

§

impl<'m> Freeze for HtmlIntegration<'m>

§

impl<'m> Send for HtmlIntegration<'m>

§

impl<'m> Sync for HtmlIntegration<'m>

§

impl<'m> Unpin for HtmlIntegration<'m>

§

impl<'m> UnsafeUnpin for HtmlIntegration<'m>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.