Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

fix(ui): make component overrides order-independent (#7830)

白熱d7ac17fe1407
diff --git a/packages/docs-ui/src/controllers/components.controller.ts b/packages/docs-ui/src/controllers/components.controller.ts
index 4967ed94b8..c4ca8575da 100644
--- a/packages/docs-ui/src/controllers/components.controller.ts
+++ b/packages/docs-ui/src/controllers/components.controller.ts
@@ -235,7 +235,7 @@ export class ComponentsController extends Disposable {
private _registerComponents(): void {
this.disposeWithMe(this._componentManager.register(DOC_HEADER_FOOTER_RIBBON_CONTROL, DocHeaderFooterRibbonControl));
- if (!this._componentManager.get(COMPONENT_DOC_HEADER_FOOTER_PANEL)) {
+ if (!this._componentManager.hasDefault(COMPONENT_DOC_HEADER_FOOTER_PANEL)) {
this.disposeWithMe(this._componentManager.register(COMPONENT_DOC_HEADER_FOOTER_PANEL, DocHeaderFooterPanel));
}
diff --git a/packages/drawing-ui/src/index.ts b/packages/drawing-ui/src/index.ts
index 460d9e740c..66278abcfc 100644
--- a/packages/drawing-ui/src/index.ts
+++ b/packages/drawing-ui/src/index.ts
@@ -66,7 +66,7 @@ export {
COMPONENT_IMAGE_POPUP_MENU,
COMPONENT_MOBILE_IMAGE_POPUP_MENU,
} from './views/image-popup-menu/component-name';
-export type { IImagePopupMenuItem } from './views/image-popup-menu/ImagePopupMenu';
+export type { IImagePopupMenuItem, IImagePopupMenuProps } from './views/image-popup-menu/ImagePopupMenu';
export { MobileObjectListPanel } from './views/object-list-panel/MobileObjectListPanel';
export {
getObjectListPanelSectionIdForDrawingType,
diff --git a/packages/sheets-conditional-formatting-ui/src/index.ts b/packages/sheets-conditional-formatting-ui/src/index.ts
index c237d2c331..c16f588b5f 100644
--- a/packages/sheets-conditional-formatting-ui/src/index.ts
+++ b/packages/sheets-conditional-formatting-ui/src/index.ts
@@ -28,7 +28,9 @@ export { AddTimePeriodCfCommand } from './commands/commands/add-time-period-cf.c
export { AddUniqueValuesCfCommand } from './commands/commands/add-unique-values-cf.command';
export { OpenConditionalFormattingOperator } from './commands/operations/open-conditional-formatting-panel';
export type { IUniverSheetsConditionalFormattingUIConfig } from './config/config';
+export { CF_PANEL_KEY } from './const';
export { ConditionalFormattingClearController } from './controllers/cf.clear.controller';
export { menuSchema as SheetsConditionalFormattingUIMenuSchema } from './menu/schema';
export { UniverSheetsConditionalFormattingMobileUIPlugin } from './mobile-plugin';
export { UniverSheetsConditionalFormattingUIPlugin } from './plugin';
+export type { IConditionFormattingPanelProps } from './views/ConditionFormattingPanel';
diff --git a/packages/sheets-data-validation-ui/src/index.ts b/packages/sheets-data-validation-ui/src/index.ts
index 2b8b9154e8..915a02f41e 100644
--- a/packages/sheets-data-validation-ui/src/index.ts
+++ b/packages/sheets-data-validation-ui/src/index.ts
@@ -16,7 +16,9 @@
import './global.css';
+export { DATA_VALIDATION_PANEL } from './commands/operations/data-validation.operation';
export type { IUniverSheetsDataValidationUIConfig } from './config/config';
export { menuSchema as SheetsDataValidationUIMenuSchema } from './menu/schema';
export { UniverSheetsDataValidationMobileUIPlugin } from './mobile-plugin';
export { UniverSheetsDataValidationUIPlugin } from './plugin';
+export { DataValidationPanelService } from './services/data-validation-panel.service';
diff --git a/packages/sheets-formula-ui/src/index.ts b/packages/sheets-formula-ui/src/index.ts
index c971fdb158..4b5129bb91 100644
--- a/packages/sheets-formula-ui/src/index.ts
+++ b/packages/sheets-formula-ui/src/index.ts
@@ -37,6 +37,7 @@ export type { IShowRangeSelectorDialogOptions } from './services/range-selector.
export { RefSelectionsRenderService } from './services/render-services/ref-selections.render.service';
export { FormulaEditor } from './views/formula-editor/index';
export type { IFormulaEditorRef } from './views/formula-editor/index';
+export { MORE_FUNCTIONS_COMPONENT } from './views/more-functions/interface';
export { RangeSelector } from './views/range-selector/index';
export type { IRangeSelectorInstance, IRangeSelectorProps } from './views/range-selector/index';
export { MobileRangeSelector } from './views/range-selector/MobileRangeSelector';
diff --git a/packages/sheets-ui/src/index.ts b/packages/sheets-ui/src/index.ts
index b8b0847a69..ef102ceac7 100644
--- a/packages/sheets-ui/src/index.ts
+++ b/packages/sheets-ui/src/index.ts
@@ -295,6 +295,7 @@ export {
export { AutoFillPopupMenu } from './views/auto-fill-popup-menu/AutoFillPopupMenu';
export { BorderLine } from './views/border-panel/border-line/BorderLine';
export { BORDER_LINE_CHILDREN, BORDER_SIZE_CHILDREN } from './views/border-panel/interface';
+export { DEFINED_NAME_CONTAINER } from './views/defined-name/component-name';
export { EditorContainer, useKeyEventConfig } from './views/editor-container';
export { FormulaBar } from './views/formula-bar';
export { useActiveWorkbook, useActiveWorksheet, useWorkbooks } from './views/hook';
diff --git a/packages/ui/src/common/__tests__/component-manager.spec.ts b/packages/ui/src/common/__tests__/component-manager.spec.ts
index 1165aa1732..8e31ae44d7 100644
--- a/packages/ui/src/common/__tests__/component-manager.spec.ts
+++ b/packages/ui/src/common/__tests__/component-manager.spec.ts
@@ -14,123 +14,162 @@
* limitations under the License.
*/
-import type { ILogService } from '@univerjs/core';
-import { afterEach, describe, expect, it, vi } from 'vitest';
+import { Injector } from '@univerjs/core';
+import { afterEach, beforeEach, describe, expect, it } from 'vitest';
import { ComponentManager } from '../component-manager';
-function createLogService(): ILogService {
- return {
- debug: vi.fn(),
- log: vi.fn(),
- warn: vi.fn(),
- error: vi.fn(),
- deprecate: vi.fn(),
- setLogLevel: vi.fn(),
- };
-}
-
describe('ComponentManager', () => {
- afterEach(() => {
- vi.restoreAllMocks();
- });
+ let injector: Injector;
- it('should not expose built-in icons and should expose react utils', () => {
- const logService = createLogService();
- const manager = new ComponentManager(logService);
-
- expect(manager.get('ShortcutIcon')).toBeUndefined();
- expect(manager.reactUtils.createElement).toBeTypeOf('function');
- expect(manager.reactUtils.useEffect).toBeTypeOf('function');
- expect(manager.reactUtils.useRef).toBeTypeOf('function');
+ beforeEach(() => {
+ injector = new Injector([[ComponentManager]]);
+ });
- manager.dispose();
- expect(manager.get('ShortcutIcon')).toBeUndefined();
+ afterEach(() => {
+ injector.dispose();
});
- it('should register default react component and support get/delete/disposable', () => {
- const logService = createLogService();
- const manager = new ComponentManager(logService);
- const Comp = () => null;
+ it.each([true, false])('keeps the host override regardless of registration order (built-in first: %s)', (builtInFirst) => {
+ const manager = injector.get(ComponentManager);
+ const BuiltInPanel = () => null;
+ const HostPanel = () => null;
+
+ if (builtInFirst) {
+ manager.register('panel', BuiltInPanel);
+ }
+ const override = manager.register('panel', HostPanel, { override: true });
+ if (!builtInFirst) {
+ manager.register('panel', BuiltInPanel);
+ }
+
+ expect(manager.get('panel')).toBe(HostPanel);
+ override.dispose();
+ expect(manager.get('panel')).toBe(BuiltInPanel);
+ });
- const disposable = manager.register('test-comp', Comp);
+ it('restores the latest live default without letting an old registration remove it', () => {
+ const manager = injector.get(ComponentManager);
+ const OldPanel = () => null;
+ const CurrentPanel = () => null;
+ const HostPanel = () => null;
+ const oldDefault = manager.register('panel', OldPanel);
+ const override = manager.register('panel', HostPanel, { override: true });
+ manager.register('panel', CurrentPanel);
- expect(manager.get('test-comp')).toBe(Comp);
- expect('getKey' in manager).toBe(false);
+ oldDefault.dispose();
+ override.dispose();
- manager.delete('test-comp');
- expect(manager.get('test-comp')).toBeUndefined();
+ expect(manager.get('panel')).toBe(CurrentPanel);
+ });
- manager.register('test-comp', Comp);
- disposable.dispose();
- expect(manager.get('test-comp')).toBeUndefined();
+ it('rejects a competing host override without replacing the active override', () => {
+ const manager = injector.get(ComponentManager);
+ const HostPanel = () => null;
+ const CompetingPanel = () => null;
+ manager.register('panel', HostPanel, { override: true });
- manager.dispose();
+ expect(() => manager.register('panel', CompetingPanel, { override: true })).toThrow(
+ '[ComponentManager] Component panel already has an override.'
+ );
+ expect(manager.get('panel')).toBe(HostPanel);
});
- it('should warn through log service when registering duplicate component', () => {
- const logService = createLogService();
- const manager = new ComponentManager(logService);
- const Comp = () => null;
+ it('detects defaults independently of overrides so conditional built-ins remain restorable', () => {
+ const manager = injector.get(ComponentManager);
+ const BuiltInPanel = () => null;
+ const override = manager.register('panel', () => null, { override: true });
+
+ expect(manager.hasDefault('panel')).toBe(false);
+ const defaultRegistration = manager.register('panel', BuiltInPanel);
+ expect(manager.hasDefault('panel')).toBe(true);
+ override.dispose();
+ expect(manager.get('panel')).toBe(BuiltInPanel);
+ defaultRegistration.dispose();
+ expect(manager.hasDefault('panel')).toBe(false);
+ });
- manager.register('dup-comp', Comp);
- manager.register('dup-comp', Comp);
+ it('does not restore a default that was unregistered while overridden', () => {
+ const manager = injector.get(ComponentManager);
+ const HostPanel = () => null;
+ const defaultRegistration = manager.register('panel', () => null);
+ const override = manager.register('panel', HostPanel, { override: true });
- expect(logService.warn).toHaveBeenCalledWith('[ComponentManager]', 'Component dup-comp already exists.');
+ defaultRegistration.dispose();
+ expect(manager.get('panel')).toBe(HostPanel);
+ override.dispose();
+ expect(manager.get('panel')).toBeUndefined();
+ });
- manager.dispose();
+ it('deletes only the default and preserves a replacement from an older disposable', () => {
+ const manager = injector.get(ComponentManager);
+ const BuiltInPanel = () => null;
+ const HostPanel = () => null;
+ const oldDefault = manager.register('panel', BuiltInPanel);
+ const override = manager.register('panel', HostPanel, { override: true });
+
+ manager.delete('panel');
+ expect(manager.get('panel')).toBe(HostPanel);
+ override.dispose();
+ expect(manager.get('panel')).toBeUndefined();
+
+ manager.register('panel', BuiltInPanel);
+ oldDefault.dispose();
+ expect(manager.get('panel')).toBe(BuiltInPanel);
});
- it('should allow direct construction without log service', () => {
- const manager = new ComponentManager();
- const Comp = () => null;
+ it('allows replacing a disposed override without an old handle removing the new one', () => {
+ const manager = injector.get(ComponentManager);
+ const HostPanel = () => null;
+ const firstOverride = manager.register('panel', HostPanel, { override: true });
+ firstOverride.dispose();
+ manager.register('panel', HostPanel, { override: true });
+ firstOverride.dispose();
- expect(() => {
- manager.register('dup-comp', Comp);
- manager.register('dup-comp', Comp);
- }).not.toThrow();
+ expect(manager.get('panel')).toBe(HostPanel);
+ });
- expect(manager.get('dup-comp')).toBe(Comp);
+ it('clears both registration layers when the manager is disposed', () => {
+ const manager = injector.get(ComponentManager);
+ manager.register('panel', () => null);
+ manager.register('panel', () => null, { override: true });
manager.dispose();
+
+ expect(manager.get('panel')).toBeUndefined();
});
- it('should throw when registering vue3 without handler', () => {
- const logService = createLogService();
- const manager = new ComponentManager(logService);
+ it('rejects Vue components when the Vue adapter is unavailable', () => {
+ const manager = injector.get(ComponentManager);
- expect(() => manager.register('vue-comp', () => null, { framework: 'vue3' })).toThrow(
+ expect(() => manager.register('vue-panel', () => null, { framework: 'vue3' })).toThrow(
'[ComponentManager] Vue3 support is no longer built-in since v0.9.0, please install @univerjs/ui-adapter-vue3 plugin.'
);
-
- manager.dispose();
+ expect(manager.get('vue-panel')).toBeUndefined();
});
- it('should use custom framework handler and throw when handler missing at get', () => {
- const logService = createLogService();
- const manager = new ComponentManager(logService);
- const CustomComp = () => null;
-
- manager.setHandler('custom', (component, name) => ({
- component,
- name,
- wrapped: true,
- }));
-
- manager.register('custom-comp', CustomComp, { framework: 'custom' });
- expect(manager.get('custom-comp')).toEqual({
- component: CustomComp,
- name: 'custom-comp',
- wrapped: true,
- });
-
- expect(() => manager.register('unknown-framework-comp', CustomComp, { framework: 'unknown' })).not.toThrow();
- expect(() => manager.get('unknown-framework-comp')).toThrow(
- '[ComponentManager] No handler found for framework: unknown'
- );
+ it('resolves components through the selected framework adapter', () => {
+ const manager = injector.get(ComponentManager);
+ const CustomPanel = () => null;
+ manager.setHandler('custom', (component, name) => ({ component, name }));
+ manager.register('custom-panel', CustomPanel, { framework: 'custom' });
+ expect(manager.get('custom-panel')).toEqual({ component: CustomPanel, name: 'custom-panel' });
+ manager.register('unknown-panel', CustomPanel, { framework: 'unknown' });
+ expect(() => manager.get('unknown-panel')).toThrow('[ComponentManager] No handler found for framework: unknown');
expect(manager.get('')).toBeUndefined();
- expect(manager.get('not-exists')).toBeUndefined();
+ expect(manager.get('missing-panel')).toBeUndefined();
+ });
- manager.dispose();
+ it('restores the default framework adapter after disposing an override', () => {
+ const manager = injector.get(ComponentManager);
+ const BuiltInPanel = () => null;
+ const HostPanel = () => null;
+ manager.setHandler('custom', (component) => ({ component }));
+ manager.register('panel', BuiltInPanel);
+ const override = manager.register('panel', HostPanel, { framework: 'custom', override: true });
+
+ expect(manager.get('panel')).toEqual({ component: HostPanel });
+ override.dispose();
+ expect(manager.get('panel')).toBe(BuiltInPanel);
});
});
diff --git a/packages/ui/src/common/component-manager.ts b/packages/ui/src/common/component-manager.ts
index db75b5ab20..bfd1dd24c8 100644
--- a/packages/ui/src/common/component-manager.ts
+++ b/packages/ui/src/common/component-manager.ts
@@ -22,6 +22,12 @@ type ComponentFramework = string;
export interface IComponentOptions {
framework?: ComponentFramework;
+ /**
+ * Whether this registration takes precedence over the built-in default, regardless of registration order.
+ * Defaults to false in ComponentManager and true in FUniver.registerComponent.
+ * Only one override may be active for each name.
+ */
+ override?: boolean;
}
export interface IComponent<T = any> {
@@ -34,30 +40,43 @@ export type ComponentType<T = any> = any;
export type ComponentList = Map<string, IComponent>;
export class ComponentManager extends Disposable {
- private _components: ComponentList = new Map();
+ private readonly _components: ComponentList = new Map();
+ private readonly _overrides: ComponentList = new Map();
constructor(@Optional(ILogService) private readonly _logService?: ILogService) {
super();
}
+ /**
+ * Register before the component is first rendered; mounted views do not subscribe to registry changes.
+ * Disposing an override reveals the current default, if it is still registered.
+ * @throws When another override is already registered for this name.
+ */
register(name: string, component: ComponentType, options?: IComponentOptions): IDisposable {
- const { framework = 'react' } = options || {};
+ const { framework = 'react', override = false } = options ?? {};
+ const components = override ? this._overrides : this._components;
if (framework === 'vue3' && !this._handler.vue3) {
throw new Error('[ComponentManager] Vue3 support is no longer built-in since v0.9.0, please install @univerjs/ui-adapter-vue3 plugin.');
}
- if (this._components.has(name)) {
+ if (components.has(name)) {
+ if (override) {
+ throw new Error(`[ComponentManager] Component ${name} already has an override.`);
+ }
this._logService?.warn('[ComponentManager]', `Component ${name} already exists.`);
}
- this._components.set(name, {
+ const registration = {
framework,
component,
- });
+ };
+ components.set(name, registration);
return toDisposable(() => {
- this._components.delete(name);
+ if (components.get(name) === registration) {
+ components.delete(name);
+ }
});
}
@@ -82,11 +101,15 @@ export class ComponentManager extends Disposable {
}
get(name: string) {
- if (!name) return;
+ if (!name) {
+ return;
+ }
- const value = this._components.get(name);
+ const value = this._overrides.get(name) ?? this._components.get(name);
- if (!value) return;
+ if (!value) {
+ return;
+ }
const frameworkHandler = this._handler[value.framework];
@@ -97,7 +120,19 @@ export class ComponentManager extends Disposable {
return frameworkHandler(value.component, name);
}
+ /** Check for a built-in default independently of any active host override. */
+ hasDefault(name: string): boolean {
+ return this._components.has(name);
+ }
+
+ /** Remove the default registration. Overrides can only be removed through their registration disposable. */
delete(name: string) {
this._components.delete(name);
}
+
+ override dispose(): void {
+ super.dispose();
+ this._components.clear();
+ this._overrides.clear();
+ }
}
diff --git a/packages/ui/src/facade/__tests__/f-univer.spec.ts b/packages/ui/src/facade/__tests__/f-univer.spec.ts
index d1c670e125..77327c0efa 100644
--- a/packages/ui/src/facade/__tests__/f-univer.spec.ts
+++ b/packages/ui/src/facade/__tests__/f-univer.spec.ts
@@ -304,6 +304,30 @@ describe('ui facade', () => {
expect(componentManager.get('custom-component')).toBeUndefined();
});
+ it.each([undefined, {}, { framework: 'react' }, { override: undefined }])('defaults facade registrations to overrides with options %j', (options) => {
+ const manager = univer.__getInjector().get(ComponentManager);
+ const HostPanel = () => null;
+ const BuiltInPanel = () => null;
+ const override = univerAPI.registerComponent('panel', HostPanel, options);
+ manager.register('panel', BuiltInPanel);
+
+ expect(manager.get('panel')).toBe(HostPanel);
+ override.dispose();
+ expect(manager.get('panel')).toBe(BuiltInPanel);
+ });
+
+ it('honors an explicit false override option in facade registrations', () => {
+ const manager = univer.__getInjector().get(ComponentManager);
+ const HostPanel = () => null;
+ const BuiltInPanel = () => null;
+ const override = univerAPI.registerComponent('panel', HostPanel);
+ univerAPI.registerComponent('panel', BuiltInPanel, { override: false });
+
+ expect(manager.get('panel')).toBe(HostPanel);
+ override.dispose();
+ expect(manager.get('panel')).toBe(BuiltInPanel);
+ });
+
it('triggers shortcuts through the active workbook render canvas', () => {
const injector = new Injector();
injector.add([IShortcutService, { useClass: FakeShortcutService as never }]);
diff --git a/packages/ui/src/facade/f-univer.ts b/packages/ui/src/facade/f-univer.ts
index 8890e14eb2..d0de96644f 100644
--- a/packages/ui/src/facade/f-univer.ts
+++ b/packages/ui/src/facade/f-univer.ts
@@ -412,11 +412,13 @@ export interface IFUniverUIMixin {
registerUIPart(key: BuiltInUIPart, component: ComponentType): IDisposable;
/**
- * Register an component.
+ * Register a component, overriding its built-in default regardless of registration order.
+ * Register before opening the corresponding view; mounted views do not update automatically.
* @param {string} name - The name of the component.
* @param {ComponentType} component - The component.
- * @param {IComponentOptions} [options] - The options of the component.
- * @returns {IDisposable} The disposable object.
+ * @param {IComponentOptions} [options] - Component options. `override` defaults to true; pass false to register a default.
+ * @returns {IDisposable} Disposes this registration, restoring the current built-in default when available.
+ * @throws When another override is already registered for this name. Dispose it before registering a replacement.
* @example
* ```tsx
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
@@ -578,7 +580,10 @@ export class FUniverUIMixin extends FUniver implements IFUniverUIMixin {
override registerComponent(name: string, component: ComponentType, options?: IComponentOptions): IDisposable {
const componentManager = this._injector.get(ComponentManager);
- return this.disposeWithMe(componentManager.register(name, component, options));
+ return this.disposeWithMe(componentManager.register(name, component, {
+ ...options,
+ override: options?.override ?? true,
+ }));
}
override setCurrent(unitId: string): void {