Skip to content

Updating js docs #1380

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 8, 2024
Merged

Updating js docs #1380

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions ui.frontend/src/constants.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export const Constants = {
* @property {object} event - The event object.
* @property {object} event.detail - Instance of FormContainer that is initialized.
* @example
* document.on("AF_FormContainerInitialised" , function(event) {
* document.addEventListener("AF_FormContainerInitialised" , function(event) {
* var formContainer = event.detail;
* // Handle the event
* });
Expand All @@ -50,10 +50,15 @@ export const Constants = {
* @property {object} event - The event object.
* @property {object} event.detail - Instance of child view that is added.
* @example
* formcontainer.getFormElement().on("AF_PanelInstanceAdded" , function(event) {
* var childView = event.detail;
* document.addEventListener("AF_FormContainerInitialised" , function(event) {
* var formContainer = event.detail;
* // Handle the event
* formcontainer.getFormElement().addEventListener("AF_PanelInstanceAdded" , function(event) {
* var childView = event.detail;
* // Handle the event
* });
* });
*
*/
PANEL_INSTANCE_ADDED : "AF_PanelInstanceAdded",

Expand All @@ -63,9 +68,13 @@ export const Constants = {
* @property {object} event - The event object.
* @property {object} event.detail - Instance of child view that was removed.
* @example
* formcontainer.getFormElement().on("AF_PanelInstanceRemoved" , function(event) {
* var childView = event.detail;
* document.addEventListener("AF_FormContainerInitialised" , function(event) {
* var formContainer = event.detail;
* // Handle the event
* formcontainer.getFormElement().addEventListener("AF_PanelInstanceRemoved" , function(event) {
* var childView = event.detail;
* // Handle the event
* });
* });
*/
PANEL_INSTANCE_REMOVED : "AF_PanelInstanceRemoved",
Expand All @@ -76,7 +85,7 @@ export const Constants = {
* @property {object} event - The event object.
* @property {object} event.detail - The locale that has loaded.
* @example
* document.on("AF_LanguageInitialised" , function(event) {
* document.addEventListener("AF_LanguageInitialised" , function(event) {
* var locale = event.detail;
* // Handle the event
* });
Expand Down