1. class
  2. Illuminate
  3. \
  4. Foundation
  5. \
  6. Vite

Vite

class Vite implements Htmlable (View source)

Traits

Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected string|null $nonce

The Content Security Policy nonce to apply to all generated tags.
protected string|false $integrityKey

The key to check for integrity hashes within the manifest.
protected array $entryPoints

The configured entry points.
protected string|null $hotFile

The path to the "hot" file.
protected string $buildDirectory

The path to the build directory.
protected string $manifestFilename

The name of the manifest file.
protected callable|null $assetPathResolver

The custom asset path resolver.
protected array $scriptTagAttributesResolvers

The script tag attributes resolvers.
protected array $styleTagAttributesResolvers

The style tag attributes resolvers.
protected array $preloadTagAttributesResolvers

The preload tag attributes resolvers.
protected array $preloadedAssets

The preloaded assets.
static protected array $manifests

The cached manifest files.
protected $prefetchStrategy

The prefetching strategy to use.
protected int $prefetchConcurrently

The number of assets to load concurrently when using the "waterfall" strategy.
protected string $prefetchEvent

The name of the event that should trigger prefetching. The event must be dispatched on the window.

Methods

static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
array
preloadedAssets()

Get the preloaded assets.

string|null
cspNonce()

Get the Content Security Policy nonce applied to all generated tags.

string
useCspNonce(string|null $nonce = null)

Generate or set a Content Security Policy nonce to apply to all generated tags.

$this
useIntegrityKey(string|false $key)

Use the given key to detect integrity hashes in the manifest.

$this
withEntryPoints(array $entryPoints)

Set the Vite entry points.

$this
mergeEntryPoints(array $entryPoints)

Merge additional Vite entry points with the current set.

$this
useManifestFilename(string $filename)

Set the filename for the manifest file.

$this
createAssetPathsUsing(callable|null $resolver)

Resolve asset paths using the provided resolver.

string
hotFile()

Get the Vite "hot" file path.

$this
useHotFile(string $path)

Set the Vite "hot" file path.

$this
useBuildDirectory(string $path)

Set the Vite build directory.

$this
useScriptTagAttributes($attributes)

Use the given callback to resolve attributes for script tags.

$this
useStyleTagAttributes($attributes)

Use the given callback to resolve attributes for style tags.

$this
usePreloadTagAttributes($attributes)

Use the given callback to resolve attributes for preload tags.

$this
prefetch(int|null $concurrency = null, string $event = 'load')

Eagerly prefetch assets.

$this
useWaterfallPrefetching(int|null $concurrency = null)

Use the "waterfall" prefetching strategy.

$this
useAggressivePrefetching()

Use the "aggressive" prefetching strategy.

$this
usePrefetchStrategy($strategy, array $config = [])

Set the prefetching strategy.

HtmlString
__invoke(string|string[] $entrypoints, string|null $buildDirectory = null)

Generate Vite tags for an entrypoint.

string
makeTagForChunk(string $src, string $url, array|null $chunk, array|null $manifest)

Make tag for the given chunk.

string
makePreloadTagForChunk(string $src, string $url, array $chunk, array $manifest)

Make a preload tag for the given chunk.

array
resolveScriptTagAttributes(string $src, string $url, array|null $chunk, array|null $manifest)

Resolve the attributes for the chunks generated script tag.

array
resolveStylesheetTagAttributes(string $src, string $url, array|null $chunk, array|null $manifest)

Resolve the attributes for the chunks generated stylesheet tag.

array|false
resolvePreloadTagAttributes(string $src, string $url, array $chunk, array $manifest)

Resolve the attributes for the chunks generated preload tag.

string
makeTag(string $url) deprecated

Generate an appropriate tag for the given URL in HMR mode.

string
makeScriptTag(string $url) deprecated

Generate a script tag for the given URL.

string
makeStylesheetTag(string $url) deprecated

Generate a stylesheet tag for the given URL in HMR mode.

string
makeScriptTagWithAttributes(string $url, array $attributes)

Generate a script tag with attributes for the given URL.

string
makeStylesheetTagWithAttributes(string $url, array $attributes)

Generate a link tag with attributes for the given URL.

bool
isCssPath(string $path)

Determine whether the given path is a CSS file.

array
parseAttributes(array $attributes)

Parse the attributes into key="value" strings.

HtmlString|void
reactRefresh()

Generate React refresh runtime script.

string
hotAsset($asset)

Get the path to a given asset when running in HMR mode.

string
asset(string $asset, string|null $buildDirectory = null)

Get the URL for an asset.

string
content(string $asset, string|null $buildDirectory = null)

Get the content of a given asset.

string
assetPath(string $path, bool|null $secure = null)

Generate an asset path for the application.

array
manifest(string $buildDirectory)

Get the manifest file for the given build directory.

string
manifestPath(string $buildDirectory)

Get the path to the manifest file for the given build directory.

string|null
manifestHash(string|null $buildDirectory = null)

Get a unique hash representing the current manifest, or null if there is no manifest.

array
chunk(array $manifest, string $file)

Get the chunk for the given entry point / asset.

HtmlString
nonceAttribute()

Get the nonce attribute for the prefetch script tags.

bool
isRunningHot()

Determine if the HMR server is running.

string
toHtml()

Get the Vite tag content as a string of HTML.

Details

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 126
array preloadedAssets()

Get the preloaded assets.

Return Value

array

at line 136
string|null cspNonce()

Get the Content Security Policy nonce applied to all generated tags.

Return Value

string|null

at line 147
string useCspNonce(string|null $nonce = null)

Generate or set a Content Security Policy nonce to apply to all generated tags.

Parameters

string|null $nonce

Return Value

string

at line 158
$this useIntegrityKey(string|false $key)

Use the given key to detect integrity hashes in the manifest.

Parameters

string|false $key

Return Value

$this

at line 171
$this withEntryPoints(array $entryPoints)

Set the Vite entry points.

Parameters

array $entryPoints

Return Value

$this

at line 184
$this mergeEntryPoints(array $entryPoints)

Merge additional Vite entry points with the current set.

Parameters

array $entryPoints

Return Value

$this

at line 198
$this useManifestFilename(string $filename)

Set the filename for the manifest file.

Parameters

string $filename

Return Value

$this

at line 211
$this createAssetPathsUsing(callable|null $resolver)

Resolve asset paths using the provided resolver.

Parameters

callable|null $resolver

Return Value

$this

at line 223
string hotFile()

Get the Vite "hot" file path.

Return Value

string

at line 234
$this useHotFile(string $path)

Set the Vite "hot" file path.

Parameters

string $path

Return Value

$this

at line 247
$this useBuildDirectory(string $path)

Set the Vite build directory.

Parameters

string $path

Return Value

$this

at line 260
$this useScriptTagAttributes($attributes)

Use the given callback to resolve attributes for script tags.

Parameters

$attributes

Return Value

$this

at line 277
$this useStyleTagAttributes($attributes)

Use the given callback to resolve attributes for style tags.

Parameters

$attributes

Return Value

$this

at line 294
$this usePreloadTagAttributes($attributes)

Use the given callback to resolve attributes for preload tags.

Parameters

$attributes

Return Value

$this

at line 312
$this prefetch(int|null $concurrency = null, string $event = 'load')

Eagerly prefetch assets.

Parameters

int|null $concurrency
string $event

Return Value

$this

at line 326
$this useWaterfallPrefetching(int|null $concurrency = null)

Use the "waterfall" prefetching strategy.

Parameters

int|null $concurrency

Return Value

$this

at line 338
$this useAggressivePrefetching()

Use the "aggressive" prefetching strategy.

Return Value

$this

at line 350
$this usePrefetchStrategy($strategy, array $config = [])

Set the prefetching strategy.

Parameters

$strategy
array $config

Return Value

$this

at line 370
HtmlString __invoke(string|string[] $entrypoints, string|null $buildDirectory = null)

Generate Vite tags for an entrypoint.

Parameters

string|string[] $entrypoints
string|null $buildDirectory

Return Value

HtmlString

Exceptions

Exception

at line 585
protected string makeTagForChunk(string $src, string $url, array|null $chunk, array|null $manifest)

Make tag for the given chunk.

Parameters

string $src
string $url
array|null $chunk
array|null $manifest

Return Value

string

at line 618
protected string makePreloadTagForChunk(string $src, string $url, array $chunk, array $manifest)

Make a preload tag for the given chunk.

Parameters

string $src
string $url
array $chunk
array $manifest

Return Value

string

at line 642
protected array resolveScriptTagAttributes(string $src, string $url, array|null $chunk, array|null $manifest)

Resolve the attributes for the chunks generated script tag.

Parameters

string $src
string $url
array|null $chunk
array|null $manifest

Return Value

array

at line 664
protected array resolveStylesheetTagAttributes(string $src, string $url, array|null $chunk, array|null $manifest)

Resolve the attributes for the chunks generated stylesheet tag.

Parameters

string $src
string $url
array|null $chunk
array|null $manifest

Return Value

array

at line 686
protected array|false resolvePreloadTagAttributes(string $src, string $url, array $chunk, array $manifest)

Resolve the attributes for the chunks generated preload tag.

Parameters

string $src
string $url
array $chunk
array $manifest

Return Value

array|false

at line 724
protected string makeTag(string $url) deprecated

deprecated Will be removed in a future Laravel version.

Generate an appropriate tag for the given URL in HMR mode.

Parameters

string $url

Return Value

string

at line 741
protected string makeScriptTag(string $url) deprecated

deprecated Will be removed in a future Laravel version.

Generate a script tag for the given URL.

Parameters

string $url

Return Value

string

at line 754
protected string makeStylesheetTag(string $url) deprecated

deprecated Will be removed in a future Laravel version.

Generate a stylesheet tag for the given URL in HMR mode.

Parameters

string $url

Return Value

string

at line 766
protected string makeScriptTagWithAttributes(string $url, array $attributes)

Generate a script tag with attributes for the given URL.

Parameters

string $url
array $attributes

Return Value

string

at line 784
protected string makeStylesheetTagWithAttributes(string $url, array $attributes)

Generate a link tag with attributes for the given URL.

Parameters

string $url
array $attributes

Return Value

string

at line 801
protected bool isCssPath(string $path)

Determine whether the given path is a CSS file.

Parameters

string $path

Return Value

bool

at line 812
protected array parseAttributes(array $attributes)

Parse the attributes into key="value" strings.

Parameters

array $attributes

Return Value

array

at line 827
HtmlString|void reactRefresh()

Generate React refresh runtime script.

Return Value

HtmlString|void

at line 859
protected string hotAsset($asset)

Get the path to a given asset when running in HMR mode.

Parameters

$asset

Return Value

string

at line 871
string asset(string $asset, string|null $buildDirectory = null)

Get the URL for an asset.

Parameters

string $asset
string|null $buildDirectory

Return Value

string

at line 893
string content(string $asset, string|null $buildDirectory = null)

Get the content of a given asset.

Parameters

string $asset
string|null $buildDirectory

Return Value

string

Exceptions

ViteException

at line 915
protected string assetPath(string $path, bool|null $secure = null)

Generate an asset path for the application.

Parameters

string $path
bool|null $secure

Return Value

string

at line 928
protected array manifest(string $buildDirectory)

Get the manifest file for the given build directory.

Parameters

string $buildDirectory

Return Value

array

Exceptions

ViteManifestNotFoundException

at line 949
protected string manifestPath(string $buildDirectory)

Get the path to the manifest file for the given build directory.

Parameters

string $buildDirectory

Return Value

string

at line 960
string|null manifestHash(string|null $buildDirectory = null)

Get a unique hash representing the current manifest, or null if there is no manifest.

Parameters

string|null $buildDirectory

Return Value

string|null

at line 984
protected array chunk(array $manifest, string $file)

Get the chunk for the given entry point / asset.

Parameters

array $manifest
string $file

Return Value

array

Exceptions

ViteException

at line 998
protected HtmlString nonceAttribute()

Get the nonce attribute for the prefetch script tags.

Return Value

HtmlString

at line 1012
bool isRunningHot()

Determine if the HMR server is running.

Return Value

bool

at line 1022
string toHtml()

Get the Vite tag content as a string of HTML.

Return Value

string