@fkui/vue 6.37.0 → 6.38.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.
@@ -42,6 +42,7 @@ import { ShallowRef } from 'vue';
42
42
  import { Slot } from 'vue';
43
43
  import { Slots } from 'vue';
44
44
  import { StackHandle } from '@fkui/logic';
45
+ import { TranslateFunction } from '@fkui/logic';
45
46
  import { UnwrapRef } from 'vue';
46
47
  import { UnwrapRefSimple } from '@vue/reactivity';
47
48
  import { ValidatableHTMLElement } from '@fkui/logic';
@@ -6848,73 +6849,7 @@ rotate: string;
6848
6849
  }, {}, string, ComponentProvideOptions, true, {}, any>;
6849
6850
 
6850
6851
  declare const __VLS_export_47: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal_8<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
6851
- props: PublicProps & __VLS_PrettifyLocal_8<ExtractPublicPropTypes< {
6852
- /**
6853
- * The data that you wish to sort or filter.
6854
- */
6855
- data: {
6856
- type: PropType<T[]>;
6857
- required: boolean;
6858
- };
6859
- /**
6860
- * All the attributes you want to enable sorting for and the corresponding name to display in the dropdown.
6861
- * Structured as `{attributeName: "Name for dropdown", secondAttributeName: "Name for dropdown"}`
6862
- */
6863
- sortableAttributes: {
6864
- type: PropType<Record<string, string | Readonly<Ref<string>>>>;
6865
- required: boolean;
6866
- };
6867
- /**
6868
- * If set the data will be sorted by this attribute by default.
6869
- */
6870
- defaultSortAttribute: {
6871
- type: StringConstructor;
6872
- required: boolean;
6873
- default: () => string;
6874
- };
6875
- /**
6876
- * Show/hides the sort dropdown.
6877
- */
6878
- showSort: {
6879
- type: BooleanConstructor;
6880
- required: boolean;
6881
- default: boolean;
6882
- };
6883
- /**
6884
- * Show/hides the filter input.
6885
- */
6886
- showFilter: {
6887
- type: BooleanConstructor;
6888
- required: boolean;
6889
- default: boolean;
6890
- };
6891
- /**
6892
- * Set placeholder text in filter input field.
6893
- * Default is textkey "fkui.sort-filter-dataset.placeholder.filter"
6894
- */
6895
- placeholderFilter: {
6896
- type: StringConstructor;
6897
- required: boolean;
6898
- default: string;
6899
- };
6900
- /**
6901
- * The order the data will be sorted by if defaultSortAttribute has been set.
6902
- */
6903
- defaultSortAscending: {
6904
- type: BooleanConstructor;
6905
- required: boolean;
6906
- default: () => boolean;
6907
- };
6908
- /**
6909
- * Attributes that should be included in search when filtering by input.
6910
- * Default includes all attributes.
6911
- */
6912
- filterAttributes: {
6913
- type: PropType<string[]>;
6914
- required: boolean;
6915
- default: undefined;
6916
- };
6917
- }> & {
6852
+ props: PublicProps & __VLS_PrettifyLocal_8<FSortFilterDatasetProps<T> & {
6918
6853
  onDatasetSorted?: ((items: T[]) => any) | undefined;
6919
6854
  onUsedSortAttributes?: ((sortAttribute: SortOrder) => any) | undefined;
6920
6855
  }> & (typeof globalThis extends {
@@ -18204,7 +18139,7 @@ export declare const FSortFilterDataset: typeof __VLS_export_47;
18204
18139
  *
18205
18140
  * @public
18206
18141
  */
18207
- export declare function FSortFilterDatasetInjected(): FSortFilterDatasetInterface;
18142
+ export declare function FSortFilterDatasetInjected<TKeys = PropertyKey>(): FSortFilterDatasetInterface<TKeys>;
18208
18143
 
18209
18144
  /**
18210
18145
  * This interface can be implemented (provided) by Vue components
@@ -18212,35 +18147,73 @@ export declare function FSortFilterDatasetInjected(): FSortFilterDatasetInterfac
18212
18147
  *
18213
18148
  * @public
18214
18149
  */
18215
- export declare interface FSortFilterDatasetInterface {
18150
+ export declare interface FSortFilterDatasetInterface<TKeys = PropertyKey> {
18216
18151
  /**
18217
18152
  * Sort the dataset
18218
18153
  * @param attribute - is the field that gets sorted
18219
18154
  * @param ascending - is the order the fields get sorted
18220
18155
  */
18221
- sort(this: void, attribute: string, ascending: boolean): void;
18156
+ sort(this: void, attribute: TKeys, ascending: boolean): void;
18222
18157
  /**
18223
18158
  * Callback function that is called when dataset get sorted
18224
18159
  */
18225
- registerCallbackOnSort(this: void, callback: FSortFilterDatasetSortCallback): void;
18160
+ registerCallbackOnSort(this: void, callback: FSortFilterDatasetSortCallback<TKeys>): void;
18226
18161
  /**
18227
18162
  * Called when FSortFilterDataset is mounted.
18228
18163
  * Returns the sortable field names.
18229
18164
  */
18230
- registerCallbackOnMount(this: void, callback: FSortFilterDatasetMountCallback): void;
18165
+ registerCallbackOnMount(this: void, callback: FSortFilterDatasetMountCallback<TKeys>): void;
18231
18166
  }
18232
18167
 
18233
18168
  /**
18234
18169
  * @public
18235
18170
  */
18236
- export declare type FSortFilterDatasetMountCallback = (columnNames: string[]) => void;
18171
+ export declare type FSortFilterDatasetMountCallback<TKeys = PropertyKey> = (columnNames: TKeys[]) => void;
18172
+
18173
+ declare interface FSortFilterDatasetProps<T> {
18174
+ /**
18175
+ * The data that you wish to sort or filter.
18176
+ */
18177
+ data: T[];
18178
+ /**
18179
+ * All the attributes you want to enable sorting for and the corresponding name to display in the dropdown.
18180
+ * Structured as `{attributeName: "Name for dropdown", secondAttributeName: "Name for dropdown"}`
18181
+ */
18182
+ sortableAttributes: Record<PropertyKey, string | Readonly<Ref<string>>>;
18183
+ /**
18184
+ * If set the data will be sorted by this attribute by default.
18185
+ */
18186
+ defaultSortAttribute?: PropertyKey;
18187
+ /**
18188
+ * Show/hides the sort dropdown.
18189
+ */
18190
+ showSort?: boolean;
18191
+ /**
18192
+ * Show/hides the filter input.
18193
+ */
18194
+ showFilter?: boolean;
18195
+ /**
18196
+ * Set placeholder text in filter input field.
18197
+ * Default is textkey "fkui.sort-filter-dataset.placeholder.filter"
18198
+ */
18199
+ placeholderFilter?: string;
18200
+ /**
18201
+ * The order the data will be sorted by if defaultSortAttribute has been set.
18202
+ */
18203
+ defaultSortAscending?: boolean;
18204
+ /**
18205
+ * Attributes that should be included in search when filtering by input.
18206
+ * Default includes all attributes.
18207
+ */
18208
+ filterAttributes?: PropertyKey[];
18209
+ }
18237
18210
 
18238
18211
  /**
18239
18212
  * @public
18240
18213
  * @param attribute - is the field that got sorted
18241
18214
  * @param ascending - is the order the fields got sorted
18242
18215
  */
18243
- export declare type FSortFilterDatasetSortCallback = (attribute: string, ascending: boolean) => void;
18216
+ export declare type FSortFilterDatasetSortCallback<TKeys = PropertyKey> = (attribute: TKeys, ascending: boolean) => void;
18244
18217
 
18245
18218
  export declare const FStaticField: typeof __VLS_export_48;
18246
18219
 
@@ -18253,7 +18226,7 @@ export declare const FTableColumn: typeof __VLS_export_50;
18253
18226
  */
18254
18227
  export declare interface FTableColumnData {
18255
18228
  id: string;
18256
- name?: string;
18229
+ name?: PropertyKey;
18257
18230
  title: string;
18258
18231
  description?: string;
18259
18232
  size: FTableColumnSize;
@@ -19056,7 +19029,7 @@ export declare function setRunningContext(app: App): void;
19056
19029
  * @public
19057
19030
  */
19058
19031
  export declare interface SortOrder {
19059
- attribute: string;
19032
+ attribute: PropertyKey;
19060
19033
  name: string;
19061
19034
  ascendingName: string;
19062
19035
  ascending: boolean;
@@ -19112,44 +19085,7 @@ export declare interface TextFieldSetupProps {
19112
19085
  }
19113
19086
 
19114
19087
  /* Excluded from this release type: tooltipAttachTo */
19115
-
19116
- /**
19117
- * @public
19118
- */
19119
- export declare interface TranslateFunction {
19120
- /**
19121
- * Returns the translation for the key.
19122
- *
19123
- * @param key - The translation key.
19124
- */
19125
- (key: string): string;
19126
- /**
19127
- * Returns the translation for the key or the default value if no
19128
- * translation exists.
19129
- *
19130
- * @param key - The translation key.
19131
- * @param defaultValue - The default value.
19132
- */
19133
- (key: string, defaultValue: string): string;
19134
- /**
19135
- * Returns the translation for the key. The translation is interpolated
19136
- * with the given arguments.
19137
- *
19138
- * @param key - The translation key.
19139
- * @param args - The interpolation arguments.
19140
- */
19141
- (key: string, args: Record<string, unknown>): string;
19142
- /**
19143
- * Returns the translation for the key or the default value if no
19144
- * translation exists. The translation is interpolated with the given
19145
- * arguments.
19146
- *
19147
- * @param key - The translation key.
19148
- * @param defaultValue - The default value.
19149
- * @param args - The interpolation arguments.
19150
- */
19151
- (key: string, defaultValue: string, args: Record<string, unknown>): string;
19152
- }
19088
+ export { TranslateFunction }
19153
19089
 
19154
19090
  /**
19155
19091
  * @public
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.56.3"
8
+ "packageVersion": "7.57.3"
9
9
  }
10
10
  ]
11
11
  }
@@ -125,6 +125,9 @@ module.exports = defineMetadata({
125
125
  size: {
126
126
  enum: ["small", "medium", "large"],
127
127
  },
128
+ type: {
129
+ enum: ["submit", "reset", "button"],
130
+ },
128
131
  "icon-left": {
129
132
  allowed: allowedIfAttributeIsAbsent("icon-right"),
130
133
  enum: ["/.+/"],
@@ -148,6 +151,12 @@ module.exports = defineMetadata({
148
151
  "mobile-full-width": {
149
152
  boolean: true,
150
153
  },
154
+ variant: {
155
+ enum: ["primary", "secondary", "tertiary"],
156
+ },
157
+ },
158
+ submitButton(node) {
159
+ return node.getAttribute("type") === "submit";
151
160
  },
152
161
  },
153
162
 
@@ -37,6 +37,11 @@ const deprecatedClasses = [
37
37
  "Stacked icons are no longer used for file item links.",
38
38
  url: "/components/file-upload/ffileitem.html",
39
39
  },
40
+ {
41
+ name: "icon--stack",
42
+ replacement: "icon-stack",
43
+ url: "/components/ficon.html",
44
+ },
40
45
  ];
41
46
 
42
47
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fkui/vue",
3
- "version": "6.37.0",
3
+ "version": "6.38.0",
4
4
  "description": "Vue implementation of FKUI components",
5
5
  "keywords": [
6
6
  "fkui",
@@ -66,9 +66,9 @@
66
66
  "unit:watch": "jest --watch"
67
67
  },
68
68
  "peerDependencies": {
69
- "@fkui/date": "^6.37.0",
70
- "@fkui/design": "^6.37.0",
71
- "@fkui/logic": "^6.37.0",
69
+ "@fkui/date": "^6.38.0",
70
+ "@fkui/design": "^6.38.0",
71
+ "@fkui/logic": "^6.38.0",
72
72
  "fk-icons": "^4.30.1",
73
73
  "html-validate": ">= 7.9.0",
74
74
  "vue": "^3.5.0"
@@ -85,5 +85,5 @@
85
85
  "node": ">= 20",
86
86
  "npm": ">= 7"
87
87
  },
88
- "gitHead": "15bcc047ba64657946b3e429cbf68abae064ebcc"
88
+ "gitHead": "ea8e50d8567159581a628106e93ac0e7c1d43a1b"
89
89
  }