@appsemble/types 0.20.24 → 0.20.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/README.md CHANGED
@@ -1,10 +1,10 @@
1
- # ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.24/config/assets/logo.svg) Appsemble Types
1
+ # ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.26/config/assets/logo.svg) Appsemble Types
2
2
 
3
3
  > Reusable TypeScript types
4
4
 
5
5
  [![npm](https://img.shields.io/npm/v/@appsemble/types)](https://www.npmjs.com/package/@appsemble/types)
6
- [![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.20.24/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.24)
7
- [![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.20.24/graph/badge.svg)](https://codecov.io/gl/appsemble/appsemble)
6
+ [![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.20.26/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.26)
7
+ [![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.20.26/graph/badge.svg)](https://codecov.io/gl/appsemble/appsemble)
8
8
  [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
9
9
 
10
10
  ## Installation
@@ -21,5 +21,5 @@ not guaranteed.
21
21
 
22
22
  ## License
23
23
 
24
- [LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.24/LICENSE.md) ©
24
+ [LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.26/LICENSE.md) ©
25
25
  [Appsemble](https://appsemble.com)
package/index.d.ts CHANGED
@@ -821,7 +821,7 @@ export interface ShareActionDefinition extends BaseActionDefinition<'share'> {
821
821
  */
822
822
  title?: Remapper;
823
823
  }
824
- type StorageType = 'indexedDB' | 'localStorage' | 'sessionStorage';
824
+ export type StorageType = 'appStorage' | 'indexedDB' | 'localStorage' | 'sessionStorage';
825
825
  export interface StorageAppendActionDefinition extends BaseActionDefinition<'storage.append'> {
826
826
  /**
827
827
  * The key of the entry to write to the app’s storage.
@@ -1189,7 +1189,7 @@ export interface BasePageDefinition {
1189
1189
  /**
1190
1190
  * The name of the page.
1191
1191
  *
1192
- * This will be displayed on the top of the page and in the side menu,
1192
+ * This will be displayed at the *app bar* of each page and in the side menu,
1193
1193
  * unless @see navTitle is set.
1194
1194
  *
1195
1195
  * The name of the page is used to determine the URL path of the page.
@@ -1205,6 +1205,10 @@ export interface BasePageDefinition {
1205
1205
  * Context property `name` can be used to access the name of the page.
1206
1206
  */
1207
1207
  navTitle?: Remapper;
1208
+ /**
1209
+ * Whether or not the page should be displayed in navigational menus.
1210
+ */
1211
+ hideNavTitle?: boolean;
1208
1212
  /**
1209
1213
  * The navigation type to use for the page.
1210
1214
  * Setting this will override the default navigation for the app.
@@ -1228,10 +1232,6 @@ export interface BasePageDefinition {
1228
1232
  * The global theme for the page.
1229
1233
  */
1230
1234
  theme?: Partial<Theme>;
1231
- /**
1232
- * Whether or not the page should be displayed in navigational menus.
1233
- */
1234
- hideFromMenu?: boolean;
1235
1235
  }
1236
1236
  /**
1237
1237
  * A subset of page for use within flow pages and tab pages.
package/index.ts CHANGED
@@ -972,7 +972,7 @@ export interface ShareActionDefinition extends BaseActionDefinition<'share'> {
972
972
  title?: Remapper;
973
973
  }
974
974
 
975
- type StorageType = 'indexedDB' | 'localStorage' | 'sessionStorage';
975
+ export type StorageType = 'appStorage' | 'indexedDB' | 'localStorage' | 'sessionStorage';
976
976
 
977
977
  export interface StorageAppendActionDefinition extends BaseActionDefinition<'storage.append'> {
978
978
  /**
@@ -1470,7 +1470,7 @@ export interface BasePageDefinition {
1470
1470
  /**
1471
1471
  * The name of the page.
1472
1472
  *
1473
- * This will be displayed on the top of the page and in the side menu,
1473
+ * This will be displayed at the *app bar* of each page and in the side menu,
1474
1474
  * unless @see navTitle is set.
1475
1475
  *
1476
1476
  * The name of the page is used to determine the URL path of the page.
@@ -1489,6 +1489,11 @@ export interface BasePageDefinition {
1489
1489
  */
1490
1490
  navTitle?: Remapper;
1491
1491
 
1492
+ /**
1493
+ * Whether or not the page should be displayed in navigational menus.
1494
+ */
1495
+ hideNavTitle?: boolean;
1496
+
1492
1497
  /**
1493
1498
  * The navigation type to use for the page.
1494
1499
  * Setting this will override the default navigation for the app.
@@ -1516,11 +1521,6 @@ export interface BasePageDefinition {
1516
1521
  * The global theme for the page.
1517
1522
  */
1518
1523
  theme?: Partial<Theme>;
1519
-
1520
- /**
1521
- * Whether or not the page should be displayed in navigational menus.
1522
- */
1523
- hideFromMenu?: boolean;
1524
1524
  }
1525
1525
 
1526
1526
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@appsemble/types",
3
- "version": "0.20.24",
3
+ "version": "0.20.26",
4
4
  "description": "TypeScript definitions reused within Appsemble internally",
5
5
  "keywords": [
6
6
  "app",