@mezzanine-ui/core 0.13.11 → 0.14.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.
Files changed (2) hide show
  1. package/package.json +3 -3
  2. package/table/table.d.ts +36 -5
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mezzanine-ui/core",
3
- "version": "0.13.11",
3
+ "version": "0.14.0",
4
4
  "description": "Core for mezzanine-ui",
5
5
  "author": "Mezzanine",
6
6
  "repository": {
@@ -40,8 +40,8 @@
40
40
  }
41
41
  },
42
42
  "dependencies": {
43
- "@mezzanine-ui/icons": "^0.13.11",
44
- "@mezzanine-ui/system": "^0.13.11",
43
+ "@mezzanine-ui/icons": "^0.14.0",
44
+ "@mezzanine-ui/system": "^0.14.0",
45
45
  "lodash": "^4.17.21",
46
46
  "tslib": "^2.4.1"
47
47
  },
package/table/table.d.ts CHANGED
@@ -45,10 +45,12 @@ export interface TableDataSourceWithID extends TableRecord<unknown> {
45
45
  id: string | number;
46
46
  }
47
47
  export type TableDataSource = TableDataSourceWithKey | TableDataSourceWithID;
48
- export type TableColumn<SourceType> = {
49
- dataIndex: string;
48
+ export interface TableColumnBase<SourceType> {
49
+ /** Column's primary key */
50
+ key?: string;
51
+ dataIndex?: string;
52
+ render?(source: SourceType, index: number, column: ExpandedTableColumn): any;
50
53
  title?: string;
51
- render?(source: SourceType, index: number, column: TableColumn<SourceType>): any;
52
54
  renderTitle?(classes: typeof tableClasses): any;
53
55
  renderTooltipTitle?(source: SourceType): string;
54
56
  align?: 'start' | 'center' | 'end';
@@ -56,14 +58,43 @@ export type TableColumn<SourceType> = {
56
58
  headerClassName?: string;
57
59
  width?: number;
58
60
  sorter?(a: any, b: any): number;
59
- onSorted?(dataIndex: string, sortedType: string): void;
61
+ /**
62
+ * The `key` is automatically generated by mzn. If you need a more specific key,
63
+ * please provide `key` within the column.
64
+ */
65
+ onSorted?(key: string, sortedType: string): void;
60
66
  editable?: boolean;
61
67
  setCellProps?(record: SourceType): TableRecord<unknown>;
62
68
  /** @default true */
63
69
  ellipsis?: boolean;
64
70
  /** force display tooltip whenever content is hovered */
65
71
  forceShownTooltipWhenHovered?: boolean;
66
- };
72
+ }
73
+ export interface TableColumnDataIndexAndTitle<SourceType> extends TableColumnBase<SourceType> {
74
+ dataIndex: string;
75
+ render?: never;
76
+ title: string;
77
+ renderTitle?: never;
78
+ }
79
+ export interface TableColumnDataIndexAndRenderTitle<SourceType> extends TableColumnBase<SourceType> {
80
+ dataIndex: string;
81
+ render?: never;
82
+ title?: never;
83
+ renderTitle(classes: typeof tableClasses): any;
84
+ }
85
+ export interface TableColumnRenderAndTitle<SourceType> extends TableColumnBase<SourceType> {
86
+ dataIndex?: never;
87
+ render(source: SourceType, index: number, column: ExpandedTableColumn): any;
88
+ title: string;
89
+ renderTitle?: never;
90
+ }
91
+ export interface TableColumnRenderAndRenderTitle<SourceType> extends TableColumnBase<SourceType> {
92
+ dataIndex?: never;
93
+ render(source: SourceType, index: number, column: ExpandedTableColumn): any;
94
+ title?: never;
95
+ renderTitle(classes: typeof tableClasses): any;
96
+ }
97
+ export type TableColumn<SourceType> = TableColumnDataIndexAndTitle<SourceType> | TableColumnDataIndexAndRenderTitle<SourceType> | TableColumnRenderAndTitle<SourceType> | TableColumnRenderAndRenderTitle<SourceType>;
67
98
  export type ExpandedTableColumn = Omit<TableColumn<TableRecord<unknown>>, 'title' | 'renderTitle' | 'align' | 'headerClassName' | 'width' | 'sorter' | 'onSorted' | 'editable' | 'setCellProps'>;
68
99
  export type TableFetchMore = {
69
100
  callback?(): any;