add_fileroute(route::String, filename::AbstractString;
  basedir = pwd(),
  content_type::Union{Nothing, Symbol} = nothing,
  named::Union{Symbol, Nothing} = nothing,
  cache_control::Union{String, Nothing} = default_cache_control(),
  headers = HTTP.Headers())

Registers a Genie route at the literal route path that serves filename (resolved as joinpath(basedir, filename)) as a static asset. Unlike the AssetsConfig-based method, route is used verbatim – there's no assets/<type>/ path convention or package host/version involved. Useful for exposing an individual file (e.g. a document) at a specific URL with its own caching behaviour.

cache_control defaults to default_cache_control (the GENIE_ASSETS_CACHE_MAXAGE env var) like the other method, but since this method targets one specific route rather than a whole package's assets, passing cache_control explicitly here is the way to give that one route a Cache-Control different from the general setting – including cache_control = nothing to suppress the header for just this route.

Example

add_fileroute("/docs/handbook.pdf", "handbook.pdf"; basedir = "files", cache_control = "no-cache")

mutable struct AssetsConfig

Manages the assets configuration for the current package. Define your own instance of AssetsConfig if you want to add support for asset management for your package through Genie.Assets.

assets_config!(packages::Vector{Module}; config...) :: Nothing
assets_config!(package::Module; config...) :: Nothing

Utility function which allows bulk configuration of the assets.

Example

Genie.Assets.assets_config!([Genie, Stipple, StippleUI], host = "https://cdn.statically.io/gh/GenieFramework")

assets_config!(; config...) :: Nothing

Updates the assets configuration for the current package.

asset_file(; cwd = "", file::String, path::String = "", type::String = "", prefix::String = "assets",
              ext::String = "", min::Bool = false, skip_ext::Bool = false) :: String

Generates the file system path to an asset file.

asset_path(; file::String, host::String = Genie.config.base_path, package::String = "", version::String = "",
              prefix::String = "assets", type::String = "", path::String = "", min::Bool = false,
              ext::String = "", skip_ext::Bool = false, query::String = "") :: String
asset_path(file::String; kwargs...) :: String
asset_path(ac::AssetsConfig, tp::Union{Symbol,String}; type::String = string(tp), path::String = "",
                file::String = "", ext::String = "", skip_ext::Bool = false, query::String = "") :: String

Generates the path to an asset file.

asset_route(; file::String, package::String = "", version::String = "", prefix::String = "assets",
              type::String = "", path::String = "", min::Bool = false,
              ext::String = "", skip_ext::Bool = false, query::String = "") :: String
asset_route(file::String; kwargs...) :: String
asset_route(ac::AssetsConfig, tp::Union{Symbol,String}; type::String = string(tp), path::String = "",
            file::String = "", ext::String = "", skip_ext::Bool = false, query::String = "") :: String

Generates the route to an asset file.

channels(channel::AbstractString = Genie.config.webchannels_default_route) :: String

Outputs the channels.js file included with the Genie package.

channels_script(channel::AbstractString = Genie.config.webchannels_default_route) :: String

Outputs the channels JavaScript content within <script>...</script> tags, for embedding into the page.

channels_subscribe(channel::AbstractString = Genie.config.webchannels_default_route) :: Nothing

Registers subscription and unsubscription channels for channel.

channels_support(channel = Genie.config.webchannels_default_route) :: String

Provides full web channels support, setting up routes for loading support JS files, web sockets subscription and returning the <script> tag for including the linked JS file into the web page.

css_asset(file_name::String) :: String

Path to a css asset. The file_name should not include the extension.

embeded(path::String) :: String

Reads and outputs the file at path.

embeded_path(path::String) :: String

Returns the path relative to Genie's root package dir.

external_assets(host::String) :: Bool
external_assets(ac::AssetsConfig) :: Bool
external_assets() :: Bool

Returns true if the current package is using external assets.

favicon_support() :: String

Outputs the <link> tag for referencing the favicon file embedded with Genie.

include_asset(asset_type::Union{String,Symbol}, file_name::Union{String,Symbol}) :: String

Returns the path to an asset. asset_type can be one of :js, :css. The file_name should not include the extension.

js_asset(file_name::String) :: String

Path to a js asset. file_name should not include the extension.

js_settings(channel::String = Genie.config.webchannels_default_route) :: String

Sets up a window.Genie.Settings JavaScript object which exposes relevant Genie app settings from Genie.config

webthreads() :: String

Outputs the webthreads.js file included with the Genie package

function webthreads_push_pull(channel) :: Nothing

Registers push and pull routes for channel.

webthreads_script() :: String

Outputs the channels JavaScript content within <script>...</script> tags, for embedding into the page.

function webthreads_subscribe(channel) :: Nothing

Registers subscription and unsubscription routes for channel.

webthreads_support(channel = Genie.config.webthreads_default_route) :: String

Provides full web channels support, setting up routes for loading support JS files, web sockets subscription and returning the <script> tag for including the linked JS file into the web page.