@omnia/fx 8.0.253-dev → 8.0.254-dev

package/internal-do-not-import-from-here/ux/docs/Docs.d.ts

@@ -72,7 +72,7 @@ export declare class Docs {
     static categories: Array<DocumentationCategory>;
     static addArea(area: DocumentationArea): void;
     static addCategory(category: DocumentationCategory): void;
-    static specBuilder(name: string): DocumentationSpec;
+    static specBuilder(name: string, alias?: string): DocumentationSpec;
     static velcronSpecBuilder(name: string): VelcronComponentSpec;
     static registerComponent(spec: DocumentationSpec, area: DocumentationArea, category: DocumentationCategory): void;
 }
@@ -93,6 +93,7 @@ export interface VelcronExampleDefinitionSpec {
 }
 export declare class DocumentationSpec {
     private name;
+    private alias?;
     private typeValueMapping;
     private exampleComponents;
     markdownSections: Array<MarkdownSection>;
@@ -103,12 +104,13 @@ export declare class DocumentationSpec {
     events: EventSpec[];
     slots: SlotSpec[];
     id: string;
-    constructor(name: string);
+    constructor(name: string, alias?: string);
     addTypeValueMapping(name: string, value: string | string[] | any): DocumentationSpec;
     addTheming(): DocumentationSpec;
     addToned(): DocumentationSpec;
     addCssClass(): DocumentationSpec;
     getName(): string;
+    getAlias(): string;
     getId(): string;
     addApiProperty(propertySpec: PropertySpec): DocumentationSpec;
     addApiProperty(name: string, description: string, type: string, defaultValue?: string): DocumentationSpec;

package/internal-do-not-import-from-here/ux/oxide/datatable/DataTable.d.ts

@@ -12,7 +12,7 @@ export type DataTableOptions = {
     itemsPerPage: number;
     sortBy: SortItem[];
 };
-export type DataTablePropsBase<T> = DefinePropTheming & DefineProp<"class", String | String[]> & DefineVModel<"expanded", Array<string>, false, null, false, "Whether the item is expanded or not."> & DefineVModel<"sortBy", SortItem[], false, null, false, "Changes which item property (or properties) should be used for sort order."> & DefineProp<"mustSort", boolean, false, false, "If true then one can not disable sorting, it will always switch between ascending and descending."> & DefineProp<"showSelect", boolean, false, false, "Shows a checkbox for each row."> & DefineProp<"itemSelectable", SelectItemKey<T>, false, false, "SProperty on supplied items that indicates whether the item is selectable."> & DefineProp<"height", string | number, false, null, "Sets and explicit height of the tablet."> & DefineProp<"noDataText", string, false, null, "Text shown when no items are provided to the component."> & DefineProp<"itemValue", ItemValueType<T>, false, null, "Property on supplied items that contains its value."> & DefineProp<"loading", boolean, false, false, "Displays linear progress bar."> & DefineProp<"drag", boolean, false, false, "Enable draggable row."> & DefineProp<"hover", boolean, false, false, "Property on supplied items that contains its value."> & DefineProp<"showExpand", boolean, false, false, "Shows the expand toggle in default rows."> & DefineProp<"headers", DataTableHeader[], false, typeof defaultHeaders, "An array of objects that each describe a header column."> & DefineVModel<"items", T[], false, typeof defaultItems, true, "An array of strings or objects used for automatically generating children components."> & DefineEmit<"update:expanded", (expanded: string[]) => void, "Emits when the expanded property of the options prop is updated."> & DefineEmit<"update:sortBy", (sort: SortItem[]) => void, "Emits when the sortBy property of the options prop is updated."> & DefineEmit<"update:options", (options: DataTableOptions) => void, "Emits when one of the options properties is updated."> & DefineEmit<"update:page", (page: number) => void, "Emits when the page property of the options prop is updated."> & DefineEmit<"update:itemsPerPage", (value: number) => void, "Emits when the items-per-page property of the options prop is updated."> & DefineEmit<"click:loadMore", () => void> & DefineSlot<"item", (row: IDataTableRowRenderer<T>) => void, "Deprecated, Use slot row instead."> & DefineSlot<"row", (row: IDataTableRow<T>) => VNodeChild> & DefineSlot<`header.${string}`, (header: DataTableHeader) => void> & DefineSlot<`item.${string}`, (e: {
+export type DataTablePropsBase<T> = DefinePropTheming & DefineProp<"class", String | String[]> & DefineVModel<"expanded", Array<string>, false, null, false, "Whether the item is expanded or not."> & DefineVModel<"sortBy", SortItem[], false, null, false, "Changes which item property (or properties) should be used for sort order."> & DefineProp<"mustSort", boolean, false, false, "If true then one can not disable sorting, it will always switch between ascending and descending."> & DefineProp<"showSelect", boolean, false, false, "Shows a checkbox for each row."> & DefineProp<"itemSelectable", SelectItemKey<T>, false, false, "SProperty on supplied items that indicates whether the item is selectable."> & DefineProp<"height", string | number, false, null, "Sets and explicit height of the tablet."> & DefineProp<"noDataText", string, false, null, "Text shown when no items are provided to the component."> & DefineProp<"itemValue", ItemValueType<T>, false, null, "Property on supplied items that contains its value."> & DefineProp<"loading", boolean, false, false, "Displays linear progress bar."> & DefineProp<"drag", boolean, false, false, "Enable draggable row."> & DefineProp<"hover", boolean, false, false, "Property on supplied items that contains its value."> & DefineProp<"search", string, false, null, "Text input used to filter items."> & DefineProp<"showExpand", boolean, false, false, "Shows the expand toggle in default rows."> & DefineProp<"headers", DataTableHeader[], false, typeof defaultHeaders, "An array of objects that each describe a header column."> & DefineVModel<"items", T[], false, typeof emptyArray, true, "An array of strings or objects used for automatically generating children components."> & DefineVModel<"", Array<any>, false, typeof emptyArray, true, "The v-model value of the component. If component supports the multiple prop, this defaults to an empty array."> & DefineEmit<"update:expanded", (expanded: string[]) => void, "Emits when the expanded property of the options prop is updated."> & DefineEmit<"update:sortBy", (sort: SortItem[]) => void, "Emits when the sortBy property of the options prop is updated."> & DefineEmit<"update:options", (options: DataTableOptions) => void, "Emits when one of the options properties is updated."> & DefineEmit<"update:page", (page: number) => void, "Emits when the page property of the options prop is updated."> & DefineEmit<"update:itemsPerPage", (value: number) => void, "Emits when the items-per-page property of the options prop is updated."> & DefineEmit<"click:loadMore", () => void> & DefineSlot<"item", (row: IDataTableRowRenderer<T>) => void, "Deprecated, Use slot row instead."> & DefineSlot<"row", (row: IDataTableRow<T>) => VNodeChild> & DefineSlot<`header.${string}`, (header: DataTableHeader) => void> & DefineSlot<`item.${string}`, (e: {
     item: T;
 }) => void>;
 type DefaultProps = {};
@@ -20,14 +20,15 @@ type VariantType<TVariant> = DefineProp<"variant", TVariant, false, null, "Appli
 type ItemsPerPageProp = DefineProp<"itemsPerPage", number, true, -1, "Changes how many items per page should be visible. If set a paging footer is displayed.">;
 type ShowLoadMoreProp = DefineProp<"showLoadMore", boolean, false, false, "Shows the button to fetch more data.">;
 type PageProp = DefineProp<"page", number, false, 1, "The current page.">;
-type ClientPaginationPageProps = ItemsPerPageProp & PageProp;
-type ClientPaginationScrollProps = ShowLoadMoreProp;
+type SearchByProp<TItem> = DefineProp<"searchBy", string | string[] | ((item: TItem) => string | string[]), false, null, "Property on supplied items that contains its value to search.">;
+type ClientPaginationPageProps<TItem> = ItemsPerPageProp & PageProp & SearchByProp<TItem>;
+type ClientPaginationScrollProps<TItem> = ShowLoadMoreProp & SearchByProp<TItem>;
 type ServerPaginationPageProps = ItemsPerPageProp & PageProp & DefineProp<"itemsLength", number, true, null, "Number of all items.">;
 type ServerPaginationScrollProps = ShowLoadMoreProp;
 type CellElement = (props: ConstructComponentProps<Pick<TdHTMLAttributes, "colspan" | "rowspan" | "headers">>) => any;
 type RowElement = (props: ConstructComponentProps<PublicDataTableRowProps>) => any;
 declare const defaultHeaders: DataTableHeader[];
-declare const defaultItems: any[];
-export type DataTableProps<T, TVariant> = VariantType<TVariant> & DataTablePropsBase<T> & DefineType<TVariant extends "client-pagination-scroll" ? ClientPaginationScrollProps : TVariant extends "client-pagination-page" ? ClientPaginationPageProps : TVariant extends "server-pagination-page" ? ServerPaginationPageProps : TVariant extends "server-pagination-scroll" ? ServerPaginationScrollProps : DefaultProps>;
-declare const _default: <T extends unknown, TVariant extends "default" | "client-pagination-scroll" | "client-pagination-page" | "server-pagination-scroll" | "server-pagination-page" = "default">(props: ConstructComponentProps<DataTableProps<T, TVariant>>) => any;
+declare const emptyArray: any[];
+export type DataTableProps<TItem, TVariant> = VariantType<TVariant> & DataTablePropsBase<TItem> & DefineType<TVariant extends "client-pagination-scroll" ? ClientPaginationScrollProps<TItem> : TVariant extends "client-pagination-page" ? ClientPaginationPageProps<TItem> : TVariant extends "server-pagination-page" ? ServerPaginationPageProps : TVariant extends "server-pagination-scroll" ? ServerPaginationScrollProps : DefaultProps>;
+declare const _default: <TItem extends unknown, TVariant extends "default" | "client-pagination-scroll" | "client-pagination-page" | "server-pagination-scroll" | "server-pagination-page" = "default">(props: ConstructComponentProps<DataTableProps<TItem, TVariant>>) => any;
 export default _default;

package/internal-do-not-import-from-here/wctypings.d.ts

@@ -247,7 +247,6 @@ import wc28370f0312764e82b4c29237f943710a from './ux/oxide/colorpicker/ColorPick
 import wc58850535f48040bc98b40064f89d19d0 from './ux/oxide/column/ColumnGrid';
 import wcd116618a12d0439f8da809535809c260 from './ux/oxide/column/Column';
 import wc27c00720f7fb46bbb39286a2cb94797c from './ux/oxide/datatable/DataTable';
-import wc810f65f430374ef2a142907a707f650f from './ux/oxide/datatable/DataTableServer';
 import wcb10a0917fdc744c890d9b472ee3b3c99 from './ux/oxide/datepicker/DatePicker';
 import wcdc1c89b3d0c24b7aa1050f19a0f962b3 from './ux/oxide/dialog/Dialog';
 import wcc0415286cfac41349dd264dc1621c463 from './ux/oxide/divider/Divider';
@@ -4587,16 +4586,7 @@ declare global {
             };
         } : typeof wcd116618a12d0439f8da809535809c260;
         "data": {
-            "table": {
-                "server": typeof wc810f65f430374ef2a142907a707f650f extends {
-                    propsDefinition: infer TProp;
-                } ? {
-                    new (...args: any[]): {
-                        $props: TProp & Omit<VueComponentBaseProps, keyof TProp>;
-                    };
-                } : typeof wc810f65f430374ef2a142907a707f650f;
-            };
-            "table$": typeof wc27c00720f7fb46bbb39286a2cb94797c extends {
+            "table": typeof wc27c00720f7fb46bbb39286a2cb94797c extends {
                 propsDefinition: infer TProp;
             } ? {
                 new (...args: any[]): {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@omnia/fx",
   "license": "MIT",
-  "version": "8.0.253-dev",
+  "version": "8.0.254-dev",
   "description": "Provide Omnia Fx typings and tooling for clientside Omnia development.",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
@@ -20,7 +20,7 @@
   ],
   "author": "Precio Fishbone",
   "dependencies": {
-    "@omnia/fx-models": "8.0.253-dev",
+    "@omnia/fx-models": "8.0.254-dev",
     "@microsoft/signalr": "6.0.1",
     "broadcast-channel": "4.8.0",
     "dayjs": "1.11.7",