JS: Converted/updated translation code to TS, fixed some comment counts

[bookstack] / dev / docs / javascript-code.md

diff --git a/dev/docs/javascript-code.md b/dev/docs/javascript-code.md
index a1092ce92569ffad21aec73471fbde7b8b621b93..e5f491839f0933bc7f7f80ae126289b488f8ebde 100644 (file)
--- a/dev/docs/javascript-code.md
+++ b/dev/docs/javascript-code.md
@@ -85,18 +85,18 @@ Will result with `this.$opts` being:
 A component has the below shown properties & methods available for use. As mentioned above, most of these should be used within the `setup()` function to make the requirements/dependencies of the component clear.
 
 ```javascript
-// The root element that the compontent has been applied to.
+// The root element that the component has been applied to.
 this.$el
 
-// A map of defined element references within the compontent.
+// A map of defined element references within the component.
 // See "Element References" above.
 this.$refs
 
-// A map of defined multi-element references within the compontent.
+// A map of defined multi-element references within the component.
 // See "Element References" above.
 this.$manyRefs
 
-// Options defined for the compontent.
+// Options defined for the component.
 this.$opts
 
 // The registered name of the component, usually kebab-case.
@@ -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);
@@ -136,8 +137,8 @@ window.$events.showValidationErrors(error);
 // Translator
 // Take the given plural text and count to decide on what plural option
 // to use, Similar to laravel's trans_choice function but instead
-// takes the direction directly instead of a translation key.
-window.trans_plural(translationString, count, replacements);
+// takes the translation text directly instead of a translation key.
+window.$trans.choice(translationString, count, replacements);
 
 // Component System
 // Parse and initialise any components from the given root el down.
@@ -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);
-```
\ No newline at end of file
+```
+
+## 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 & components used in the system.
+
+Details on these events can be found in the [JavaScript Public Events file](javascript-public-events.md).