@visactor/vtable-editors 1.16.2-alpha.2 → 1.16.2
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.
- package/cjs/types.d.ts +4 -3
- package/cjs/types.js.map +1 -1
- package/es/types.d.ts +4 -3
- package/es/types.js.map +1 -1
- package/package.json +3 -3
package/cjs/types.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export interface IEditor<V = any> {
|
|
2
|
-
onStart: (context: EditContext<V>) => void;
|
|
1
|
+
export interface IEditor<V = any, T = any> {
|
|
2
|
+
onStart: (context: EditContext<V, T>) => void;
|
|
3
3
|
onEnd: () => void;
|
|
4
4
|
isEditorElement?: (target: HTMLElement) => boolean;
|
|
5
5
|
validateValue?: (newValue?: any, oldValue?: any, position?: CellAddress, table?: any) => boolean | ValidateEnum | Promise<boolean | ValidateEnum>;
|
|
@@ -9,11 +9,12 @@ export interface IEditor<V = any> {
|
|
|
9
9
|
targetIsOnEditor?: (target: HTMLElement) => boolean;
|
|
10
10
|
bindSuccessCallback?: (callback: () => void) => void;
|
|
11
11
|
}
|
|
12
|
-
export interface EditContext<V = any> {
|
|
12
|
+
export interface EditContext<V = any, T = any> {
|
|
13
13
|
container: HTMLElement;
|
|
14
14
|
referencePosition: ReferencePosition;
|
|
15
15
|
value: V;
|
|
16
16
|
endEdit: () => void;
|
|
17
|
+
table: T;
|
|
17
18
|
col: number;
|
|
18
19
|
row: number;
|
|
19
20
|
}
|
package/cjs/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"sources":["../src/types.ts"],"names":[],"mappings":";;;AAqGA,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,8BAAiB,CAAA;IACjB,0BAAa,CAAA;IACb,4BAAe,CAAA;AACjB,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AAOD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,8CAA8B,CAAA;IAC9B,kDAAkC,CAAA;IAClC,qDAAqC,CAAA;IACrC,yDAAyC,CAAA;AAC3C,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB","file":"types.js","sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface IEditor<V = any, T = any> {\n /**\n * Called when cell enters edit mode.\n *\n * Warning will be thrown if you don't provide this function\n * after removal of `beginEditing`.\n */\n onStart: (context: EditContext<V, T>) => void;\n /**\n * called when cell exits edit mode.\n *\n * Warning will be thrown if you don't provide this function\n * after removal of `exit`.\n */\n onEnd: () => void;\n /**\n * Called when user click somewhere while editor is in edit mode.\n *\n * If returns falsy, VTable will exit edit mode.\n *\n * If returns truthy or not defined, nothing will happen.\n * Which means, in this scenario, you need to call `endEdit` manually\n * to end edit mode.\n */\n isEditorElement?: (target: HTMLElement) => boolean;\n /**\n * Before set new value to table, use it to validate value.\n * If the interface returns true, the value takes effect; otherwise, it does not take effect.\n * @param newValue new value to be set. If not provided, the current input element value will be used.\n * @param oldValue old value of the cell.\n */\n // validateValue?: (newValue?: V, oldValue?: V) => boolean | Promise<boolean>;\n validateValue?: (\n newValue?: any,\n oldValue?: any,\n position?: CellAddress,\n table?: any\n ) => boolean | ValidateEnum | Promise<boolean | ValidateEnum>;\n /**\n * Called when editor mode is exited by any means.\n * Expected to return the current value of the cell.\n */\n getValue: () => V;\n /**\n * Called when cell enter edit mode.\n * @deprecated use `onStart` instead.\n */\n beginEditing?: (container: HTMLElement, referencePosition: ReferencePosition, value: V) => void;\n /**\n * @see onEnd\n * @deprecated use `onEnd` instead.\n */\n exit?: () => void;\n /**\n * @see isEditorElement\n * @deprecated use `isEditorElement` instead.\n */\n targetIsOnEditor?: (target: HTMLElement) => boolean;\n /**\n * Called when cell enters edit mode with a callback function\n * that can be used to end edit mode.\n * @see EditContext#endEdit\n * @deprecated callback is provided as `endEdit` in `EditContext`, use `onStart` instead.\n */\n bindSuccessCallback?: (callback: () => void) => void;\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface EditContext<V = any, T = any> {\n /** Container element of the VTable instance. */\n container: HTMLElement;\n /** Position info of the cell that is being edited. */\n referencePosition: ReferencePosition;\n /** Cell value before editing. */\n value: V;\n /**\n * Callback function that can be used to end edit mode.\n *\n * In most cases you don't need to call this function,\n * since Enter key click is handled by VTable automatically,\n * and mouse click can be handled by `isEditorElement`.\n *\n * However, if your editor has its own complete button,\n * or you have external elements like Tooltip,\n * you may want to use this callback to help you\n * end edit mode.\n */\n endEdit: () => void;\n table: T;\n col: number;\n row: number;\n}\n\nexport interface RectProps {\n left: number;\n top: number;\n width: number;\n height: number;\n}\n\nexport enum Placement {\n top = 'top',\n bottom = 'bottom',\n left = 'left',\n right = 'right'\n}\n\nexport interface ReferencePosition {\n rect: RectProps;\n placement?: Placement;\n}\n\nexport enum ValidateEnum {\n validateExit = 'validate-exit',\n invalidateExit = 'invalidate-exit',\n validateNotExit = 'validate-not-exit',\n invalidateNotExit = 'invalidate-not-exit'\n}\n\nexport type CellAddress = {\n col: number;\n row: number;\n};\n"]}
|
package/es/types.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export interface IEditor<V = any> {
|
|
2
|
-
onStart: (context: EditContext<V>) => void;
|
|
1
|
+
export interface IEditor<V = any, T = any> {
|
|
2
|
+
onStart: (context: EditContext<V, T>) => void;
|
|
3
3
|
onEnd: () => void;
|
|
4
4
|
isEditorElement?: (target: HTMLElement) => boolean;
|
|
5
5
|
validateValue?: (newValue?: any, oldValue?: any, position?: CellAddress, table?: any) => boolean | ValidateEnum | Promise<boolean | ValidateEnum>;
|
|
@@ -9,11 +9,12 @@ export interface IEditor<V = any> {
|
|
|
9
9
|
targetIsOnEditor?: (target: HTMLElement) => boolean;
|
|
10
10
|
bindSuccessCallback?: (callback: () => void) => void;
|
|
11
11
|
}
|
|
12
|
-
export interface EditContext<V = any> {
|
|
12
|
+
export interface EditContext<V = any, T = any> {
|
|
13
13
|
container: HTMLElement;
|
|
14
14
|
referencePosition: ReferencePosition;
|
|
15
15
|
value: V;
|
|
16
16
|
endEdit: () => void;
|
|
17
|
+
table: T;
|
|
17
18
|
col: number;
|
|
18
19
|
row: number;
|
|
19
20
|
}
|
package/es/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"sources":["../src/types.ts"],"names":[],"mappings":"AAqGA,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,8BAAiB,CAAA;IACjB,0BAAa,CAAA;IACb,4BAAe,CAAA;AACjB,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAOD,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,8CAA8B,CAAA;IAC9B,kDAAkC,CAAA;IAClC,qDAAqC,CAAA;IACrC,yDAAyC,CAAA;AAC3C,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB","file":"types.js","sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface IEditor<V = any, T = any> {\n /**\n * Called when cell enters edit mode.\n *\n * Warning will be thrown if you don't provide this function\n * after removal of `beginEditing`.\n */\n onStart: (context: EditContext<V, T>) => void;\n /**\n * called when cell exits edit mode.\n *\n * Warning will be thrown if you don't provide this function\n * after removal of `exit`.\n */\n onEnd: () => void;\n /**\n * Called when user click somewhere while editor is in edit mode.\n *\n * If returns falsy, VTable will exit edit mode.\n *\n * If returns truthy or not defined, nothing will happen.\n * Which means, in this scenario, you need to call `endEdit` manually\n * to end edit mode.\n */\n isEditorElement?: (target: HTMLElement) => boolean;\n /**\n * Before set new value to table, use it to validate value.\n * If the interface returns true, the value takes effect; otherwise, it does not take effect.\n * @param newValue new value to be set. If not provided, the current input element value will be used.\n * @param oldValue old value of the cell.\n */\n // validateValue?: (newValue?: V, oldValue?: V) => boolean | Promise<boolean>;\n validateValue?: (\n newValue?: any,\n oldValue?: any,\n position?: CellAddress,\n table?: any\n ) => boolean | ValidateEnum | Promise<boolean | ValidateEnum>;\n /**\n * Called when editor mode is exited by any means.\n * Expected to return the current value of the cell.\n */\n getValue: () => V;\n /**\n * Called when cell enter edit mode.\n * @deprecated use `onStart` instead.\n */\n beginEditing?: (container: HTMLElement, referencePosition: ReferencePosition, value: V) => void;\n /**\n * @see onEnd\n * @deprecated use `onEnd` instead.\n */\n exit?: () => void;\n /**\n * @see isEditorElement\n * @deprecated use `isEditorElement` instead.\n */\n targetIsOnEditor?: (target: HTMLElement) => boolean;\n /**\n * Called when cell enters edit mode with a callback function\n * that can be used to end edit mode.\n * @see EditContext#endEdit\n * @deprecated callback is provided as `endEdit` in `EditContext`, use `onStart` instead.\n */\n bindSuccessCallback?: (callback: () => void) => void;\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface EditContext<V = any, T = any> {\n /** Container element of the VTable instance. */\n container: HTMLElement;\n /** Position info of the cell that is being edited. */\n referencePosition: ReferencePosition;\n /** Cell value before editing. */\n value: V;\n /**\n * Callback function that can be used to end edit mode.\n *\n * In most cases you don't need to call this function,\n * since Enter key click is handled by VTable automatically,\n * and mouse click can be handled by `isEditorElement`.\n *\n * However, if your editor has its own complete button,\n * or you have external elements like Tooltip,\n * you may want to use this callback to help you\n * end edit mode.\n */\n endEdit: () => void;\n table: T;\n col: number;\n row: number;\n}\n\nexport interface RectProps {\n left: number;\n top: number;\n width: number;\n height: number;\n}\n\nexport enum Placement {\n top = 'top',\n bottom = 'bottom',\n left = 'left',\n right = 'right'\n}\n\nexport interface ReferencePosition {\n rect: RectProps;\n placement?: Placement;\n}\n\nexport enum ValidateEnum {\n validateExit = 'validate-exit',\n invalidateExit = 'invalidate-exit',\n validateNotExit = 'validate-not-exit',\n invalidateNotExit = 'invalidate-not-exit'\n}\n\nexport type CellAddress = {\n col: number;\n row: number;\n};\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@visactor/vtable-editors",
|
|
3
|
-
"version": "1.16.2
|
|
3
|
+
"version": "1.16.2",
|
|
4
4
|
"description": "",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"main": "cjs/index.js",
|
|
@@ -38,9 +38,9 @@
|
|
|
38
38
|
"ts-node": "10.9.0",
|
|
39
39
|
"tslib": "2.3.1",
|
|
40
40
|
"tslint": "5.12.1",
|
|
41
|
-
"@internal/
|
|
41
|
+
"@internal/eslint-config": "0.0.1",
|
|
42
42
|
"@internal/ts-config": "0.0.1",
|
|
43
|
-
"@internal/
|
|
43
|
+
"@internal/bundler": "0.0.1"
|
|
44
44
|
},
|
|
45
45
|
"publishConfig": {
|
|
46
46
|
"access": "public"
|