sit-onyx 1.0.0-beta.232 → 1.0.0-beta.233

package/dist/components/OnyxDataGrid/examples/SkeletonExample.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export default _default;

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

@@ -1,9 +1,30 @@
+import type { ComputedRef } from "vue";
 export declare const BASE_FEATURE_SYMBOL: unique symbol;
+export type BaseFeatureOptions = {
+    skeleton: ComputedRef<number | boolean>;
+};
 /**
  * The Base feature includes everything that should be provided as built-in functionality of the `OnyxDataGrid` component.
  */
-export declare const BASE_FEATURE: {
+export declare const BASE_FEATURE: ({ skeleton }: BaseFeatureOptions) => {
     readonly name: typeof BASE_FEATURE_SYMBOL;
+    readonly modifyColumns: {
+        readonly func: (columns: readonly import("..").InternalColumnConfig<any, any>[]) => {
+            type: {
+                name: string;
+            };
+            key: string | number | symbol;
+            width?: string | undefined;
+            columnGroupKey?: string | number | symbol | undefined;
+            tdAttributes?: import("vue").TdHTMLAttributes;
+            thAttributes?: import("vue").ThHTMLAttributes;
+            label: string;
+        }[] | import("..").InternalColumnConfig<any, any>[];
+    };
+    readonly mutation: {
+        readonly func: (rows: Readonly<any>[]) => {}[];
+    };
+    readonly watch: [ComputedRef<number | boolean>];
     readonly typeRenderer: {
         readonly number: Readonly<import("..").TypeRenderer<import("../../types").DataGridEntry, import("../renderer").NumberCellOptions>>;
         readonly string: Readonly<import("..").TypeRenderer<import("../../types").DataGridEntry, import("../renderer").StringCellOptions>>;
@@ -11,5 +32,6 @@ export declare const BASE_FEATURE: {
         readonly "datetime-local": Readonly<import("..").TypeRenderer<import("../../types").DataGridEntry, import("../renderer").DateCellOptions>>;
         readonly time: Readonly<import("..").TypeRenderer<import("../../types").DataGridEntry, import("../renderer").DateCellOptions>>;
         readonly timestamp: Readonly<import("..").TypeRenderer<import("../../types").DataGridEntry, import("../renderer").DateCellOptions>>;
+        readonly skeleton: Readonly<import("..").TypeRenderer<import("../../types").DataGridEntry, import("../renderer").StringCellOptions>>;
     };
 };

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

@@ -35,7 +35,7 @@ export type TypeRenderMap<TEntry extends DataGridEntry, TKey extends PropertyKey
 /**
  * ColumnConfig as it can be defined by the user.
  */
-export type ColumnConfig<TEntry extends DataGridEntry, TColumnGroup extends ColumnGroupConfig = Record<string, never>, TTypes extends ColumnConfigTypeOption<PropertyKey, unknown> = never> = keyof TEntry | PublicNormalizedColumnConfig<TEntry, TColumnGroup, TTypes | RenderTypesFromFeature<[typeof BASE_FEATURE]>>;
+export type ColumnConfig<TEntry extends DataGridEntry, TColumnGroup extends ColumnGroupConfig = Record<string, never>, TTypes extends ColumnConfigTypeOption<PropertyKey, unknown> = never> = keyof TEntry | PublicNormalizedColumnConfig<TEntry, TColumnGroup, TTypes | RenderTypesFromFeature<[ReturnType<typeof BASE_FEATURE>]>>;
 export type DefaultSupportedTypes = "string" | "number" | DatetimeFormat;
 /**
  * Configuration for the column groupings.

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

@@ -42,6 +42,7 @@ export declare const DATE_RENDERER: Readonly<TypeRenderer<DataGridEntry, DateCel
 export declare const DATETIME_RENDERER: Readonly<TypeRenderer<DataGridEntry, DateCellOptions>>;
 export declare const TIME_RENDERER: Readonly<TypeRenderer<DataGridEntry, DateCellOptions>>;
 export declare const TIMESTAMP_RENDERER: Readonly<TypeRenderer<DataGridEntry, DateCellOptions>>;
+export declare const SKELETON_RENDERER: Readonly<TypeRenderer<DataGridEntry, StringCellOptions>>;
 export declare const createRenderer: <TEntry extends DataGridEntry>(features: DataGridFeature<TEntry, TypeRenderMap<TEntry>, symbol>[]) => {
     /**
      * Returns a renderer for any given component and type.

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

@@ -1,3 +1,4 @@
+import type { SkeletonInjected } from "src/composables/useSkeletonState";
 import type { IfExtends, IfNotEmpty, MaybePick, RecordValues, UnionByKey } from "../../types";
 import type { ColumnConfig, ColumnConfigTypeOption, ColumnGroupConfig, DataGridFeature, TypeRenderer, TypeRenderMap } from "./features";
 import type { BASE_FEATURE } from "./features/base/base";
@@ -17,7 +18,7 @@ export type RenderTypesFromFeature<TFeatures extends DataGridFeature<any, any, a
  * @experimental The DataGrid is still working in progress and the props will change in the future.
  */
 export type OnyxDataGridProps<TEntry extends DataGridEntry, TColumnGroup extends ColumnGroupConfig, TTypeRenderer extends TypeRenderMap<TEntry>, TFeatureName extends symbol, TFeatures extends DataGridFeature<TEntry, TTypeRenderer, TFeatureName>[] = never, TTypes extends ColumnConfigTypeOption<PropertyKey, unknown> = RenderTypesFromFeature<[
-    typeof BASE_FEATURE,
+    ReturnType<typeof BASE_FEATURE>,
     ...TFeatures
 ]>> = {
     /**
@@ -39,6 +40,10 @@ export type OnyxDataGridProps<TEntry extends DataGridEntry, TColumnGroup extends
      * The data that should be used to fill the datagrid.
      */
     data: TEntry[];
+    /**
+     *  Whether to show skeleton rows. Can be set to `true` to use a pre-defined skeleton row count or you can pass a number tospecific the count.
+     */
+    skeleton?: SkeletonInjected;
 };
 /**
  * "Raw" user data for a data grid entry/row, e.g. fetched from a backend service.

package/dist/components/OnyxTable/examples/OnyxTableSkeletonExample.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export default _default;