You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/css.md
-1Lines changed: 0 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,6 @@ When it comes to customizing your site using CSS, LumApps provides a set of func
14
14
## Prerequisites
15
15
- In order to add customizations to your site, basic knowledge of [CSS](https://developer.mozilla.org/en-US/docs/Glossary/CSS) is mandatory.
16
16
- In order to deploy customizations into your site, you will need to be the administrator of the site where you want to add these customizations.
17
-
- In order to follow this guide and use the examples documented below, your platform needs to have the new top bar activated. Without it, customizations will not work as expected. Please reach out to your LumApps representative if you still do not have the new top bar activated.
18
17
- For development, we strongly suggest using the following tools in order to have a proper development environment:
19
18
-[Visual Studio Code](https://code.visualstudio.com/) for creating and editing code;
20
19
-[Git](https://git-scm.com/) for properly versioning the customizations that you will be creating.
Copy file name to clipboardExpand all lines: docs/javascript.md
-1Lines changed: 0 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,6 @@ When it comes to customizing your site using JavaScript, LumApps provides a set
16
16
## Prerequisites
17
17
- In order to add customizations to your site, basic knowledge of [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) is mandatory.
18
18
- In order to deploy customizations into your site, you will need to be the administrator of the site where you want to add these customizations.
19
-
- In order to follow this guide and use the examples documented below, your platform needs to have the new top bar activated. Without it, customizations will not work as expected. Please reach out to your LumApps representative if you still do not have the new top bar activated.
20
19
- For development, we strongly suggest using the following tools in order to have a proper development environment:
21
20
-[Visual Studio Code](https://code.visualstudio.com/) for creating and editing code;
22
21
-[Git](https://git-scm.com/) for properly versioning the customizations that you will be creating.
|`events.NAVIGATION`| Event id for user navigation events. |[Documentation](./capabilities#event-navigation)|
55
-
|`events.SEARCH`| Event id for the user search page interaction events. |[Documentation](./capabilities#event-search)|
56
-
|`events.WIDGET_RENDERED`| Event id for the event triggered after rendering a widget. |[Documentation](./capabilities#event-widget-rendered)|
54
+
|`events.NAVIGATION`| Event id for user navigation events. |[Documentation](#event-navigation)|
55
+
|`events.SEARCH`| Event id for the user search page interaction events. |[Documentation](#event-search)|
56
+
|`events.WIDGET_RENDERED`| Event id for the event triggered after rendering a widget. |[Documentation](#event-widget-rendered)|
57
57
58
58
### targets
59
59
@@ -74,15 +74,15 @@ And `configuration` is an object that allows these properties:
74
74
|`targets.HEADER`| Target id for the site's header. |[Documentation](./capabilities#header)|
75
75
|`targets.LOGO`| Target id for the site's logo. |[Documentation](./capabilities#logo)|
76
76
|`targets.NAVIGATION`| Target id for the main navigation. |[Documentation](./capabilities#navigation)|
77
-
|`targets.NAVIGATION_UI`| Target id for the main navigation's UI. |[Documentation](./capabilities#navigation)|
78
-
|`targets.NOT_FOUND_PAGE`| Target id for the not found error page (error code 404). |[Documentation](./capabilities#not-found-page)|
77
+
|`targets.NAVIGATION_UI`| Target id for the main navigation's UI. |[Documentation](./capabilities#navigation)|
78
+
|`targets.NOT_FOUND_PAGE`| Target id for the not found error page (error code 404). |[Documentation](./capabilities#not-found-page)|
79
79
|`targets.NOTIFICATIONS_BUTTON`| Target id for the notifications center component. |[Documentation](./capabilities#header)|
80
80
|`targets.PAGE`| Target id for all pages. |[Documentation](./capabilities#page)|
81
81
|`targets.PROFILE`| Target id for the profile page. |[Documentation](./capabilities#profile)|
82
82
|`targets.SEARCH`| Target id for the search page. |[Documentation](./capabilities#search)|
83
83
|`targets.SEARCH_BOX`| Target id for the search box. |[Documentation](./capabilities#search-box)|
84
84
|`targets.SEARCH_CUSTOM_METADATA`| Target id for search custom metadata. |[Documentation](./capabilities#search-custom-metadata)|
85
-
|`targets.SEARCH_TAB`| Target id for search tab. |[Documentation](./capabilities#search-tab)|
85
+
|`targets.SEARCH_TAB`| Target id for search tab. |[Documentation](./capabilities#search-tab)|
86
86
|`targets.SETTINGS`| Target id for the settings menu. |[Documentation](./capabilities#settings)|
87
87
|`targets.SETTINGS_BUTTON`| Target id for the settings icon on the top bar. |[Documentation](./capabilities#settings-button)|
88
88
|`targets.STICKY_HEADER`| Target id for the sticky header. |[Documentation](./capabilities#sticky-header)|
@@ -1233,7 +1233,7 @@ across the entire platform, or if you need to communicate information between cu
1233
1233
1234
1234
The `props` parameter will have information depending on the event type. For a full list of all events, please refer to the [documentation](./api#events).
1235
1235
1236
-
#### events.SEARCH
1236
+
#### Event Search
1237
1237
1238
1238
There are four main types of search events, all of them can ben easily identified using the `cause` props which can be found in all those events:
1239
1239
-`searchbox-interaction`
@@ -1289,7 +1289,7 @@ Event triggered each time the user makes apply a new sort order. Please find bel
1289
1289
|`props.sortOrders`| List of all sort values available. Contains a value and a label |`object[]`|
1290
1290
|`props.cause`| Cause of the search event. Always set to `sort-interaction`|`string`|
1291
1291
1292
-
#### events.WIDGET_RENDERED
1292
+
#### Event Widget Rendered
1293
1293
1294
1294
Event triggered each time a widget is rendered on the page. This event is ideal if you need to trigger additional customisations for a specific widget
1295
1295
across the entire platform, or if you need to communicate information between widgets.
@@ -1313,7 +1313,7 @@ The `widget` parameter will have basic information of the rendered widget, plus
1313
1313
-`widget.items` can contain information that you can use in order to retrieve information from the rendered items on the given widget. However, it is worth mentioning that these items ARE NOT stable and can suffer changes at any time. Please consider this while developing any of your features. Only the properties documented in this section are considered stable.
1314
1314
- This event is only supported on contents compatible with our next gen interface (`NGI`) system
1315
1315
1316
-
#### events.NAVIGATION
1316
+
#### Event Navigation
1317
1317
1318
1318
It is an event that will be called on each navigation. It receives the following parameters:
0 commit comments