sit-onyx 1.0.0-beta.145 → 1.0.0-beta.147

package/dist/components/OnyxDataGrid/features/all.d.ts

@@ -1,2 +1,4 @@
+export * from "./selection/types";
 export * from "./sorting/types";
+export { useSelection } from "./selection/selection";
 export { useSorting } from "./sorting/sorting";

package/dist/components/OnyxDataGrid/features/selection/TestCase.vue.d.ts

@@ -0,0 +1,21 @@
+import type { OnyxDataGridProps } from "../../../..";
+import { DataGridFeatures } from "../../../..";
+export type TransferableEmit = Omit<DataGridFeatures.SelectionState, "contingent"> & {
+    contingent: PropertyKey[];
+};
+type __VLS_Props = {
+    /**
+     * props passed through to DataGrid
+     */
+    dataGrid: Pick<OnyxDataGridProps<any, any, any, any>, "columns" | "data">;
+    /**
+     * props passed through to the feature
+     */
+    selectionOption: DataGridFeatures.SelectionOptions;
+};
+declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    selectionChange: (selectionState: TransferableEmit) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onSelectionChange?: ((selectionState: TransferableEmit) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/OnyxDataGrid/features/selection/selection.d.ts

@@ -0,0 +1,35 @@
+import { type Ref } from "vue";
+import type { DataGridEntry } from "../../types";
+import "./selection.scss";
+import type { SelectionOptions, SelectionState } from "./types";
+export declare const SELECTION_FEATURE: unique symbol;
+export declare const SELECTION_COLUMN: unique symbol;
+export declare const useSelection: <TEntry extends DataGridEntry>(options?: SelectionOptions) => {
+    name: symbol;
+    watch: (Readonly<Ref<boolean, boolean>> | Ref<SelectionState, SelectionState>)[];
+    modifyColumns: {
+        func: (columnConfig: readonly import("..").NormalizedColumnConfig<TEntry, PropertyKey>[]) => import("..").NormalizedColumnConfig<TEntry, PropertyKey>[];
+    };
+    typeRenderer: {
+        [SELECTION_COLUMN]: {
+            header: {
+                thAttributes: {
+                    class: string;
+                };
+                component: () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+                    [key: string]: any;
+                }>;
+            };
+            cell: {
+                tdAttributes: {
+                    class: {
+                        "onyx-data-grid-selection-cell": boolean;
+                    };
+                };
+                component: ({ row }: import("vue").TdHTMLAttributes & import("../../OnyxDataGridRenderer/types.ts").DataGridRendererCellComponentProps<any, import("../../types").DataGridMetadata> & {}) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+                    [key: string]: any;
+                }>;
+            };
+        };
+    };
+};

package/dist/components/OnyxDataGrid/features/selection/types.d.ts

@@ -0,0 +1,42 @@
+import { type MaybeRef, type MaybeRefOrGetter } from "vue";
+import type { DataGridEntry } from "../../types";
+export type SelectionState = {
+    /**
+     * If the `contingent` set refers to entries that are included in the final selection or excluded from it.
+     * The `selectMode` is closely coupled with the `HeaderSelectionCheckbox` which is used to "select all" or "deselect all".
+     * It allows for tracking selections even when not all rows are known.
+     * This especially useful in case of pagination or asynchronous data loading.
+     *
+     * Based on this there are the following scenarios:
+     *
+     * | selectMode | selected.size |      result      | HeaderSelectionCheckbox |
+     * |------------|:-------------:|:----------------:|-------------------------|
+     * | "include"  |      == 0     | nothing selected | unchecked               |
+     * | "include"  |       > 0     |   some selected  | indeterminate           |
+     * | "exclude"  |      == 0     |   all selected   | checked                 |
+     * | "exclude"  |       > 0     |   some selected  | indeterminate           |
+     *
+     */
+    selectMode: "include" | "exclude";
+    /**
+     * The entries that are included or excluded from the selection, based on `selectMode`.
+     */
+    contingent: Set<DataGridEntry["id"]>;
+};
+/**
+ * The options of the selection feature for the OnyxDataGrid component.
+ */
+export type SelectionOptions = {
+    /**
+     * The currently active selection.
+     */
+    selectionState?: MaybeRef<SelectionState>;
+    /**
+     * If the row selection column is shown or not.
+     */
+    disabled?: MaybeRefOrGetter<boolean>;
+    /**
+     * If `true` the selection checkbox of a row will only be shown if the row is hovered or selected.
+     */
+    hover?: MaybeRefOrGetter<boolean>;
+};

package/dist/components/examples/DataGrid/SelectionDataGrid.vue.d.ts

@@ -0,0 +1,13 @@
+import { DataGridFeatures } from "../../..";
+import type { SelectionState } from "../../OnyxDataGrid/features/selection/types";
+type __VLS_Props = {
+    hover?: boolean;
+    disabled?: boolean;
+    selectionState?: SelectionState;
+};
+declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:selectionState": (data: DataGridFeatures.SelectionState) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onUpdate:selectionState"?: ((data: DataGridFeatures.SelectionState) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/i18n/locales/de-DE.json

@@ -6,6 +6,12 @@
     "close": "Schließen",
     "dataGrid": {
         "head": {
+            "selection": {
+                "selectAll": "Alle Zeilen auswählen",
+                "deselectAll": "Alle Zeilen abwählen",
+                "select": "Hinzufügen der Zeile mit ID '{id}' zu der Auswahl.",
+                "deselect": "Entfernen der Zeile mit ID '{id}' von der Auswahl."
+            },
             "sorting": {
                 "action": {
                     "asc": "Tabelle aufsteigend nach der Spalte {field} sortieren.",

package/dist/i18n/locales/en-US.json

@@ -6,6 +6,12 @@
     "close": "Close",
     "dataGrid": {
         "head": {
+            "selection": {
+                "selectAll": "Select all rows",
+                "deselectAll": "Deselect all rows",
+                "select": "Add row with ID '{id}' to the selection.",
+                "deselect": "Remove row with ID '{id}' from the selection."
+            },
             "sorting": {
                 "action": {
                     "asc": "Sort the table ascending by the {field} column.",