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.
TypeScript boardcollaborationdocdocxexceloffce365officepdfpptpptxpresentationsdksheetslidesspreadsheetuniverwordwordprocessorworkspacexlsx
/**
* Copyright 2023-present DreamNum Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import type { IAccessor, Workbook } from '@univerjs/core';
import type { IMenuButtonItem, IMenuSelectorItem } from '@univerjs/ui';
import type { Subscriber } from 'rxjs';
import { BooleanNumber, ICommandService, IUniverInstanceService, UniverInstanceType } from '@univerjs/core';
import { EditorColorPicker } from '@univerjs/docs-ui';
import {
CopySheetCommand,
InsertSheetMutation,
RemoveSheetMutation,
SetTabColorCommand,
SetTabColorMutation,
SetWorksheetActiveOperation,
SetWorksheetHideCommand,
SetWorksheetHideMutation,
SetWorksheetShowCommand,
WorkbookCreateSheetPermission,
WorkbookDeleteSheetPermission,
WorkbookEditablePermission,
WorkbookHideSheetPermission,
WorkbookRenameSheetPermission,
} from '@univerjs/sheets';
import { getMenuHiddenObservable, MenuItemType } from '@univerjs/ui';
import { combineLatest, combineLatestWith, map, Observable } from 'rxjs';
import type { LocaleKey } from '../locale/types';
import { RemoveSheetConfirmCommand } from '../commands/commands/remove-sheet-confirm.command';
import { ShowMenuListCommand } from '../commands/commands/unhide.command';
import { RenameSheetOperation } from '../commands/operations/rename-sheet.operation';
import { getWorkbookPermissionDisable$ } from './menu-util';
export function DeleteSheetMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey> {
const univerInstanceService = accessor.get(IUniverInstanceService);
const commandService = accessor.get(ICommandService);
const defaultDisable$ = new Observable<boolean>((subscriber) => {
const disposable = commandService.onCommandExecuted((c) => {
const id = c.id;
if (
id === RemoveSheetMutation.id ||
id === InsertSheetMutation.id ||
id === SetWorksheetHideMutation.id
) {
disableFunction(univerInstanceService, subscriber);
}
});
// When there is only one sheet initialized, it is also necessary to disable
disableFunction(univerInstanceService, subscriber);
return disposable.dispose;
});
const permissionDisable$ = getWorkbookPermissionDisable$(accessor, [
WorkbookEditablePermission,
WorkbookDeleteSheetPermission,
]);
return {
id: RemoveSheetConfirmCommand.id,
type: MenuItemType.BUTTON,
title: 'sheets-ui.sheetConfig.delete',
disabled$: combineLatest([defaultDisable$, permissionDisable$]).pipe(
map(([defaultDisabled, permissionDisabled]) => {
return defaultDisabled || permissionDisabled;
})
),
hidden$: getMenuHiddenObservable(accessor, UniverInstanceType.UNIVER_SHEET),
};
}
export function CopySheetMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey> {
return {
id: CopySheetCommand.id,
type: MenuItemType.BUTTON,
title: 'sheets-ui.sheetConfig.copy',
disabled$: getWorkbookPermissionDisable$(accessor, [WorkbookEditablePermission, WorkbookCreateSheetPermission]),
hidden$: getMenuHiddenObservable(accessor, UniverInstanceType.UNIVER_SHEET),
};
}
export function RenameSheetMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey> {
return {
id: RenameSheetOperation.id,
type: MenuItemType.BUTTON,
title: 'sheets-ui.sheetConfig.rename',
disabled$: getWorkbookPermissionDisable$(accessor, [WorkbookEditablePermission, WorkbookRenameSheetPermission]),
hidden$: getMenuHiddenObservable(accessor, UniverInstanceType.UNIVER_SHEET),
};
}
export function ChangeColorSheetMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey, string, string> {
const univerInstanceService = accessor.get(IUniverInstanceService);
const commandService = accessor.get(ICommandService);
return {
id: SetTabColorCommand.id,
title: 'sheets-ui.sheetConfig.changeColor',
type: MenuItemType.SELECTOR,
selections: [
{
label: 'sheets-ui.toolbar.resetColor',
icon: 'NoColorDoubleIcon',
value: '',
},
{
label: {
name: EditorColorPicker.componentKey,
hoverable: false,
selectable: false,
},
value$: new Observable<string>((subscriber) => {
const updateColor = () => {
const workbook = univerInstanceService.getCurrentUnitOfType<Workbook>(UniverInstanceType.UNIVER_SHEET);
subscriber.next(workbook?.getActiveSheet()?.getTabColor() ?? '');
};
updateColor();
const disposable = commandService.onCommandExecuted(({ id }) => {
if (id === SetTabColorMutation.id || id === SetWorksheetActiveOperation.id) {
updateColor();
}
});
return () => disposable.dispose();
}),
},
],
hidden$: getWorkbookPermissionDisable$(accessor, [WorkbookEditablePermission]),
};
}
export function HideSheetMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey> {
const univerInstanceService = accessor.get(IUniverInstanceService);
const commandService = accessor.get(ICommandService);
return {
id: SetWorksheetHideCommand.id,
type: MenuItemType.BUTTON,
title: 'sheets-ui.sheetConfig.hide',
disabled$: new Observable<boolean>((subscriber) => {
const disposable = commandService.onCommandExecuted((c) => {
const id = c.id;
if (
id === RemoveSheetMutation.id ||
id === InsertSheetMutation.id ||
id === SetWorksheetHideMutation.id
) {
disableFunction(univerInstanceService, subscriber);
}
});
// When there is only one sheet initialized, it is also necessary to disable
disableFunction(univerInstanceService, subscriber);
return disposable.dispose;
}).pipe(
combineLatestWith(getWorkbookPermissionDisable$(accessor, [
WorkbookEditablePermission,
WorkbookHideSheetPermission,
])),
map(([defaultDisabled, permissionDisabled]) => defaultDisabled || permissionDisabled)
),
hidden$: getMenuHiddenObservable(accessor, UniverInstanceType.UNIVER_SHEET),
};
}
export function UnHideSheetMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey> {
const univerInstanceService = accessor.get(IUniverInstanceService);
const commandService = accessor.get(ICommandService);
const workbook = univerInstanceService.getCurrentUnitOfType<Workbook>(UniverInstanceType.UNIVER_SHEET)!;
const hiddenList = workbook.getHiddenWorksheets(false).map((s) => ({
label: workbook.getSheetBySheetId(s)?.getName() || '',
value: s,
}));
const defaultDisable$: Observable<boolean> = new Observable((subscriber) => {
const disposable = commandService.onCommandExecuted((c) => {
if (c.id !== SetWorksheetHideCommand.id && c.id !== SetWorksheetShowCommand.id) {
return;
}
const newList = workbook.getHiddenWorksheets(false);
const isEmpty = newList.length === 0;
subscriber.next(isEmpty);
});
subscriber.next(hiddenList.length === 0);
return disposable.dispose;
});
return {
id: SetWorksheetShowCommand.id,
type: MenuItemType.SELECTOR,
title: 'sheets-ui.sheetConfig.unhide',
disabled$: defaultDisable$.pipe(
combineLatestWith(getWorkbookPermissionDisable$(accessor, [
WorkbookEditablePermission,
WorkbookHideSheetPermission,
])),
map(([defaultDisabled, permissionDisabled]) => defaultDisabled || permissionDisabled)
),
selections: new Observable((subscriber) => {
const disposable = commandService.onCommandExecuted((c) => {
if (c.id !== SetWorksheetHideCommand.id && c.id !== SetWorksheetShowCommand.id) {
return;
}
const newList = workbook.getHiddenWorksheets(false).map((s) => ({
label: workbook.getSheetBySheetId(s)?.getName() || '',
value: s,
}));
subscriber.next(newList);
});
subscriber.next(hiddenList);
return disposable.dispose;
}),
hidden$: getMenuHiddenObservable(accessor, UniverInstanceType.UNIVER_SHEET),
};
}
export function ShowMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey> {
const univerInstanceService = accessor.get(IUniverInstanceService);
const commandService = accessor.get(ICommandService);
return {
id: ShowMenuListCommand.id,
type: MenuItemType.BUTTON,
title: 'sheets-ui.sheetConfig.unhide',
disabled$: new Observable<boolean>((subscriber) => {
function disableFunction() {
const worksheets = univerInstanceService.getCurrentUnitOfType<Workbook>(UniverInstanceType.UNIVER_SHEET)!.getWorksheets();
// loop through all worksheets Map to see if there is more than one sheet
const visibleSheets = Array.from(worksheets.values());
subscriber.next(visibleSheets.length === 1);
}
const disposable = commandService.onCommandExecuted((c) => {
const id = c.id;
if (
id === RemoveSheetMutation.id ||
id === InsertSheetMutation.id ||
id === SetWorksheetHideMutation.id
) {
disableFunction();
}
});
disableFunction();
return disposable.dispose;
}).pipe(
combineLatestWith(getWorkbookPermissionDisable$(accessor, [
WorkbookEditablePermission,
WorkbookHideSheetPermission,
])),
map(([defaultDisabled, permissionDisabled]) => defaultDisabled || permissionDisabled)
),
hidden$: getMenuHiddenObservable(accessor, UniverInstanceType.UNIVER_SHEET),
};
}
function disableFunction(univerInstanceService: IUniverInstanceService, subscriber: Subscriber<boolean>) {
const worksheets = univerInstanceService.getCurrentUnitOfType<Workbook>(UniverInstanceType.UNIVER_SHEET)!.getWorksheets();
// loop through all worksheets Map to see if there is more than one visible sheet
const visibleSheets = Array.from(worksheets.values()).filter(
(sheet) => sheet.getConfig().hidden === BooleanNumber.FALSE
);
subscriber.next(visibleSheets.length === 1);
}