@corvina/web-components-library 0.2.0 → 0.2.3

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/index.d.ts CHANGED
@@ -1,18 +1,16 @@
1
1
  import { Component } from 'vue';
2
2
 
3
3
  export declare namespace CORVINA {
4
- const block: readonly ["top", "bottom"];
5
- const inline: readonly ["start", "end", "left", "right"];
6
- type Tblock = typeof block[number];
7
- type Tinline = typeof inline[number];
8
- export type Anchor = Tblock | Tinline | 'center' | 'center center' | `${Tblock} ${Tinline | 'center'}` | `${Tinline} ${Tblock | 'center'}`;
9
- export enum TOOLTIP_LOCATION {
4
+ type AnchorBlock = 'top' | 'bottom';
5
+ type AnchorInline = 'start' | 'end' | 'left' | 'right';
6
+ type Anchor = AnchorBlock | AnchorInline | 'center' | 'center center' | `${AnchorBlock} ${AnchorInline | 'center'}` | `${AnchorInline} ${AnchorBlock | 'center'}`;
7
+ enum TOOLTIP_LOCATION {
10
8
  START = "start",
11
9
  END = "end",
12
10
  TOP = "top",
13
11
  BOTTOM = "bottom"
14
12
  }
15
- export enum COLOR {
13
+ enum COLOR {
16
14
  WT = "wt",
17
15
  G1 = "g1",
18
16
  G2 = "g2",
@@ -28,7 +26,7 @@ export declare namespace CORVINA {
28
26
  WARNING_MILD = "warning-mild",
29
27
  GOOD = "good"
30
28
  }
31
- export namespace BREADCRUMB {
29
+ namespace BREADCRUMB {
32
30
  enum ACTIVE_CONTROL {
33
31
  /** The breadcrumb show a free search */
34
32
  SEARCH = "search",
@@ -60,9 +58,9 @@ export declare namespace CORVINA {
60
58
  * Required if type is FILTER_BY_ENUM.AUTOCOMPLETE.
61
59
  */
62
60
  searchFunction?: (search: string, page: number) => Array<any> | Promise<Array<any>>;
63
- /** Property on the items returned by the `searchFunction` that contains the title. Required if type is FILTER_BY_ENUM.AUTOCOMPLETE. */
61
+ /** Property on the items returned by the `searchFunction` that contains the title, shown in the options and in the chip (`FILTER.title`). Required if type is FILTER_BY_ENUM.AUTOCOMPLETE. */
64
62
  itemsTitleKey?: string;
65
- /** Property on the items returned by the `searchFunction` that contains the identifier. Required if type is FILTER_BY_ENUM.AUTOCOMPLETE. */
63
+ /** Property on the items returned by the `searchFunction` that contains the identifier, used as `FILTER.value` of the selected item. Required if type is FILTER_BY_ENUM.AUTOCOMPLETE. */
66
64
  itemsIdKey?: string;
67
65
  /** Placeholder to display in the filter value input. */
68
66
  filterValuePlaceholder?: string;
@@ -71,8 +69,10 @@ export declare namespace CORVINA {
71
69
  interface FILTER {
72
70
  /** Unique key for the filter */
73
71
  key: string;
74
- /** Value of the filter */
75
- value: string;
72
+ /** Value of the filter: the entered text for FILTER_BY_ENUM.FREE_TEXT, the `itemsIdKey` property of the selected item for FILTER_BY_ENUM.AUTOCOMPLETE */
73
+ value: string | number;
74
+ /** Text shown in the chip instead of the value: the `itemsTitleKey` property of the selected item for FILTER_BY_ENUM.AUTOCOMPLETE */
75
+ title?: string;
76
76
  }
77
77
  interface CUSTOM_VUE_COMPONENT {
78
78
  /** Name of the Vue component or Vue component definition */
@@ -85,7 +85,7 @@ export declare namespace CORVINA {
85
85
  position?: CUSTOM_COMPONENT_POSITION;
86
86
  }
87
87
  }
88
- export namespace BUTTON {
88
+ namespace BUTTON {
89
89
  enum VARIANT {
90
90
  FREE = "FREE",
91
91
  LED = "LED",
@@ -93,7 +93,7 @@ export declare namespace CORVINA {
93
93
  OUTLINED = "OUTLINED"
94
94
  }
95
95
  }
96
- export namespace ICON {
96
+ namespace ICON {
97
97
  enum SIZE {
98
98
  X_SMALL = "x-small",
99
99
  SMALL = "small",
@@ -102,7 +102,7 @@ export declare namespace CORVINA {
102
102
  X_LARGE = "x-large"
103
103
  }
104
104
  }
105
- export namespace TABLE {
105
+ namespace TABLE {
106
106
  /** Horizontal alignment of a column (applied as `text-*` and `justify-*` classes) */
107
107
  enum ALIGN {
108
108
  START = "start",
@@ -158,6 +158,8 @@ export declare namespace CORVINA {
158
158
  label?: string;
159
159
  tooltip?: string;
160
160
  icon?: string;
161
+ /** If true the button becomes a spinner */
162
+ loading?: boolean;
161
163
  function: (item: any) => void;
162
164
  }
163
165
  type PropButtonEntries = PropButtonEntry[];
@@ -249,5 +251,4 @@ export declare namespace CORVINA {
249
251
  }
250
252
  type TableHeaderEntries = TableHeaderEntry[];
251
253
  }
252
- export {};
253
254
  }
package/package.json CHANGED
@@ -1,19 +1,30 @@
1
1
  {
2
2
  "name": "@corvina/web-components-library",
3
- "version": "0.2.0",
3
+ "version": "0.2.3",
4
4
  "private": false,
5
+ "description": "Corvina web components (custom elements)",
6
+ "homepage": "https://docs.components.corvina.cloud/",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "git+https://github.com/Corvina-R-D/corvina-components-library.git"
10
+ },
11
+ "keywords": [
12
+ "corvina",
13
+ "web-components",
14
+ "custom-elements",
15
+ "vuetify"
16
+ ],
5
17
  "main": "web-components-library.umd.js",
6
18
  "module": "web-components-library.es.js",
7
19
  "types": "web-components-library.es.d.ts",
8
20
  "files": [
9
- "*",
10
- "**/*"
21
+ "*",
22
+ "**/*"
11
23
  ],
12
24
  "dependencies": {
13
- "v3-infinite-loading": "^1.3.2",
14
- "vue": "^3.4.21",
15
- "vuetify": "^3.7.5"
25
+ "v3-infinite-loading": "^1.3.2",
26
+ "vue": "^3.4.21",
27
+ "vuetify": "^3.7.5"
16
28
  },
17
29
  "packageManager": "pnpm@9.1.1+sha1.09ada6cd05003e0ced25fb716f9fda4063ec2e3b"
18
- }
19
-
30
+ }