Skip to content

Added support to state where custom JavaScript files are imported - Head or Body; Added additional parameters for importing custom JavaScript/CSS, such as Integrity, Async, etc. #690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Badgerati merged 1 commit into from
Feb 1, 2026
Merged

Added support to state where custom JavaScript files are imported - Head or Body; Added additional parameters for importing custom JavaScript/CSS, such as Integrity, Async, etc. #690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/Tutorials/Basics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,3 +149,5 @@ Initialize-PodeWebTemplates -Title 'Example' -Theme Dark -HideSidebar
## Custom Scripts/Styles

You can reference custom JavaScript and CSS files to use via [`Import-PodeWebJavaScript`](../../Functions/Utilities/Import-PodeWebJavaScript) and [`Import-PodeWebStylesheet`](../../Functions/Utilities/Import-PodeWebStylesheet). Both take a relative/literal `-Url` to the file.

For each, you can also supply additional parameters to help define how the JavaScript or CSS file should be retrieved, such as: async; crossorigin; integrity; etc.
2 changes: 1 addition & 1 deletion examples/inputs_no_form.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Start-PodeServer -Threads 2 {

# set the use of templates, and set a login page
Initialize-PodeWebTemplates -Title 'Inputs' -Theme Dark
Import-PodeWebJavaScript -Url '/client-events.js'
Import-PodeWebJavaScript -Url '/client-events.js' -Location Head -Async

# add home page
Add-PodeWebPage -Name 'Home' -Path '/' -Title 'Testing Inputs' -HomePage -ScriptBlock {
Expand Down
96 changes: 92 additions & 4 deletions src/Public/Utilities.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,21 +144,109 @@ function Import-PodeWebStylesheet {
param(
[Parameter(Mandatory = $true)]
[string]
$Url
$Url,

[Parameter()]
[ValidateSet('Render')]
[string[]]
$Blocking,

[Parameter()]
[ValidateSet('Anonymous', 'Use-Credentials')]
[string]
$CrossOrigin,

[Parameter()]
[ValidateSet('Auto', 'High', 'Low')]
[string]
$FetchPriority = 'Auto',

[Parameter()]
[ValidateSet('No-Referrer', 'No-Referrer-When-Downgrade', 'Origin', 'Origin-When-Cross-Origin', 'Unsafe-URL')]
[string]
$ReferrerPolicy,

[Parameter()]
[string]
$Integrity
)

Set-PodeWebState -Name 'custom-css' -Value (@(Get-PodeWebState -Name 'custom-css') + (Add-PodeWebAppPath -Url $Url))
# build stylesheet entry and add to state
$value = @{
Url = (Add-PodeWebAppPath -Url $Url)
Blocking = "$($Blocking)".ToLowerInvariant()
CrossOrigin = "$($CrossOrigin)".ToLowerInvariant()
FetchPriority = "$($FetchPriority)".ToLowerInvariant()
ReferrerPolicy = "$($ReferrerPolicy)".ToLowerInvariant()
Integrity = $Integrity
}

Set-PodeWebState -Name 'custom-css' -Value (@(Get-PodeWebState -Name 'custom-css') + $value)
}

function Import-PodeWebJavaScript {
[CmdletBinding()]
param(
[Parameter(Mandatory = $true)]
[string]
$Url
$Url,

[Parameter()]
[ValidateSet('Head', 'Body')]
[string]
$Location = 'Body',

[Parameter()]
[ValidateSet('Render')]
[string[]]
$Blocking,

[Parameter()]
[ValidateSet('Anonymous', 'Use-Credentials')]
[string]
$CrossOrigin,

[Parameter()]
[ValidateSet('Auto', 'High', 'Low')]
[string]
$FetchPriority = 'Auto',

[Parameter()]
[ValidateSet('No-Referrer', 'No-Referrer-When-Downgrade', 'Origin', 'Origin-When-Cross-Origin', 'Same-Origin', 'Strict-Origin', 'Strict-Origin-When-Cross-Origin', 'Unsafe-URL')]
[string]
$ReferrerPolicy,

[Parameter()]
[string]
$Integrity,

[switch]
$Async,

[switch]
$Defer
)

Set-PodeWebState -Name 'custom-js' -Value (@(Get-PodeWebState -Name 'custom-js') + (Add-PodeWebAppPath -Url $Url))
# ensure not blocking in body
if (($Blocking -icontains 'Render') -and ($Location -ieq 'Body')) {
throw "When using 'Render' blocking, the location must be 'Head' for JavaScript imports."
}

# build javascript entry
$value = @{
Url = (Add-PodeWebAppPath -Url $Url)
Location = $Location
Blocking = "$($Blocking)".ToLowerInvariant()
CrossOrigin = "$($CrossOrigin)".ToLowerInvariant()
FetchPriority = "$($FetchPriority)".ToLowerInvariant()
ReferrerPolicy = "$($ReferrerPolicy)".ToLowerInvariant()
Integrity = $Integrity
Async = $Async.IsPresent
Defer = $Defer.IsPresent
}

# add to state
Set-PodeWebState -Name 'custom-js' -Value (@(Get-PodeWebState -Name 'custom-js') + $value)
}

function Set-PodeWebSocial {
Expand Down
44 changes: 44 additions & 0 deletions src/Templates/Views/shared/custom_scripts.pode
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
$(
$scripts = Get-PodeWebState -Name 'custom-js'
foreach ($js in $scripts) {
if ($js.Location -ine $data.Location) {
continue
}

$blocking = ''
if ($js.Blocking) {
$blocking = "blocking='$($js.Blocking -join ', ')'"
}

$crossOrigin = ''
if ($js.CrossOrigin) {
$crossOrigin = "crossorigin='$($js.CrossOrigin)'"
}

$fetchPriority = ''
if ($js.FetchPriority) {
$fetchPriority = "fetchpriority='$($js.FetchPriority)'"
}

$referrerPolicy = ''
if ($js.ReferrerPolicy) {
$referrerPolicy = "referrerpolicy='$($js.ReferrerPolicy)'"
}

$integrity = ''
if ($js.Integrity) {
$integrity = "integrity='$($js.Integrity)'"
}

"<script
src='$($js.Url)'
$(if ($js.Async) { 'async' })
$(if ($js.Defer) { 'defer' })
$blocking
$crossOrigin
$fetchPriority
$referrerPolicy
$integrity
></script>"
}
)
41 changes: 39 additions & 2 deletions src/Templates/Views/shared/head.pode
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,46 @@

$(
# custom stylesheets
$styles = @(Get-PodeWebState -Name 'custom-css')
$styles = Get-PodeWebState -Name 'custom-css'
foreach ($style in $styles) {
"<link class='pode-custom-css' rel='stylesheet' href='$($style)'>"
$blocking = ''
if ($style.Blocking) {
$blocking = "blocking='$($style.Blocking -join ', ')'"
}

$crossOrigin = ''
if ($style.CrossOrigin) {
$crossOrigin = "crossorigin='$($style.CrossOrigin)'"
}

$fetchPriority = ''
if ($style.FetchPriority) {
$fetchPriority = "fetchpriority='$($style.FetchPriority)'"
}

$referrerPolicy = ''
if ($style.ReferrerPolicy) {
$referrerPolicy = "referrerpolicy='$($style.ReferrerPolicy)'"
}

$integrity = ''
if ($style.Integrity) {
$integrity = "integrity='$($style.Integrity)'"
}

"<link
rel='stylesheet'
href='$($style.Url)'
$blocking
$crossOrigin
$fetchPriority
$referrerPolicy
$integrity
/>"
}
)

$(Use-PodeWebPartialView -Path 'shared/custom_scripts' -Data @{
Location = 'Head'
})
</head>
9 changes: 3 additions & 6 deletions src/Templates/Views/shared/scripts.pode
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@
<script src="$($data.AppPath)/pode.web-static/scripts/default.js"></script>
<script src="$($data.AppPath)/pode.web-static/scripts/templates.js"></script>

$(
$scripts = @(Get-PodeWebState -Name 'custom-js')
foreach ($js in $scripts) {
"<script src='$($js)'></script>"
}
)
$(Use-PodeWebPartialView -Path 'shared/custom_scripts' -Data @{
Location = 'Body'
})