quill-table-up 3.3.2 → 3.5.0

package/README.md

@@ -65,16 +65,18 @@ const quill = new Quill('#editor', {
 
 **Full options usage see [demo](https://github.com/quill-modules/quill-table-up/blob/master/docs/index.js#L38)**
 
-| Attribute     | Description                                                                                                                 | Type                                                                            | Default                                    |
-| ------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------ |
-| full          | if set `true`. width max will be 100%                                                                                       | `boolean`                                                                       | `false`                                    |
-| fullSwitch    | enable to choose insert a full width table                                                                                  | `boolean`                                                                       | `true`                                     |
-| texts         | the text used to create the table                                                                                           | `TableTextOptions`                                                              | `defaultTexts`                             |
-| customSelect  | display a custom select to custom row and column number add a table. module provides default selector `defaultCustomSelect` | `(tableModule: TableUp, picker: Picker) => Promise<HTMLElement> \| HTMLElement` | -                                          |
-| customBtn     | display a custom button to custom row and column number add a table. it only when use `defaultCustomSelect` will effect     | `boolean`                                                                       | `false`                                    |
-| icon          | picker svg icon string. it will set with `innerHTML`                                                                        | `string`                                                                        | `origin table icon`                        |
-| autoMergeCell | empty row or column will auto merge to one                                                                                  | `boolean`                                                                       | `true`                                     |
-| modules       | the module plugin to help user control about table operate. see [`Export Internal Module`](#export-internal-module)         | `[]`                                                                            | `{ module: Contstructor, options: any }[]` |
+| Attribute            | Description                                                                                                                                                                                                                               | Type                                                                            | Default                                    |
+| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------ |
+| full                 | if set `true`. width max will be 100%                                                                                                                                                                                                     | `boolean`                                                                       | `false`                                    |
+| fullSwitch           | enable to choose insert a full width table                                                                                                                                                                                                | `boolean`                                                                       | `true`                                     |
+| texts                | the text used to create the table                                                                                                                                                                                                         | `TableTextOptions \| ((key: string) => string)`                                 | `defaultTexts`                             |
+| customSelect         | display a custom select to custom row and column number add a table. module provides default selector `defaultCustomSelect`                                                                                                               | `(tableModule: TableUp, picker: Picker) => Promise<HTMLElement> \| HTMLElement` | -                                          |
+| customBtn            | display a custom button to custom row and column number add a table. it only when use `defaultCustomSelect` will effect                                                                                                                   | `boolean`                                                                       | `false`                                    |
+| icon                 | picker svg icon string. it will set with `innerHTML`                                                                                                                                                                                      | `string`                                                                        | `origin table icon`                        |
+| autoMergeCell        | empty row or column will auto merge to one                                                                                                                                                                                                | `boolean`                                                                       | `true`                                     |
+| pasteStyleSheet      | resolve `<style>` stylesheet rules to inline styles on table cells when pasting. note: when enabled, it processes **all** pasted HTML (not just tables), which may affect non-table paste content and add extra overhead for large pastes | `boolean`                                                                       | `false`                                    |
+| pasteDefaultTagStyle | when `pasteStyleSheet` is enabled, also apply rules with tag-only selectors (e.g. `td`, `table td`). otherwise only class/id/attribute selectors are applied                                                                              | `boolean`                                                                       | `false`                                    |
+| modules              | the module plugin to help user control about table operate. see [`Export Internal Module`](#export-internal-module)                                                                                                                       | `[]`                                                                            | `{ module: Contstructor, options: any }[]` |
 
 > I'm not suggest to use `TableVirtualScrollbar` and `TableResizeLine` at same time, because it have a little conflict when user hover on it. Just like the first editor in [demo](https://quill-modules.github.io/quill-table-up/)
 
@@ -116,6 +118,48 @@ const defaultTexts = {
 
 </details>
 
+### `texts` Dynamic Usage
+
+You can pass `texts` as a function.\
+When internal UI reads a text, it will call `texts(key)` and use the returned string.
+
+```ts
+let locale: 'en' | 'zh' = 'en';
+
+const textMap = {
+  en: {
+    customBtnText: 'Custom',
+    confirmText: 'Confirm',
+    cancelText: 'Cancel',
+  },
+  zh: {
+    customBtnText: '自定义',
+    confirmText: '确认',
+    cancelText: '取消',
+  },
+} as const;
+
+const quill = new Quill('#editor', {
+  modules: {
+    [TableUp.moduleName]: {
+      customSelect: defaultCustomSelect,
+      customBtn: true,
+      texts: key => textMap[locale][key as keyof typeof textMap.en] || '',
+      modules: [
+        { module: TableSelection },
+        { module: TableMenuContextmenu },
+      ],
+    },
+  },
+});
+
+// switch language
+locale = 'zh';
+await quill.getModule(TableUp.moduleName).refreshUI();
+```
+
+`refreshUI()` will rebuild table-up UI and read latest text values.
+
 ## Export Internal Module
 
 ### TableSelection

package/dist/index.d.ts

@@ -442,6 +442,7 @@ declare class TableClipboard extends Clipboard {
   cellCount: number;
   colCount: number;
   constructor(quill: Quill, options: Partial<ClipboardOptions>);
+  normalizeHTML(doc: Document): void;
   getStyleBackgroundColor(node: Node, delta: Delta$1): void;
   matchTable(node: Node, delta: Delta$1): Delta$1;
   matchTbody(node: Node, delta: Delta$1): Delta$1;
@@ -919,8 +920,8 @@ declare class TableSelection extends TableDomSelector {
   updateWithSelectedTds(): void;
   update(): void;
   getTableViewScroll(): {
-    x: number;
     y: number;
+    x: number;
   };
   setSelectionTable(table: HTMLTableElement | undefined): void;
   showDisplay(): void;
@@ -983,6 +984,7 @@ interface TableTextOptions extends TableCreatorTextOptions, TableMenuTexts {
   transparent: string;
   perWidthInsufficient: string;
 }
+type TableTextOptionsInput = Partial<TableTextOptions> | ((this: TableUp, key: string) => string);
 interface TableUpExtraModule extends Constructor<any, [TableUp, Quill, any]> {
   moduleName: string;
 }
@@ -998,8 +1000,13 @@ interface TableUpOptions {
   texts: TableTextOptions;
   icon: string;
   autoMergeCell: boolean;
+  pasteStyleSheet: boolean;
+  pasteDefaultTagStyle: boolean;
   modules: TableUpModule[];
 }
+interface TableUpOptionsInput extends Partial<Omit<TableUpOptions, 'texts'>> {
+  texts?: TableTextOptionsInput;
+}
 interface TableColValue {
   tableId: string;
   colId: string;
@@ -1225,6 +1232,7 @@ declare class TableUp {
   static register(): void;
   quill: Quill;
   options: TableUpOptions;
+  textOptionsInput: TableTextOptionsInput | undefined;
   toolBox: HTMLDivElement;
   fixTableByLisenter: (this: any) => void;
   selector?: HTMLElement;
@@ -1232,36 +1240,13 @@ declare class TableUp {
   editableObserver: MutationObserver;
   modules: Record<string, Constructor>;
   get statics(): any;
-  constructor(quill: Quill, options: Partial<TableUpOptions>);
+  constructor(quill: Quill, options: TableUpOptionsInput);
   initialContainer(): HTMLDivElement;
   addContainer(classes: string | HTMLElement): HTMLElement;
-  resolveOptions(options: Partial<TableUpOptions>): TableUpOptions;
-  resolveTexts(options: Partial<TableTextOptions>): {
-    fullCheckboxText: string;
-    customBtnText: string;
-    confirmText: string;
-    cancelText: string;
-    rowText: string;
-    colText: string;
-    notPositiveNumberError: string;
-    custom: string;
-    clear: string;
-    transparent: string;
-    perWidthInsufficient: string;
-    CopyCell: string;
-    CutCell: string;
-    InsertTop: string;
-    InsertRight: string;
-    InsertBottom: string;
-    InsertLeft: string;
-    MergeCell: string;
-    SplitCell: string;
-    DeleteRow: string;
-    DeleteColumn: string;
-    DeleteTable: string;
-    BackgroundColor: string;
-    BorderColor: string;
-  } & Partial<TableTextOptions>;
+  getToolbarPicker(): QuillThemePicker | undefined;
+  resolveOptions(options: TableUpOptionsInput): TableUpOptions;
+  resolveTexts(options?: TableTextOptionsInput): TableTextOptions;
+  refreshUI(): Promise<void>;
   initModules(): void;
   listenEditableChange(): void;
   destroyModules(): void;
@@ -1290,5 +1275,5 @@ declare class TableUp {
   convertTableBodyByCells(tableBlot: TableMainFormat, selecteds: TableCellInnerFormat[], tag: TableBodyTag): void;
 }
 //#endregion
-export { BlockEmbedOverride, BlockOverride, ClipboardOptions, Constructor, ContainerFormat, InternalModule, InternalTableMenuModule, InternalTableSelectionModule, Matcher, MenuTooltipInstance, Position, QuillTheme, QuillThemePicker, RelactiveRect, ScrollOverride, Scrollbar, SelectionData, Selector, SkipRowCount, TableAlign, TableBodyFormat, TableBodyTag, TableCaptionFormat, TableCaptionValue, TableCellFormat, TableCellInnerFormat, TableCellValue, TableClipboard, TableColFormat, TableColValue, TableColgroupFormat, TableConstantsData, TableCreatorTextOptions, TableDomSelector, TableFootFormat, TableHeadFormat, TableMainFormat, TableMenuCommon, TableMenuContextmenu, TableMenuOptions, TableMenuOptionsInput, TableMenuSelect, TableMenuTexts, TableModuleLifecycle, TableResizeBox, TableResizeBoxOptions, TableResizeCommon, TableResizeCommonHelper, TableResizeLine, TableResizeScale, TableResizeScaleOptions, TableRowFormat, TableRowValue, TableSelection, TableSelectionOptions, TableTextOptions, TableUp, TableUp as default, TableUpExtraModule, TableUpModule, TableUpOptions, TableValue, TableVirtualScrollbar, TableWrapperFormat, Tool, ToolOption, ToolOptionBreak, Writable, applyCellUpdates, blotName, createColorPicker, createSelectBox, createTooltip, defaultCustomSelect, findParentBlot, findParentBlots, getCellPositions, getColRect, getCountByPosition, getTableCellStructure, getTableMainRect, groupCellByRow, isCellsSpan, isTableAlignRight, parsePasteDelta, pasteCells, pasteWithLoop, pasteWithStructure, prepareCellUpdate, randomId, removeOverlappingCells, tableMenuTools, tableUpEvent, tableUpInternal, tableUpSize, updateTableConstants };
+export { BlockEmbedOverride, BlockOverride, ClipboardOptions, Constructor, ContainerFormat, InternalModule, InternalTableMenuModule, InternalTableSelectionModule, Matcher, MenuTooltipInstance, Position, QuillTheme, QuillThemePicker, RelactiveRect, ScrollOverride, Scrollbar, SelectionData, Selector, SkipRowCount, TableAlign, TableBodyFormat, TableBodyTag, TableCaptionFormat, TableCaptionValue, TableCellFormat, TableCellInnerFormat, TableCellValue, TableClipboard, TableColFormat, TableColValue, TableColgroupFormat, TableConstantsData, TableCreatorTextOptions, TableDomSelector, TableFootFormat, TableHeadFormat, TableMainFormat, TableMenuCommon, TableMenuContextmenu, TableMenuOptions, TableMenuOptionsInput, TableMenuSelect, TableMenuTexts, TableModuleLifecycle, TableResizeBox, TableResizeBoxOptions, TableResizeCommon, TableResizeCommonHelper, TableResizeLine, TableResizeScale, TableResizeScaleOptions, TableRowFormat, TableRowValue, TableSelection, TableSelectionOptions, TableTextOptions, TableTextOptionsInput, TableUp, TableUp as default, TableUpExtraModule, TableUpModule, TableUpOptions, TableUpOptionsInput, TableValue, TableVirtualScrollbar, TableWrapperFormat, Tool, ToolOption, ToolOptionBreak, Writable, applyCellUpdates, blotName, createColorPicker, createSelectBox, createTooltip, defaultCustomSelect, findParentBlot, findParentBlots, getCellPositions, getColRect, getCountByPosition, getTableCellStructure, getTableMainRect, groupCellByRow, isCellsSpan, isTableAlignRight, parsePasteDelta, pasteCells, pasteWithLoop, pasteWithStructure, prepareCellUpdate, randomId, removeOverlappingCells, tableMenuTools, tableUpEvent, tableUpInternal, tableUpSize, updateTableConstants };
 //# sourceMappingURL=index.d.ts.map