19 lines
1 KiB
TypeScript
19 lines
1 KiB
TypeScript
|
/** Sets the library's base path to the specified directory. */
|
||
|
|
export declare function setBasePath(path: string): void;
|
||
|
|
/**
|
||
|
|
* 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 shoelace.js or shoelace-autoloader.js and set the base path
|
||
|
|
* to the directory that contains that file. To override this behavior, you can add the data-shoelace attribute to any
|
||
|
|
* script on the page (it probably makes the most sense to attach it to the Shoelace script, but it could also be on a
|
||
|
|
* bundle). The value can be a local folder or it can point to a CORS-enabled endpoint such as a CDN.
|
||
|
|
*
|
||
|
|
* <script src="bundle.js" data-shoelace="/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 declare function getBasePath(subpath?: string): string;
|