jmapcloud-ng-types 1.0.24 → 1.0.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "jmapcloud-ng-types",
3
- "version": "1.0.24",
3
+ "version": "1.0.26",
4
4
  "description": "JMap Cloud specific version of JMap Cloud NG types and interfaces",
5
5
  "main": "src/app.ts",
6
6
  "scripts": {
@@ -23,7 +23,7 @@
23
23
  "homepage": "https://github.com/k2geospatial/jmapcloud-ng-types#readme",
24
24
  "devDependencies": {
25
25
  "@types/react": "^18.3.2",
26
- "jmapcloud-ng-core-types": "1.0.22",
26
+ "jmapcloud-ng-core-types": "1.0.23",
27
27
  "maplibre-gl": "^4.3.1",
28
28
  "react": "^18.3.1",
29
29
  "typedoc": "^0.25.13"
@@ -1,44 +1,44 @@
1
1
  /**
2
2
  * You can create a custom application panel throught the app extension mecanism.
3
- *
3
+ *
4
4
  * It offers a way to add your own panel, map interactor, redux store data, etc ...
5
- *
5
+ *
6
6
  * This way you can fully customize your JMap Cloud NG with your own code, written with your favourite dev tools.
7
7
  */
8
8
  declare interface JAppExtension extends JCoreExtension {
9
9
  /**
10
10
  * The panel creation method.
11
- *
11
+ *
12
12
  * This is where you have to :
13
13
  * - Create your panel UI
14
14
  * - Add your listeners (like Redux subscribe)
15
15
  * - ect ...
16
- *
16
+ *
17
17
  * This method is called each time the panel is :
18
18
  * - Created : after a panel change
19
19
  * - Displayed : after the panel is displayed after been hidden
20
- *
20
+ *
21
21
  * @param panelContainerId The html container id where you can insert your application.
22
22
  */
23
23
  onPanelCreation: (panelContainerId: string) => void
24
24
  /**
25
25
  * The panel destroy method.
26
- *
26
+ *
27
27
  * This is where you have to :
28
28
  * - Destroy the panel UI (if not yet done).
29
29
  * - Remove your listeners (like Redux unsubscribe)
30
30
  * - etc ...
31
- *
31
+ *
32
32
  * This method is called each time the panel is :
33
33
  * - Destroyed : after a panel change (panelContainerId div doesn't exist when called)
34
34
  * - Hidden : when the panel is hidden (panelContainerId div still exist when called)
35
- *
35
+ *
36
36
  * @param panelContainerId The html container id where you can insert your application.
37
37
  */
38
38
  onPanelDestroy?: (panelContainerId: string) => void
39
39
  /**
40
40
  * The panel icon.
41
- *
41
+ *
42
42
  * An url (png, jpeg, svg, etc ...), a base 64 string or an svg tag as a string, as you like.
43
43
  * For an svg string a viewbox need to be specified for the icon to appear,
44
44
  * if no fill attribute is specified, the icon will follow the app theme.
@@ -50,23 +50,29 @@ declare interface JAppExtension extends JCoreExtension {
50
50
  panelTooltip?: string | JTranslationItem
51
51
  /**
52
52
  * The panel title.
53
- *
53
+ *
54
54
  * If provided, will create a header on top of the panel having
55
55
  * the same style of the others panels headers.
56
56
  */
57
57
  panelTitle?: string | JTranslationItem
58
+ /**
59
+ * Specify to omit the panel header if required.
60
+ *
61
+ * If set to true, NG will not display the panel header, including the extension's title. The extension developer is then responsible for displaying the extension's title inside its panel. The panel scrolling behaviour will also have to be handled by the developer.
62
+ */
63
+ omitPanelHeader?: boolean
58
64
  /**
59
65
  * An optional map interactor.
60
- *
66
+ *
61
67
  * See [[JMap.Service.Map.Interaction]] for more details.
62
68
  */
63
69
  interactor?: JMapInteractor
64
70
  /**
65
71
  * The panel registration method.
66
- *
72
+ *
67
73
  * This method is called each time the app extension is :
68
74
  * - Registered, after the panel and interactors have been created
69
- *
75
+ *
70
76
  * Here you can perform actions after the registering of the extension.
71
77
  */
72
78
  onAppRegistrationDone?: () => void
package/public/panel.d.ts CHANGED
@@ -7,7 +7,7 @@ declare interface JAppPanelDeactivationParams extends JAppPanelActivationParams
7
7
  }
8
8
 
9
9
  declare interface JAppPanelLeaveResponse {
10
- title: string,
10
+ title: string
11
11
  message: string
12
12
  }
13
13
 
@@ -16,6 +16,7 @@ declare interface JAppPanel {
16
16
  icon: string // url or base64 or app name
17
17
  iconTooltip: string | JTranslationItem | (() => string)
18
18
  interactorId?: string | (() => string | undefined)
19
+ omitPanelHeader?: boolean
19
20
  title?: string | JTranslationItem | (() => string)
20
21
  isPopup?: boolean
21
22
  onPanelCreation?: (panelContainerId: string) => void