Files
webawesome/src/utilities/base-path.ts
2024-06-11 14:38:22 -04:00

77 lines
2.7 KiB
TypeScript

let basePath = '';
let kitCode = '';
/** Sets the library's base path to the specified directory or URL. */
export function setBasePath(path: string) {
basePath = path;
}
/**
* Gets the library's base path.
*
* The base path is used to load assets such as icons and images, so it needs to be set for components to work properly.
* By default, this script will look for a script ending in webawesome.js or autoloader.js and set the base path to the
* directory that contains that file. To override this behavior, you can add the data-webawesome attribute to any
* element on the page to point to a local path or a CORS-enabled endpoint, such as a CDN.
*
* <script src="bundle.js" data-webawesome="/custom/base/path"></script>
*
* Alternatively, you can set the base path manually using the exported setBasePath() function.
*
* @param subpath - An optional path to append to the base path.
*/
export function getBasePath(subpath = '') {
if (!basePath) {
// If we haven't set the base path yet, let's set it now
const el = document.querySelector('[data-webawesome]');
if (el) {
// Use the data-webawesome attribute
setBasePath(el.getAttribute('data-webawesome') || '');
} else {
// Look for webawesome.js or autoloader.js
const scripts = [...document.getElementsByTagName('script')] as HTMLScriptElement[];
const waScript = scripts.find(
script => script.src.endsWith('webawesome.js') || script.src.endsWith('webawesome.loader.js')
);
if (waScript) {
const path = String(waScript.getAttribute('src'));
setBasePath(path.split('/').slice(0, -1).join('/'));
}
}
}
// Return the base path without a trailing slash. If one exists, append the subpath separated by a slash.
return basePath.replace(/\/$/, '') + (subpath ? `/${subpath.replace(/^\//, '')}` : ``);
}
/** Sets the library's Web Awesome kit code. */
export function setKitCode(code: string) {
kitCode = code;
}
/**
* Gets the library's Web Awesome kit code.
*
* The kit code is used to fetch premium assets, so it needs to be set for certain components to work correctly. This
* isn't something we can infer, so the user will need to provide it using the `data-fa-kit-code` attribute. This can
* be on any element, but ideally it should exist on the script that imports Web Awesome.
*
* <script src="bundle.js" data-fa-kit-code="abc123"></script>
*
* Alternatively, you can set the kit code manually using the exported `setKitCode()` function.
*
*/
export function getKitCode() {
if (!kitCode) {
const el = document.querySelector('[data-fa-kit-code]');
if (el) {
setKitCode(el.getAttribute('data-fa-kit-code') || '');
}
}
return kitCode;
}