archive/BookStackApp_BookStack
0
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-05-17 13:52:04 +00:00
Code Issues Projects Releases Wiki Activity

Documented public JS events used

Browse source 
Related to
This commit is contained in:
Dan Brown 2023-04-20 16:25:48 +01:00
parent 9f467f4052
commit c74f7cc628
No known key found for this signature in database
GPG key ID: 46D9F943C24A2EF9
3 changed files with 266 additions and 1 deletions

9
dev/docs/javascript-code.md
View file

@ -115,6 +115,7 @@ There are various global helper libraries in BookStack which can be accessed via
```js
// HTTP service
// Relative URLs will be resolved against the instance BASE_URL
window.$http.get(url, params);
window.$http.post(url, data);
window.$http.put(url, data);
@ -153,4 +154,10 @@ window.$components.get(name);
// Get the first active component of the given name that's been
// created on the given element.
window.$components.firstOnElement(element, name);
```
```
## Public Events
There are a range of available events that are emitted as part of a public & supported API for accessing or extending JavaScript libraries and components used in the system.
Details on these events can be found in the [JavaScript Public Events file](javascript-public-events.md).