////
/// @group settings/assets
////

/// Path to the assets directory, with trailing slash.
///
/// This is the directory where the images and fonts subdirectories live. You
/// will need to make this directory available via your application – see the
/// README for details.
///
/// @type String
/// @access public

$govuk-assets-path: "/assets/" !default;

/// Path to the images folder, with trailing slash.
///
/// @type String
/// @access public

$govuk-images-path: "#{$govuk-assets-path}images/" !default;

/// Path to the fonts folder, with trailing slash.
///
/// @type String
/// @access public

$govuk-fonts-path: "#{$govuk-assets-path}fonts/" !default;

/// Custom image URL function
///
/// If you need more control than $govuk-images-path provides, you can use a
/// function to resolve image filenames to URLs.
///
/// The function should accept a filename and return the URL as a string,
/// wrapped with `url()`.
///
/// Passing the name of a function as a string is deprecated.
///
/// @type Function | String | null
///
/// @example scss - Passing a function
///
///   @use "sass:meta";
///   // Include the module containing the handler function
///   @use "url-handlers";
///
///   // Then pass the handler function using `meta.get-function`
///   @use "node_modules/govuk-frontend/dist/govuk" as * with (
///     $govuk-image-url-function: meta.get-function("image-url", $module: "url-handlers")
///   )
///
/// @example scss - Passing the name of a function (deprecated)
///
///   // This is only available if you still use `@import`
///   @function my-url-handler($filename) {
///     // Some custom URL handling
///     @return url('example.jpg');
///   }
///
///   $govuk-image-url-function: 'my-url-handler';
///
///   @import "node_modules/govuk-frontend/dist/govuk";
///
/// @see $govuk-images-path
/// @see {function} govuk-image-url
///
/// @access public

$govuk-image-url-function: null !default;

/// Custom font URL function
///
/// If you need more control than $govuk-fonts-path provides, you can use a
/// function to resolve font filenames to URLs.
///
/// The function should accept a filename and return the URL as a string,
/// wrapped with `url()`.
///
/// Passing the name of a function as a string is deprecated.
///
/// @type Function | String | null
///
/// @example scss - Passing a function
///
///   @use "sass:meta";
///   // Include the module containing the handler function
///   @use "url-handlers";
///
///   // Then pass the handler function using `meta.get-function`
///   @use "node_modules/govuk-frontend/dist/govuk" as * with (
///     $govuk-font-url-function: meta.get-function("font-url", $module: "url-handlers")
///   )
///
/// @example scss - Passing the name of a function (deprecated)
///
///   // This is only available if you still use `@import`
///   @function my-url-handler($filename) {
///     // Some custom URL handling
///     @return url('example.woff');
///   }
///
///   $govuk-font-url-function: 'my-url-handler';
///
///   @import "node_modules/govuk-frontend/dist/govuk";
///
/// @see $govuk-fonts-path
/// @see {function} govuk-font-url
///
/// @access public

$govuk-font-url-function: null !default;

