@univerjs/sheets-hyper-link-ui 0.2.6 → 0.2.7

package/lib/es/index.js

@@ -8,7 +8,7 @@ import { RemoveHyperLinkMutation, AddHyperLinkMutation, HyperLinkModel, ERROR_RA
 import { SheetSkeletonManagerService, ScrollToRangeOperation, SheetCanvasPopManagerService, IEditorBridgeService, HoverManagerService, SheetPermissionInterceptorBaseController, whenSheetEditorFocused, getCurrentRangeDisable$, APPLY_TYPE, IAutoFillService, virtualizeDiscreteRanges, getAutoFillRepeatRange, COPY_TYPE, rangeToDiscreteRange, PREDEFINED_HOOK_NAME, getRepeatRange, ISheetClipboardService } from "@univerjs/sheets-ui";
 import { IRenderManagerService } from "@univerjs/engine-render";
 import { debounceTime, Subject, BehaviorSubject } from "rxjs";
-import require$$0, { forwardRef, useRef, createElement, useState, useEffect, useMemo } from "react";
+import require$$0, { forwardRef, useRef, createElement, useState, useMemo, useEffect } from "react";
 import cs from "clsx";
 import { MessageType, FormLayout, Input, Select, Button, Tooltip } from "@univerjs/design";
 import { IMessageService, useObservable, useEvent, RangeSelector, ISidebarService, KeyCode, MetaKeys, MenuItemType, MenuPosition, getMenuHiddenObservable, MenuGroup, ComponentManager, IShortcutService, IMenuService } from "@univerjs/ui";
@@ -131,6 +131,37 @@ SheetsHyperLinkRenderManagerController = __decorateClass$a([
   __decorateParam$a(1, Inject(HyperLinkModel)),
   __decorateParam$a(2, Inject(ThemeService))
 ], SheetsHyperLinkRenderManagerController);
+var LinkType = /* @__PURE__ */ ((LinkType2) => (LinkType2.link = "link", LinkType2.range = "range", LinkType2.sheet = "gid", LinkType2.definedName = "rangeid", LinkType2))(LinkType || {});
+const _SheetsHyperLinkSidePanelService = class _SheetsHyperLinkSidePanelService extends Disposable {
+  constructor() {
+    super(...arguments);
+    __publicField(this, "_customHyperLinks", /* @__PURE__ */ new Map());
+  }
+  isBuiltInLinkType(type) {
+    return !!LinkType[type];
+  }
+  getOptions() {
+    return Array.from(this._customHyperLinks.values()).map(({ option }) => option);
+  }
+  findCustomHyperLink(link) {
+    return Array.from(this._customHyperLinks.values()).find((item) => item.match(link));
+  }
+  registerCustomHyperLink(customHyperLink) {
+    this._customHyperLinks.set(customHyperLink.type, customHyperLink);
+  }
+  getCustomHyperLink(type) {
+    return this._customHyperLinks.get(type);
+  }
+  removeCustomHyperLink(type) {
+    const { _customHyperLinks } = this;
+    _customHyperLinks.delete(type);
+  }
+  dispose() {
+    super.dispose(), this._customHyperLinks.clear();
+  }
+};
+__name(_SheetsHyperLinkSidePanelService, "SheetsHyperLinkSidePanelService");
+let SheetsHyperLinkSidePanelService = _SheetsHyperLinkSidePanelService;
 var jsxRuntime = { exports: {} }, reactJsxRuntime_production_min = {};
 /**
  * @license React
@@ -266,8 +297,8 @@ function getContainRange(range, worksheet) {
 __name(getContainRange, "getContainRange");
 var _a4;
 let SheetsHyperLinkResolverService = (_a4 = class {
-  constructor(_univerInstanceService, _commandService, _definedNamesService, _messageService, _localeService) {
-    this._univerInstanceService = _univerInstanceService, this._commandService = _commandService, this._definedNamesService = _definedNamesService, this._messageService = _messageService, this._localeService = _localeService;
+  constructor(_urlHandler, _univerInstanceService, _commandService, _definedNamesService, _messageService, _localeService) {
+    this._urlHandler = _urlHandler, this._univerInstanceService = _univerInstanceService, this._commandService = _commandService, this._definedNamesService = _definedNamesService, this._messageService = _messageService, this._localeService = _localeService;
   }
   _getURLName(params) {
     var _a14;
@@ -409,15 +440,18 @@ let SheetsHyperLinkResolverService = (_a4 = class {
     return this._definedNamesService.focusRange(unitId, rangeid), !0;
   }
   async navigateToOtherWebsite(url) {
+    var _a14;
+    if ((_a14 = this._urlHandler) != null && _a14.navigateToOtherWebsite)
+      return this._urlHandler.navigateToOtherWebsite(url);
     window.open(url, "_blank", "noopener noreferrer");
   }
 }, __name(_a4, "SheetsHyperLinkResolverService"), _a4);
 SheetsHyperLinkResolverService = __decorateClass$9([
-  __decorateParam$9(0, IUniverInstanceService),
-  __decorateParam$9(1, ICommandService),
-  __decorateParam$9(2, IDefinedNamesService),
-  __decorateParam$9(3, IMessageService),
-  __decorateParam$9(4, Inject(LocaleService))
+  __decorateParam$9(1, IUniverInstanceService),
+  __decorateParam$9(2, ICommandService),
+  __decorateParam$9(3, IDefinedNamesService),
+  __decorateParam$9(4, IMessageService),
+  __decorateParam$9(5, Inject(LocaleService))
 ], SheetsHyperLinkResolverService);
 function isLegalLink(link) {
   return Tools.isLegalUrl(link);
@@ -433,7 +467,13 @@ function isEmail(url) {
 __name(isEmail, "isEmail");
 function serializeUrl(urlStr) {
   if (isLegalLink(urlStr)) {
-    const transformedUrl = hasProtocol(urlStr) ? urlStr : isEmail(urlStr) ? `mailto://${urlStr}` : `http://${urlStr}`, url = new URL(transformedUrl);
+    const transformedUrl = hasProtocol(urlStr) ? urlStr : isEmail(urlStr) ? `mailto://${urlStr}` : `http://${urlStr}`;
+    let url;
+    try {
+      url = new URL(transformedUrl);
+    } catch {
+      return urlStr;
+    }
     return url.hostname === location.hostname && url.port === location.port && url.protocol === location.protocol && url.pathname === location.pathname && url.hash && !url.search ? url.hash : transformedUrl;
   }
   return urlStr;
@@ -456,37 +496,36 @@ const cellLinkEditButtons = "univer-cell-link-edit-buttons", styles$1 = {
   cellLinkEditButtons
 }, CellLinkEdit = /* @__PURE__ */ __name(() => {
   var _a14;
-  const [id, setId] = useState(""), [display, setDisplay] = useState(""), [type, setType] = useState(
-    "link"
-    /* link */
-  ), [payload, setPayload] = useState(""), localeService = useDependency(LocaleService), definedNameService = useDependency(IDefinedNamesService), univerInstanceService = useDependency(IUniverInstanceService), popupService = useDependency(SheetsHyperLinkPopupService), editing = useObservable(popupService.currentEditing$), hyperLinkModel = useDependency(HyperLinkModel), resolverService = useDependency(SheetsHyperLinkResolverService), commandService = useDependency(ICommandService), [showError, setShowError] = useState(!1), setByPayload = useRef(!1);
+  const [id, setId] = useState(""), [display, setDisplay] = useState(""), [type, setType] = useState(LinkType.link), [payload, setPayload] = useState(""), localeService = useDependency(LocaleService), definedNameService = useDependency(IDefinedNamesService), univerInstanceService = useDependency(IUniverInstanceService), popupService = useDependency(SheetsHyperLinkPopupService), editing = useObservable(popupService.currentEditing$), hyperLinkModel = useDependency(HyperLinkModel), resolverService = useDependency(SheetsHyperLinkResolverService), commandService = useDependency(ICommandService), sidePanelService = useDependency(SheetsHyperLinkSidePanelService), sidePanelOptions = useMemo(() => sidePanelService.getOptions(), [sidePanelService]), customHyperLinkSidePanel = useMemo(() => {
+    if (!sidePanelService.isBuiltInLinkType(type))
+      return sidePanelService.getCustomHyperLink(type);
+  }, [sidePanelService, type]), [showError, setShowError] = useState(!1), setByPayload = useRef(!1);
   useEffect(() => {
     var _a15, _b, _c;
     if ((editing == null ? void 0 : editing.row) !== void 0 && editing.column !== void 0) {
       const link = hyperLinkModel.getHyperLinkByLocationSync(editing.unitId, editing.subUnitId, editing.row, editing.column);
       if (link) {
+        setId(link.id);
+        const customLink = sidePanelService.findCustomHyperLink(link);
+        if (customLink) {
+          const customLinkInfo = customLink.convert(link);
+          setType(customLinkInfo.type), setPayload(customLinkInfo.payload), setDisplay(customLinkInfo.display);
+          return;
+        }
+        setDisplay(link.display);
         const linkInfo = resolverService.parseHyperLink(link.payload);
-        if (setId(link.id), setDisplay(link.display), linkInfo.type === "outer") {
-          setType(
-            "link"
-            /* link */
-          ), setPayload(linkInfo.url), linkInfo.url === link.display && (setByPayload.current = !0);
+        if (linkInfo.type === "outer") {
+          setType(LinkType.link), setPayload(linkInfo.url), linkInfo.url === link.display && (setByPayload.current = !0);
           return;
         } else {
           const params = linkInfo.searchObj;
           if (params.rangeid) {
-            setType(
-              "rangeid"
-              /* definedName */
-            ), setPayload(params.rangeid);
+            setType(LinkType.definedName), setPayload(params.rangeid);
             return;
           }
           if (params.range) {
             const sheetName = params.gid && (_c = (_b = (_a15 = univerInstanceService.getUnit(editing.unitId)) == null ? void 0 : _a15.getSheetBySheetId(params.gid)) == null ? void 0 : _b.getName()) != null ? _c : "";
-            if (setType(
-              "range"
-              /* range */
-            ), params.range === ERROR_RANGE)
+            if (setType(LinkType.range), params.range === ERROR_RANGE)
               setPayload("");
             else {
               const payload2 = serializeRangeWithSheet(sheetName, deserializeRangeWithSheet(params.range).range);
@@ -495,47 +534,35 @@ const cellLinkEditButtons = "univer-cell-link-edit-buttons", styles$1 = {
             return;
           }
           if (params.gid) {
-            setType(
-              "gid"
-              /* sheet */
-            ), setPayload(params.gid);
+            setType(LinkType.sheet), setPayload(params.gid);
             return;
           }
         }
       }
       const workbook2 = univerInstanceService.getUnit(editing.unitId), worksheet = workbook2 == null ? void 0 : workbook2.getSheetBySheetId(editing.subUnitId), cell = worksheet == null ? void 0 : worksheet.getCellRaw(editing.row, editing.column), cellValue = getCellValueOrigin(cell);
-      setType(
-        "link"
-        /* link */
-      ), setPayload(""), setDisplay((cellValue != null ? cellValue : "").toString()), setId("");
+      setType(LinkType.link), setPayload(""), setDisplay((cellValue != null ? cellValue : "").toString()), setId("");
       return;
     }
-    setType(
-      "link"
-      /* link */
-    ), setPayload(""), setDisplay(""), setId("");
+    setType(LinkType.link), setPayload(""), setDisplay(""), setId("");
   }, [editing, hyperLinkModel, resolverService, univerInstanceService]);
   const payloadInitial = useMemo(() => payload, [type]), linkTypeOptions = [
     {
       label: localeService.t("hyperLink.form.link"),
-      value: "link"
-      /* link */
+      value: LinkType.link
     },
     {
       label: localeService.t("hyperLink.form.range"),
-      value: "range"
-      /* range */
+      value: LinkType.range
     },
     {
       label: localeService.t("hyperLink.form.worksheet"),
-      value: "gid"
-      /* sheet */
+      value: LinkType.sheet
     },
     {
       label: localeService.t("hyperLink.form.definedName"),
-      value: "rangeid"
-      /* definedName */
-    }
+      value: LinkType.definedName
+    },
+    ...sidePanelOptions
   ], workbook = univerInstanceService.getCurrentUnitForType(UniverInstanceType.UNIVER_SHEET);
   if (!workbook)
     return;
@@ -543,9 +570,9 @@ const cellLinkEditButtons = "univer-cell-link-edit-buttons", styles$1 = {
     label: value.name,
     value: value.id
   })), formatUrl = /* @__PURE__ */ __name((type2, payload2) => {
-    if (type2 === "link")
+    if (type2 === LinkType.link)
       return serializeUrl(payload2);
-    if (type2 === "range") {
+    if (type2 === LinkType.range) {
       const info = deserializeRangeWithSheet(payload2), worksheet = workbook.getSheetBySheetName(info.sheetName);
       if (worksheet)
         return `#gid=${worksheet.getSheetId()}&range=${serializeRange(info.range)}`;
@@ -623,7 +650,7 @@ const cellLinkEditButtons = "univer-cell-link-edit-buttons", styles$1 = {
         }, "onChange")
       }
     ) }),
-    type === "link" && /* @__PURE__ */ jsxRuntimeExports.jsx(
+    type === LinkType.link && /* @__PURE__ */ jsxRuntimeExports.jsx(
       FormLayout,
       {
         error: showError ? payload ? isLegalLink(payload) ? "" : localeService.t("hyperLink.form.linkError") : localeService.t("hyperLink.form.inputError") : "",
@@ -639,7 +666,7 @@ const cellLinkEditButtons = "univer-cell-link-edit-buttons", styles$1 = {
         )
       }
     ),
-    type === "range" && /* @__PURE__ */ jsxRuntimeExports.jsx(FormLayout, { error: showError && !payload ? localeService.t("hyperLink.form.inputError") : "", children: /* @__PURE__ */ jsxRuntimeExports.jsx(
+    type === LinkType.range && /* @__PURE__ */ jsxRuntimeExports.jsx(FormLayout, { error: showError && !payload ? localeService.t("hyperLink.form.inputError") : "", children: /* @__PURE__ */ jsxRuntimeExports.jsx(
       RangeSelector,
       {
         openForSheetUnitId: workbook.getUnitId(),
@@ -649,7 +676,7 @@ const cellLinkEditButtons = "univer-cell-link-edit-buttons", styles$1 = {
         onChange: handleRangeChange
       }
     ) }),
-    type === "gid" && /* @__PURE__ */ jsxRuntimeExports.jsx(FormLayout, { error: showError && !payload ? localeService.t("hyperLink.form.selectError") : "", children: /* @__PURE__ */ jsxRuntimeExports.jsx(
+    type === LinkType.sheet && /* @__PURE__ */ jsxRuntimeExports.jsx(FormLayout, { error: showError && !payload ? localeService.t("hyperLink.form.selectError") : "", children: /* @__PURE__ */ jsxRuntimeExports.jsx(
       Select,
       {
         options: sheetsOption,
@@ -662,7 +689,7 @@ const cellLinkEditButtons = "univer-cell-link-edit-buttons", styles$1 = {
         }, "onChange")
       }
     ) }),
-    type === "rangeid" && /* @__PURE__ */ jsxRuntimeExports.jsx(FormLayout, { error: showError && !payload ? localeService.t("hyperLink.form.selectError") : "", children: /* @__PURE__ */ jsxRuntimeExports.jsx(
+    type === LinkType.definedName && /* @__PURE__ */ jsxRuntimeExports.jsx(FormLayout, { error: showError && !payload ? localeService.t("hyperLink.form.selectError") : "", children: /* @__PURE__ */ jsxRuntimeExports.jsx(
       Select,
       {
         options: definedNames,
@@ -675,6 +702,20 @@ const cellLinkEditButtons = "univer-cell-link-edit-buttons", styles$1 = {
         }, "onChange")
       }
     ) }),
+    (customHyperLinkSidePanel == null ? void 0 : customHyperLinkSidePanel.Form) && /* @__PURE__ */ jsxRuntimeExports.jsx(
+      customHyperLinkSidePanel.Form,
+      {
+        linkId: id,
+        payload,
+        display,
+        showError,
+        setByPayload,
+        setDisplay: /* @__PURE__ */ __name((newLink) => {
+          setDisplay(newLink), setByPayload.current = !0;
+        }, "setDisplay"),
+        setPayload
+      }
+    ),
     /* @__PURE__ */ jsxRuntimeExports.jsxs("div", { className: styles$1.cellLinkEditButtons, children: [
       /* @__PURE__ */ jsxRuntimeExports.jsx(
         Button,
@@ -694,7 +735,7 @@ const cellLinkEditButtons = "univer-cell-link-edit-buttons", styles$1 = {
           type: "primary",
           style: { marginLeft: 8 },
           onClick: /* @__PURE__ */ __name(async () => {
-            if (!display || !payload || type === "link" && !isLegalLink(payload)) {
+            if (!display || !payload || type === LinkType.link && !isLegalLink(payload)) {
               setShowError(!0);
               return;
             }
@@ -1303,52 +1344,49 @@ let SheetsHyperLinkAutoFillController = (_a9 = class extends Disposable {
               endRow: row
             },
             sourceRange2
-          ), { row: sourceRow, col: sourceCol } = mapFunc(sourcePositionRange.startRow, sourcePositionRange.startColumn), link = this._hyperLinkModel.getHyperLinkByLocation(unitId, subUnitId, sourceRow, sourceCol);
-          if (link) {
-            const targetPositionRange = Rectangle.getPositionRange(
-              {
-                startRow: row,
-                startColumn: col,
-                endColumn: col,
-                endRow: row
-              },
-              targetRange2
-            ), { row: targetRow, col: targetCol } = mapFunc(targetPositionRange.startRow, targetPositionRange.startColumn), id = Tools.generateRandomId(), currentLink = this._hyperLinkModel.getHyperLinkByLocation(unitId, subUnitId, targetRow, targetCol);
-            currentLink && redos.push({
-              id: RemoveHyperLinkMutation.id,
-              params: {
-                unitId,
-                subUnitId,
-                id: currentLink.id
-              }
-            }), (APPLY_TYPE.COPY === applyType || APPLY_TYPE.SERIES === applyType) && (redos.push({
-              id: AddHyperLinkMutation.id,
-              params: {
-                unitId,
-                subUnitId,
-                link: {
-                  ...link,
-                  id,
-                  row: targetRow,
-                  column: targetCol
-                }
-              }
-            }), undos.push({
-              id: RemoveHyperLinkMutation.id,
-              params: {
-                unitId,
-                subUnitId,
-                id
-              }
-            })), currentLink && undos.push({
-              id: AddHyperLinkMutation.id,
-              params: {
-                unitId,
-                subUnitId,
-                link: currentLink
+          ), { row: sourceRow, col: sourceCol } = mapFunc(sourcePositionRange.startRow, sourcePositionRange.startColumn), link = this._hyperLinkModel.getHyperLinkByLocation(unitId, subUnitId, sourceRow, sourceCol), targetPositionRange = Rectangle.getPositionRange(
+            {
+              startRow: row,
+              startColumn: col,
+              endColumn: col,
+              endRow: row
+            },
+            targetRange2
+          ), { row: targetRow, col: targetCol } = mapFunc(targetPositionRange.startRow, targetPositionRange.startColumn), id = Tools.generateRandomId(), currentLink = this._hyperLinkModel.getHyperLinkByLocation(unitId, subUnitId, targetRow, targetCol);
+          currentLink && redos.push({
+            id: RemoveHyperLinkMutation.id,
+            params: {
+              unitId,
+              subUnitId,
+              id: currentLink.id
+            }
+          }), (APPLY_TYPE.COPY === applyType || APPLY_TYPE.SERIES === applyType) && link && (redos.push({
+            id: AddHyperLinkMutation.id,
+            params: {
+              unitId,
+              subUnitId,
+              link: {
+                ...link,
+                id,
+                row: targetRow,
+                column: targetCol
               }
-            });
-          }
+            }
+          }), undos.push({
+            id: RemoveHyperLinkMutation.id,
+            params: {
+              unitId,
+              subUnitId,
+              id
+            }
+          })), currentLink && undos.push({
+            id: AddHyperLinkMutation.id,
+            params: {
+              unitId,
+              subUnitId,
+              link: currentLink
+            }
+          });
         });
       }), {
         undos,
@@ -1374,8 +1412,21 @@ var __defProp$3 = Object.defineProperty, __getOwnPropDesc$3 = Object.getOwnPrope
 let SheetsHyperLinkCopyPasteController = (_a10 = class extends Disposable {
   constructor(_sheetClipboardService, _hyperLinkModel, _injector, _resolverService) {
     super();
+    __publicField(this, "_plainTextFilter", /* @__PURE__ */ new Set());
     __publicField(this, "_copyInfo");
-    this._sheetClipboardService = _sheetClipboardService, this._hyperLinkModel = _hyperLinkModel, this._injector = _injector, this._resolverService = _resolverService, this._initCopyPaste();
+    this._sheetClipboardService = _sheetClipboardService, this._hyperLinkModel = _hyperLinkModel, this._injector = _injector, this._resolverService = _resolverService, this._initCopyPaste(), this.disposeWithMe(() => {
+      this._plainTextFilter.clear();
+    });
+  }
+  registerPlainTextFilter(filter) {
+    this._plainTextFilter.add(filter);
+  }
+  removePlainTextFilter(filter) {
+    this._plainTextFilter.delete(filter);
+  }
+  /* If return false the process of paste text will be stop */
+  _filterPlainText(text) {
+    return Array.from(this._plainTextFilter).every((filter) => filter(text));
   }
   _initCopyPaste() {
     this._sheetClipboardService.addClipboardHook({
@@ -1386,7 +1437,8 @@ let SheetsHyperLinkCopyPasteController = (_a10 = class extends Disposable {
         return this._generateMutations(pastedRange, { copyType, pasteType, copyRange, unitId, subUnitId });
       }, "onPasteCells"),
       onPastePlainText: /* @__PURE__ */ __name((pasteTo, clipText) => {
-        if (isLegalLink(clipText)) {
+        const filterResult = this._filterPlainText(clipText);
+        if (isLegalLink(clipText) && filterResult) {
           const text = serializeUrl(clipText), { range, unitId, subUnitId } = pasteTo, { ranges: [pasteToRange], mapFunc } = virtualizeDiscreteRanges([range]), redos = [], undos = [];
           return Range.foreach(pasteToRange, (originRow, originCol) => {
             const { row, col: column } = mapFunc(originRow, originCol), link = this._hyperLinkModel.getHyperLinkByLocation(unitId, subUnitId, row, column);
@@ -1429,7 +1481,8 @@ let SheetsHyperLinkCopyPasteController = (_a10 = class extends Disposable {
           }), { redos, undos };
         }
         return { undos: [], redos: [] };
-      }, "onPastePlainText")
+      }, "onPastePlainText"),
+      priority: 99
     });
   }
   _collect(unitId, subUnitId, range) {
@@ -1582,8 +1635,17 @@ let UniverSheetsHyperLinkUIPlugin = (_a13 = class extends Plugin {
   }
   onStarting() {
     [
-      [SheetsHyperLinkResolverService],
+      [
+        SheetsHyperLinkResolverService,
+        {
+          useFactory: /* @__PURE__ */ __name(() => {
+            var _a14;
+            return this._injector.createInstance(SheetsHyperLinkResolverService, (_a14 = this._config) == null ? void 0 : _a14.urlHandler);
+          }, "useFactory")
+        }
+      ],
       [SheetsHyperLinkPopupService],
+      [SheetsHyperLinkSidePanelService],
       [SheetsHyperLinkRemoveSheetController],
       [SheetsHyperLinkRenderManagerController],
       [SheetHyperLinkSetRangeController],
@@ -1628,6 +1690,7 @@ export {
   SheetsHyperLinkRenderController,
   SheetsHyperLinkRenderManagerController,
   SheetsHyperLinkResolverService,
+  SheetsHyperLinkSidePanelService,
   SheetsHyperLinkUIController,
   UniverSheetsHyperLinkUIPlugin
 };

package/lib/types/controllers/copy-paste.controller.d.ts

@@ -8,6 +8,10 @@ export declare class SheetsHyperLinkCopyPasteController extends Disposable {
     private _hyperLinkModel;
     private _injector;
     private _resolverService;
+    private _plainTextFilter;
+    registerPlainTextFilter(filter: (text: string) => boolean): void;
+    removePlainTextFilter(filter: (text: string) => boolean): void;
+    private _filterPlainText;
     private _copyInfo;
     constructor(_sheetClipboardService: ISheetClipboardService, _hyperLinkModel: HyperLinkModel, _injector: Injector, _resolverService: SheetsHyperLinkResolverService);
     private _initCopyPaste;

package/lib/types/controllers/ui.controller.d.ts

@@ -1,9 +1,7 @@
-import { Disposable, ICommandService, Injector, LocaleService } from '@univerjs/core';
-import { MenuConfig, ComponentManager, IMenuService, IShortcutService } from '@univerjs/ui';
+import { Nullable, Disposable, ICommandService, Injector, LocaleService } from '@univerjs/core';
+import { ComponentManager, IMenuService, IShortcutService } from '@univerjs/ui';
+import { IUniverSheetsHyperLinkUIConfig } from '../types/interfaces/i-config';
 
-export interface IUniverSheetsHyperLinkUIConfig {
-    menu?: MenuConfig;
-}
 export declare class SheetsHyperLinkUIController extends Disposable {
     private _config;
     private _componentManager;
@@ -12,7 +10,7 @@ export declare class SheetsHyperLinkUIController extends Disposable {
     private _menuService;
     private _injector;
     private _shortcutService;
-    constructor(_config: IUniverSheetsHyperLinkUIConfig | undefined, _componentManager: ComponentManager, _commandService: ICommandService, _localeService: LocaleService, _menuService: IMenuService, _injector: Injector, _shortcutService: IShortcutService);
+    constructor(_config: Nullable<IUniverSheetsHyperLinkUIConfig>, _componentManager: ComponentManager, _commandService: ICommandService, _localeService: LocaleService, _menuService: IMenuService, _injector: Injector, _shortcutService: IShortcutService);
     private _initComponents;
     private _initCommands;
     private _initMenus;

package/lib/types/index.d.ts

@@ -15,6 +15,7 @@
  */
 export { SheetsHyperLinkRemoveSheetController } from './controllers/remove-sheet.controller';
 export { SheetsHyperLinkRenderManagerController, SheetsHyperLinkRenderController } from './controllers/render-controllers/render.controller';
+export { SheetsHyperLinkSidePanelService, type ICustomHyperLinkView } from './services/side-panel.service';
 export { SheetsHyperLinkPopupService } from './services/popup.service';
 export { SheetsHyperLinkResolverService } from './services/resolver.service';
 export { SheetHyperLinkSetRangeController } from './controllers/set-range.controller';
@@ -25,4 +26,5 @@ export { SheetsHyperLinkCopyPasteController } from './controllers/copy-paste.con
 export { SheetHyperLinkUrlController } from './controllers/url.controller';
 export { UniverSheetsHyperLinkUIPlugin } from './plugin';
 export { InsertLinkShortcut } from './controllers/menu';
+export type { IUrlHandler, IUniverSheetsHyperLinkUIConfig } from './types/interfaces/i-config';
 export { OpenHyperLinkSidebarOperation, InsertHyperLinkOperation, CloseHyperLinkSidebarOperation, type IOpenHyperLinkSidebarOperationParams, } from './commands/operations/sidebar.operations';

package/lib/types/plugin.d.ts

@@ -1,6 +1,6 @@
-import { Injector, Plugin, UniverInstanceType } from '@univerjs/core';
+import { Nullable, Injector, Plugin, UniverInstanceType } from '@univerjs/core';
 import { IRenderManagerService } from '@univerjs/engine-render';
-import { IUniverSheetsHyperLinkUIConfig } from './controllers/ui.controller';
+import { IUniverSheetsHyperLinkUIConfig } from './types/interfaces/i-config';
 
 export declare class UniverSheetsHyperLinkUIPlugin extends Plugin {
     private _config;
@@ -8,7 +8,7 @@ export declare class UniverSheetsHyperLinkUIPlugin extends Plugin {
     private readonly _renderManagerService;
     static pluginName: string;
     static type: UniverInstanceType;
-    constructor(_config: IUniverSheetsHyperLinkUIConfig, _injector: Injector, _renderManagerService: IRenderManagerService);
+    constructor(_config: Nullable<IUniverSheetsHyperLinkUIConfig>, _injector: Injector, _renderManagerService: IRenderManagerService);
     onStarting(): void;
     onReady(): void;
 }

package/lib/types/services/resolver.service.d.ts

@@ -1,19 +1,27 @@
-import { IRange, Worksheet, ICommandService, IUniverInstanceService, LocaleService } from '@univerjs/core';
+import { IRange, Nullable, Worksheet, ICommandService, IUniverInstanceService, LocaleService } from '@univerjs/core';
 import { IDefinedNamesService } from '@univerjs/engine-formula';
 import { IMessageService } from '@univerjs/ui';
+import { IUrlHandler } from '../types/interfaces/i-config';
 
 interface ISheetUrlParams {
     gid?: string;
     range?: string;
     rangeid?: string;
 }
+export interface IHyperLinkInfo<T extends string> {
+    type: T;
+    name: string;
+    url: string;
+    handler: () => void;
+}
 export declare class SheetsHyperLinkResolverService {
+    private _urlHandler;
     private _univerInstanceService;
     private _commandService;
     private _definedNamesService;
     private _messageService;
     private _localeService;
-    constructor(_univerInstanceService: IUniverInstanceService, _commandService: ICommandService, _definedNamesService: IDefinedNamesService, _messageService: IMessageService, _localeService: LocaleService);
+    constructor(_urlHandler: Nullable<IUrlHandler>, _univerInstanceService: IUniverInstanceService, _commandService: ICommandService, _definedNamesService: IDefinedNamesService, _messageService: IMessageService, _localeService: LocaleService);
     private _getURLName;
     navigateTo(params: ISheetUrlParams): void;
     parseHyperLink(urlStr: string): {

package/lib/types/services/side-panel.service.d.ts

@@ -0,0 +1,46 @@
+import { Disposable } from '@univerjs/core';
+import { ICellHyperLink } from '@univerjs/sheets-hyper-link';
+import { default as React } from 'react';
+
+export interface CustomHyperLinkFormProps {
+    linkId: string;
+    payload: string;
+    display: string;
+    setByPayload: React.MutableRefObject<boolean>;
+    showError: boolean;
+    setDisplay: (display: string) => void;
+    setPayload: (payload: string) => void;
+}
+export interface ICustomHyperLinkView {
+    type: string;
+    option: {
+        label: string;
+        value: string;
+    };
+    Form: React.FC<CustomHyperLinkFormProps>;
+    convert: (link: ICellHyperLink) => {
+        display: string;
+        payload: string;
+        type: string;
+    };
+    match: (link: ICellHyperLink) => boolean;
+}
+export declare enum LinkType {
+    link = "link",
+    range = "range",
+    sheet = "gid",
+    definedName = "rangeid"
+}
+export declare class SheetsHyperLinkSidePanelService extends Disposable {
+    private _customHyperLinks;
+    isBuiltInLinkType(type: string): boolean;
+    getOptions(): {
+        label: string;
+        value: string;
+    }[];
+    findCustomHyperLink(link: ICellHyperLink): ICustomHyperLinkView | undefined;
+    registerCustomHyperLink(customHyperLink: ICustomHyperLinkView): void;
+    getCustomHyperLink(type: string): ICustomHyperLinkView | undefined;
+    removeCustomHyperLink(type: string): void;
+    dispose(): void;
+}

package/lib/types/types/interfaces/i-config.d.ts

@@ -0,0 +1,9 @@
+import { MenuConfig } from '@univerjs/ui';
+
+export interface IUrlHandler {
+    navigateToOtherWebsite?: (url: string) => void;
+}
+export interface IUniverSheetsHyperLinkUIConfig {
+    menu?: MenuConfig;
+    urlHandler?: IUrlHandler;
+}