@omnia/fx 8.0.253-dev → 8.0.254-dev

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.
@@ -72,7 +72,7 @@ export declare class Docs {
72
72
  static categories: Array<DocumentationCategory>;
73
73
  static addArea(area: DocumentationArea): void;
74
74
  static addCategory(category: DocumentationCategory): void;
75
- static specBuilder(name: string): DocumentationSpec;
75
+ static specBuilder(name: string, alias?: string): DocumentationSpec;
76
76
  static velcronSpecBuilder(name: string): VelcronComponentSpec;
77
77
  static registerComponent(spec: DocumentationSpec, area: DocumentationArea, category: DocumentationCategory): void;
78
78
  }
@@ -93,6 +93,7 @@ export interface VelcronExampleDefinitionSpec {
93
93
  }
94
94
  export declare class DocumentationSpec {
95
95
  private name;
96
+ private alias?;
96
97
  private typeValueMapping;
97
98
  private exampleComponents;
98
99
  markdownSections: Array<MarkdownSection>;
@@ -103,12 +104,13 @@ export declare class DocumentationSpec {
103
104
  events: EventSpec[];
104
105
  slots: SlotSpec[];
105
106
  id: string;
106
- constructor(name: string);
107
+ constructor(name: string, alias?: string);
107
108
  addTypeValueMapping(name: string, value: string | string[] | any): DocumentationSpec;
108
109
  addTheming(): DocumentationSpec;
109
110
  addToned(): DocumentationSpec;
110
111
  addCssClass(): DocumentationSpec;
111
112
  getName(): string;
113
+ getAlias(): string;
112
114
  getId(): string;
113
115
  addApiProperty(propertySpec: PropertySpec): DocumentationSpec;
114
116
  addApiProperty(name: string, description: string, type: string, defaultValue?: string): DocumentationSpec;
@@ -12,7 +12,7 @@ export type DataTableOptions = {
12
12
  itemsPerPage: number;
13
13
  sortBy: SortItem[];
14
14
  };
15
- 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: {
15
+ 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: {
16
16
  item: T;
17
17
  }) => void>;
18
18
  type DefaultProps = {};
@@ -20,14 +20,15 @@ type VariantType<TVariant> = DefineProp<"variant", TVariant, false, null, "Appli
20
20
  type ItemsPerPageProp = DefineProp<"itemsPerPage", number, true, -1, "Changes how many items per page should be visible. If set a paging footer is displayed.">;
21
21
  type ShowLoadMoreProp = DefineProp<"showLoadMore", boolean, false, false, "Shows the button to fetch more data.">;
22
22
  type PageProp = DefineProp<"page", number, false, 1, "The current page.">;
23
- type ClientPaginationPageProps = ItemsPerPageProp & PageProp;
24
- type ClientPaginationScrollProps = ShowLoadMoreProp;
23
+ type SearchByProp<TItem> = DefineProp<"searchBy", string | string[] | ((item: TItem) => string | string[]), false, null, "Property on supplied items that contains its value to search.">;
24
+ type ClientPaginationPageProps<TItem> = ItemsPerPageProp & PageProp & SearchByProp<TItem>;
25
+ type ClientPaginationScrollProps<TItem> = ShowLoadMoreProp & SearchByProp<TItem>;
25
26
  type ServerPaginationPageProps = ItemsPerPageProp & PageProp & DefineProp<"itemsLength", number, true, null, "Number of all items.">;
26
27
  type ServerPaginationScrollProps = ShowLoadMoreProp;
27
28
  type CellElement = (props: ConstructComponentProps<Pick<TdHTMLAttributes, "colspan" | "rowspan" | "headers">>) => any;
28
29
  type RowElement = (props: ConstructComponentProps<PublicDataTableRowProps>) => any;
29
30
  declare const defaultHeaders: DataTableHeader[];
30
- declare const defaultItems: any[];
31
- 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>;
32
- 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;
31
+ declare const emptyArray: any[];
32
+ 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>;
33
+ 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;
33
34
  export default _default;
@@ -247,7 +247,6 @@ import wc28370f0312764e82b4c29237f943710a from './ux/oxide/colorpicker/ColorPick
247
247
  import wc58850535f48040bc98b40064f89d19d0 from './ux/oxide/column/ColumnGrid';
248
248
  import wcd116618a12d0439f8da809535809c260 from './ux/oxide/column/Column';
249
249
  import wc27c00720f7fb46bbb39286a2cb94797c from './ux/oxide/datatable/DataTable';
250
- import wc810f65f430374ef2a142907a707f650f from './ux/oxide/datatable/DataTableServer';
251
250
  import wcb10a0917fdc744c890d9b472ee3b3c99 from './ux/oxide/datepicker/DatePicker';
252
251
  import wcdc1c89b3d0c24b7aa1050f19a0f962b3 from './ux/oxide/dialog/Dialog';
253
252
  import wcc0415286cfac41349dd264dc1621c463 from './ux/oxide/divider/Divider';
@@ -4587,16 +4586,7 @@ declare global {
4587
4586
  };
4588
4587
  } : typeof wcd116618a12d0439f8da809535809c260;
4589
4588
  "data": {
4590
- "table": {
4591
- "server": typeof wc810f65f430374ef2a142907a707f650f extends {
4592
- propsDefinition: infer TProp;
4593
- } ? {
4594
- new (...args: any[]): {
4595
- $props: TProp & Omit<VueComponentBaseProps, keyof TProp>;
4596
- };
4597
- } : typeof wc810f65f430374ef2a142907a707f650f;
4598
- };
4599
- "table$": typeof wc27c00720f7fb46bbb39286a2cb94797c extends {
4589
+ "table": typeof wc27c00720f7fb46bbb39286a2cb94797c extends {
4600
4590
  propsDefinition: infer TProp;
4601
4591
  } ? {
4602
4592
  new (...args: any[]): {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@omnia/fx",
3
3
  "license": "MIT",
4
- "version": "8.0.253-dev",
4
+ "version": "8.0.254-dev",
5
5
  "description": "Provide Omnia Fx typings and tooling for clientside Omnia development.",
6
6
  "scripts": {
7
7
  "test": "echo \"Error: no test specified\" && exit 1",
@@ -20,7 +20,7 @@
20
20
  ],
21
21
  "author": "Precio Fishbone",
22
22
  "dependencies": {
23
- "@omnia/fx-models": "8.0.253-dev",
23
+ "@omnia/fx-models": "8.0.254-dev",
24
24
  "@microsoft/signalr": "6.0.1",
25
25
  "broadcast-channel": "4.8.0",
26
26
  "dayjs": "1.11.7",