Documented ASP.NET Core MVC / Razor Pages UI: JavaScript Resource Loader API

pull/5869/head
Halil İbrahim Kalkan 5 years ago
parent 3fa6756cd1
commit 45e77a4903

@ -12,7 +12,7 @@ ABP provides a set of JavaScript APIs for ASP.NET Core MVC / Razor Pages applica
* [Features](Features.md)
* [Localization](Localization.md)
* [Logging](Logging.md)
* ResourceLoader
* [ResourceLoader](ResourceLoader.md)
* [Settings](Settings.md)
* [UI Block/Busy](Block-Busy.md)
* [UI Message](Message.md)

@ -0,0 +1,40 @@
# ASP.NET Core MVC / Razor Pages UI: JavaScript Resource Loader API
`abp.ResourceLoader` is a service that can load a JavaScript or CSS file on demand. It guarantees to load the file only once even if you request multiple times.
## Loading Script Files
`abp.ResourceLoader.loadScript(...)` function **loads** a JavaScript file from the server and **executes** it.
**Example: Load a JavaScript file**
````js
abp.ResourceLoader.loadScript('/Pages/my-script.js');
````
### Parameters
`loadScript` function can get three parameters;
* `url` (required, `string`): The URL of the script file to be loaded.
* `loadCallback` (optional, `function`): A callback function that is called once the script is loaded & executed. In this callback you can safely use the code in the script file. This callback is called even if the file was loaded before.
* `failCallback` (optional, `function`): A callback function that is called if loading the script fails.
**Example: Provide the `loadCallback` argument**
````
abp.ResourceLoader.loadScript('/Pages/my-script.js', function() {
console.log('successfully loaded :)');
});
````
## Loading Style Files
`abp.ResourceLoader.loadStyle(...)` function adds a `link` element to the `head` of the document for the given URL, so the CSS file is automatically loaded by the browser.
**Example: Load a CSS file**
````js
abp.ResourceLoader.loadStyle('/Pages/my-styles.css');
````

@ -498,6 +498,10 @@
{
"text": "Logging",
"path": "UI/AspNetCore/JavaScript-API/Logging.md"
},
{
"text": "Resource Loader",
"path": "UI/AspNetCore/JavaScript-API/ResourceLoader.md"
}
]
},

Loading…
Cancel
Save