@kong/kongponents 9.26.2 → 9.26.3-pr.2679.3bb191ed8.0

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.
@@ -1,230 +1,10 @@
1
- import { type PropType } from 'vue';
2
- import { KUI_ICON_SIZE_60 } from '@kong/design-tokens';
3
- import KButton from '../../components/KButton/KButton.vue';
4
- import { EmptyStateIconVariants } from '../../../types';
5
- import type { EmptyStateIconVariant } from '../../../types';
6
- declare const getEmptyStateIcon: import("vue").ComputedRef<import("vue").DefineComponent<import("vue").ExtractPropTypes<{
7
- title: {
8
- type: StringConstructor;
9
- required: false;
10
- default: string;
11
- };
12
- color: {
13
- type: StringConstructor;
14
- required: false;
15
- default: string;
16
- };
17
- display: {
18
- type: StringConstructor;
19
- required: false;
20
- default: string;
21
- };
22
- decorative: {
23
- type: BooleanConstructor;
24
- required: false;
25
- default: boolean;
26
- };
27
- size: {
28
- type: (StringConstructor | NumberConstructor)[];
29
- required: false;
30
- default: "24px";
31
- validator: (sizeValue: number | string) => boolean;
32
- };
33
- as: {
34
- type: StringConstructor;
35
- required: false;
36
- default: string;
37
- };
38
- staticIds: {
39
- type: BooleanConstructor;
40
- default: boolean;
41
- };
42
- }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
43
- title: {
44
- type: StringConstructor;
45
- required: false;
46
- default: string;
47
- };
48
- color: {
49
- type: StringConstructor;
50
- required: false;
51
- default: string;
52
- };
53
- display: {
54
- type: StringConstructor;
55
- required: false;
56
- default: string;
57
- };
58
- decorative: {
59
- type: BooleanConstructor;
60
- required: false;
61
- default: boolean;
62
- };
63
- size: {
64
- type: (StringConstructor | NumberConstructor)[];
65
- required: false;
66
- default: "24px";
67
- validator: (sizeValue: number | string) => boolean;
68
- };
69
- as: {
70
- type: StringConstructor;
71
- required: false;
72
- default: string;
73
- };
74
- staticIds: {
75
- type: BooleanConstructor;
76
- default: boolean;
77
- };
78
- }>> & Readonly<{}>, {
79
- title: string;
80
- color: string;
81
- display: string;
82
- decorative: boolean;
83
- size: string | number;
84
- as: string;
85
- staticIds: boolean;
86
- }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>>;
87
- declare const getIconColor: import("vue").ComputedRef<string>;
88
- declare const __VLS_ctx: InstanceType<__VLS_PickNotAny<typeof __VLS_self, new () => {}>>;
89
- declare var __VLS_1: {}, __VLS_7: {}, __VLS_9: {}, __VLS_11: {};
90
- type __VLS_Slots = __VLS_PrettifyGlobal<__VLS_OmitStringIndex<typeof __VLS_ctx.$slots> & {
91
- icon?: (props: typeof __VLS_1) => any;
92
- } & {
93
- title?: (props: typeof __VLS_7) => any;
94
- } & {
95
- default?: (props: typeof __VLS_9) => any;
96
- } & {
97
- action?: (props: typeof __VLS_11) => any;
98
- }>;
99
- declare const __VLS_self: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
100
- title: {
101
- type: StringConstructor;
102
- default: string;
103
- };
104
- message: {
105
- type: StringConstructor;
106
- default: string;
107
- };
108
- actionButtonVisible: {
109
- type: BooleanConstructor;
110
- default: boolean;
111
- };
112
- actionButtonText: {
113
- type: StringConstructor;
114
- default: string;
115
- };
116
- actionButtonDisabled: {
117
- type: BooleanConstructor;
118
- default: boolean;
119
- };
120
- iconVariant: {
121
- type: PropType<EmptyStateIconVariant>;
122
- default: EmptyStateIconVariants;
123
- };
124
- }>, {
125
- KUI_ICON_SIZE_60: typeof KUI_ICON_SIZE_60;
126
- KButton: typeof KButton;
127
- getEmptyStateIcon: typeof getEmptyStateIcon;
128
- getIconColor: typeof getIconColor;
129
- }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
130
- "click-action": (...args: any[]) => void;
131
- }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
132
- title: {
133
- type: StringConstructor;
134
- default: string;
135
- };
136
- message: {
137
- type: StringConstructor;
138
- default: string;
139
- };
140
- actionButtonVisible: {
141
- type: BooleanConstructor;
142
- default: boolean;
143
- };
144
- actionButtonText: {
145
- type: StringConstructor;
146
- default: string;
147
- };
148
- actionButtonDisabled: {
149
- type: BooleanConstructor;
150
- default: boolean;
151
- };
152
- iconVariant: {
153
- type: PropType<EmptyStateIconVariant>;
154
- default: EmptyStateIconVariants;
155
- };
156
- }>> & Readonly<{
157
- "onClick-action"?: ((...args: any[]) => any) | undefined;
158
- }>, {
159
- title: string;
160
- message: string;
161
- actionButtonVisible: boolean;
162
- actionButtonText: string;
163
- actionButtonDisabled: boolean;
164
- iconVariant: "search" | "default" | "error" | "kong";
165
- }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
166
- declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
167
- title: {
168
- type: StringConstructor;
169
- default: string;
170
- };
171
- message: {
172
- type: StringConstructor;
173
- default: string;
174
- };
175
- actionButtonVisible: {
176
- type: BooleanConstructor;
177
- default: boolean;
178
- };
179
- actionButtonText: {
180
- type: StringConstructor;
181
- default: string;
182
- };
183
- actionButtonDisabled: {
184
- type: BooleanConstructor;
185
- default: boolean;
186
- };
187
- iconVariant: {
188
- type: PropType<EmptyStateIconVariant>;
189
- default: EmptyStateIconVariants;
190
- };
191
- }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
192
- "click-action": (...args: any[]) => void;
193
- }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
194
- title: {
195
- type: StringConstructor;
196
- default: string;
197
- };
198
- message: {
199
- type: StringConstructor;
200
- default: string;
201
- };
202
- actionButtonVisible: {
203
- type: BooleanConstructor;
204
- default: boolean;
205
- };
206
- actionButtonText: {
207
- type: StringConstructor;
208
- default: string;
209
- };
210
- actionButtonDisabled: {
211
- type: BooleanConstructor;
212
- default: boolean;
213
- };
214
- iconVariant: {
215
- type: PropType<EmptyStateIconVariant>;
216
- default: EmptyStateIconVariants;
217
- };
218
- }>> & Readonly<{
219
- "onClick-action"?: ((...args: any[]) => any) | undefined;
220
- }>, {
221
- title: string;
222
- message: string;
223
- actionButtonVisible: boolean;
224
- actionButtonText: string;
225
- actionButtonDisabled: boolean;
226
- iconVariant: "search" | "default" | "error" | "kong";
227
- }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
1
+ import type { EmptyStateProps, EmptyStateSlots } from '../../../types';
2
+ type __VLS_Slots = EmptyStateSlots;
3
+ declare const __VLS_component: import("vue").DefineComponent<EmptyStateProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
4
+ "click-action": () => any;
5
+ }, string, import("vue").PublicProps, Readonly<EmptyStateProps> & Readonly<{
6
+ "onClick-action"?: (() => any) | undefined;
7
+ }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
228
8
  declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
229
9
  export default _default;
230
10
  type __VLS_WithSlots<T, S> = T & {
@@ -4,4 +4,58 @@ export declare enum EmptyStateIconVariants {
4
4
  Search = "search",
5
5
  Kong = "kong"
6
6
  }
7
+ export interface EmptyStateProps {
8
+ /**
9
+ * The title of the empty state
10
+ */
11
+ title?: string;
12
+ /**
13
+ * The message of the empty state
14
+ */
15
+ message?: string;
16
+ /**
17
+ * When true, shows action button
18
+ * @default true
19
+ */
20
+ actionButtonVisible?: boolean;
21
+ /**
22
+ * Text within action button
23
+ */
24
+ actionButtonText?: string;
25
+ /**
26
+ * When true, disable the action button
27
+ * @default false
28
+ */
29
+ actionButtonDisabled?: boolean;
30
+ /**
31
+ * Type of the icon in empty state
32
+ * One of ['default', 'error', 'search', 'kong']
33
+ * @default 'default'
34
+ */
35
+ iconVariant?: EmptyStateIconVariant;
36
+ }
37
+ export interface EmptyStateEmits {
38
+ /**
39
+ * Emitted when dismiss button is clicked.
40
+ */
41
+ 'click-action': [];
42
+ }
43
+ export interface EmptyStateSlots {
44
+ /**
45
+ * Slot for empty state content.
46
+ */
47
+ default?(): any;
48
+ /**
49
+ * Slot for custom icon of the empty state.
50
+ */
51
+ icon?(): any;
52
+ /**
53
+ * Slot for custom title of the empty state.
54
+ */
55
+ title?(): any;
56
+ /**
57
+ * Slot for custom action area of the empty state.
58
+ */
59
+ action?(): any;
60
+ }
7
61
  export type EmptyStateIconVariant = `${EmptyStateIconVariants}`;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kong/kongponents",
3
- "version": "9.26.2",
3
+ "version": "9.26.3-pr.2679.3bb191ed8.0",
4
4
  "description": "Kong Component library",
5
5
  "type": "module",
6
6
  "repository": {
@@ -26,33 +26,6 @@
26
26
  "./package.json": "./package.json",
27
27
  "./dist/*": "./dist/*"
28
28
  },
29
- "scripts": {
30
- "build:cli": "rimraf ./bin && tsc --project ./cli/tsconfig.json && chmod u+x ./bin/index.js",
31
- "build:docs": "vitepress build docs",
32
- "build:kongponents": "pnpm typecheck && vite build && vue-tsc -p './tsconfig.build.json' --emitDeclarationOnly && tsc-alias -p './tsconfig.build.json'",
33
- "build:visualize": "cross-env-shell BUILD_VISUALIZER=true vite build -m production",
34
- "build": "pnpm build:cli && pnpm stylelint && pnpm lint && pnpm build:kongponents && pnpm build:docs",
35
- "build:ci": "pnpm build:kongponents && pnpm build:docs",
36
- "commit": "cz",
37
- "create-kongponent": "node ./bin/index.js",
38
- "sandbox:dev": "cross-env USE_SANDBOX=true vite",
39
- "sandbox:build": "cross-env USE_SANDBOX=true vite build && shx cp sandbox/dist/index.html sandbox/dist/404.html",
40
- "sandbox:build:netlify": "cross-env USE_SANDBOX=true USE_NETLIFY=true vite build && shx cp sandbox/dist/index.html sandbox/dist/404.html",
41
- "sandbox:preview": "cross-env USE_SANDBOX=true vite preview",
42
- "docs:build": "vitepress build docs",
43
- "docs:dev": "vitepress dev docs",
44
- "docs:serve": "vitepress serve docs",
45
- "docs:preview": "vitepress preview docs --port 8080",
46
- "typecheck": "vue-tsc -p './tsconfig.build.json' --noEmit",
47
- "lint": "eslint",
48
- "lint:fix": "eslint --fix",
49
- "stylelint": "stylelint './src/**/*.{css,scss,sass,vue}'",
50
- "stylelint:fix": "stylelint './src/**/*.{css,scss,sass,vue}' --fix",
51
- "test": "cypress run --component -b chrome",
52
- "test:open": "cypress open --component -b chrome",
53
- "test:spec": "cypress run --component -b chrome --spec",
54
- "semantic-release": "semantic-release"
55
- },
56
29
  "dependencies": {
57
30
  "@floating-ui/vue": "^1.1.6",
58
31
  "@kong/icons": "^1.22.1",
@@ -183,7 +156,6 @@
183
156
  "engines": {
184
157
  "node": ">=v16.20.2 || >=18.12.1 || >=20.14.0"
185
158
  },
186
- "packageManager": "pnpm@9.11.0",
187
159
  "volta": {
188
160
  "node": "20.17.0",
189
161
  "pnpm": "9.11.0"
@@ -197,5 +169,32 @@
197
169
  "jiraPrepend": "[",
198
170
  "jiraAppend": "]"
199
171
  }
172
+ },
173
+ "scripts": {
174
+ "build:cli": "rimraf ./bin && tsc --project ./cli/tsconfig.json && chmod u+x ./bin/index.js",
175
+ "build:docs": "vitepress build docs",
176
+ "build:kongponents": "pnpm typecheck && vite build && vue-tsc -p './tsconfig.build.json' --emitDeclarationOnly && tsc-alias -p './tsconfig.build.json'",
177
+ "build:visualize": "cross-env-shell BUILD_VISUALIZER=true vite build -m production",
178
+ "build": "pnpm build:cli && pnpm stylelint && pnpm lint && pnpm build:kongponents && pnpm build:docs",
179
+ "build:ci": "pnpm build:kongponents && pnpm build:docs",
180
+ "commit": "cz",
181
+ "create-kongponent": "node ./bin/index.js",
182
+ "sandbox:dev": "cross-env USE_SANDBOX=true vite",
183
+ "sandbox:build": "cross-env USE_SANDBOX=true vite build && shx cp sandbox/dist/index.html sandbox/dist/404.html",
184
+ "sandbox:build:netlify": "cross-env USE_SANDBOX=true USE_NETLIFY=true vite build && shx cp sandbox/dist/index.html sandbox/dist/404.html",
185
+ "sandbox:preview": "cross-env USE_SANDBOX=true vite preview",
186
+ "docs:build": "vitepress build docs",
187
+ "docs:dev": "vitepress dev docs",
188
+ "docs:serve": "vitepress serve docs",
189
+ "docs:preview": "vitepress preview docs --port 8080",
190
+ "typecheck": "vue-tsc -p './tsconfig.build.json' --noEmit",
191
+ "lint": "eslint",
192
+ "lint:fix": "eslint --fix",
193
+ "stylelint": "stylelint './src/**/*.{css,scss,sass,vue}'",
194
+ "stylelint:fix": "stylelint './src/**/*.{css,scss,sass,vue}' --fix",
195
+ "test": "cypress run --component -b chrome",
196
+ "test:open": "cypress open --component -b chrome",
197
+ "test:spec": "cypress run --component -b chrome --spec",
198
+ "semantic-release": "semantic-release"
200
199
  }
201
- }
200
+ }