@univerjs/ui 1.0.0-alpha.6 → 1.0.0-alpha.7

package/lib/types/services/menu/menu-manager.service.d.ts

@@ -21,6 +21,15 @@ import { Subject } from 'rxjs';
 export declare const IMenuManagerService: import("@wendellhu/redi").IdentifierDecorator<IMenuManagerService>;
 export type ContextMenuQuickLayout = 'icon' | 'tile';
 export type ContextMenuQuickLayoutVariant = 'default' | 'compact';
+export interface IRibbonGridLayout {
+    row: number;
+    column: number;
+    rowSpan?: number;
+    columnSpan?: number;
+    showLabel?: boolean;
+    width?: number;
+    iconSize?: number;
+}
 export interface IMenuSchema {
     key: string;
     order: number;
@@ -33,6 +42,7 @@ export interface IMenuSchema {
     quickColumns?: number;
     quickLayoutVariant?: ContextMenuQuickLayoutVariant;
     tiny?: boolean;
+    gridLayout?: IRibbonGridLayout;
 }
 export interface IMenuManagerService {
     readonly menuChanged$: Observable<void>;
@@ -52,6 +62,7 @@ export type MenuSchemaType = {
     quickColumns?: number;
     quickLayoutVariant?: ContextMenuQuickLayoutVariant;
     tiny?: boolean;
+    gridLayout?: IRibbonGridLayout;
 } | {
     [key: string]: MenuSchemaType;
 };

package/lib/types/services/menu/types.d.ts

@@ -29,6 +29,7 @@ export declare enum RibbonStartGroup {
     HISTORY = "ribbon.start.history",
     FORMAT = "ribbon.start.format",
     LAYOUT = "ribbon.start.layout",
+    NUMBER = "ribbon.start.number",
     OTHERS = "ribbon.start.others"
 }
 export declare enum RibbonInsertGroup {

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

@@ -18,6 +18,7 @@ import type { Observable } from 'rxjs';
 import { Disposable, ICommandService, IContextService } from '@univerjs/core';
 import { ILayoutService } from '../layout/layout.service';
 import { IPlatformService } from '../platform/platform.service';
+import { IUIRuntimeScopeService } from '../runtime-scope/ui-runtime-scope.service';
 import { KeyCode } from './keycode';
 /**
  * A shortcut item that could be registered to the {@link IShortcutService}.
@@ -135,6 +136,7 @@ export declare class ShortcutService extends Disposable implements IShortcutServ
     private readonly _commandService;
     private readonly _platformService;
     private readonly _contextService;
+    private readonly _runtimeScopeService;
     private readonly _layoutService?;
     private readonly _shortCutMapping;
     private readonly _commandIDMapping;
@@ -142,7 +144,7 @@ export declare class ShortcutService extends Disposable implements IShortcutServ
     readonly shortcutChanged$: Observable<void>;
     private _forceEscaped;
     private _forceDisabled;
-    constructor(_commandService: ICommandService, _platformService: IPlatformService, _contextService: IContextService, _layoutService?: ILayoutService | undefined);
+    constructor(_commandService: ICommandService, _platformService: IPlatformService, _contextService: IContextService, _runtimeScopeService: IUIRuntimeScopeService, _layoutService?: ILayoutService | undefined);
     getAllShortcuts(): IShortcutItem[];
     registerShortcut(shortcut: IShortcutItem): IDisposable;
     getShortcutDisplayOfCommand(id: string): string | null;
@@ -155,4 +157,5 @@ export declare class ShortcutService extends Disposable implements IShortcutServ
     private _getBindingFromItem;
     private _deriveBindingFromEvent;
     private _shouldLetEmbedTextEditorHandleNativeShortcut;
+    private _getRuntimeService;
 }

package/lib/types/utils/embed-boundary.d.ts

@@ -14,8 +14,10 @@
  * limitations under the License.
  */
 export declare const EMBED_INTERACTION_BOUNDARY_OWNER_ATTRIBUTE = "data-embed-interaction-boundary-owner";
+export declare const EMBED_CHILD_UNIT_ID_ATTRIBUTE = "data-embed-child-unit-id";
 export declare function getEmbedBoundaryOwner(target: EventTarget | null): string | undefined;
 export declare function isEmbedBoundaryTarget(target: EventTarget | null): boolean;
+export declare function getEmbedChildUnitId(target: EventTarget | null): string | undefined;
 export declare function keepInteractionInsideSameEmbedBoundary(event: {
     currentTarget: EventTarget | null;
     target: EventTarget | null;

package/lib/types/views/components/feature-search/FeatureSearch.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 { IMenuCommandParams } from '../../../services/menu/menu';
+export declare const FEATURE_SEARCH_COMPONENT = "FeatureSearch";
+export declare const FEATURE_SEARCH_DIALOG_ID = "FEATURE_SEARCH_DIALOG";
+export interface IFeatureSearchItem {
+    key: string;
+    title: string;
+    parentTitle?: string;
+    description: string;
+    path: string;
+    commandId: string;
+    params?: IMenuCommandParams;
+    getParams: () => IMenuCommandParams | undefined;
+}
+export declare function FeatureSearch(): import("react").JSX.Element;

package/lib/types/views/components/ribbon/RibbonGrid.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { HTMLAttributes } from 'react';
+import type { IMenuSchema } from '../../../services/menu/menu-manager.service';
+interface IRibbonGridProps extends Omit<HTMLAttributes<HTMLDivElement>, 'title'> {
+    groups: IMenuSchema[];
+    title: string;
+}
+export declare function RibbonGrid({ groups, title, className, ...props }: IRibbonGridProps): import("react").JSX.Element;
+export {};

package/lib/types/views/components/ribbon/ToolbarItem.d.ts

@@ -15,4 +15,13 @@
  */
 import type { IDisplayMenuItem, IMenuItem } from '../../../services/menu/menu';
 import type { ITooltipWrapperRef } from './TooltipButtonWrapper';
-export declare const ToolbarItem: import("react").ForwardRefExoticComponent<IDisplayMenuItem<IMenuItem> & import("react").RefAttributes<ITooltipWrapperRef>>;
+type IToolbarItemProps = IDisplayMenuItem<IMenuItem> & {
+    grid?: boolean;
+    large?: boolean;
+    showLabel?: boolean;
+    iconSize?: number;
+    iconColor?: string;
+    fullWidth?: boolean;
+};
+export declare const ToolbarItem: import("react").ForwardRefExoticComponent<IToolbarItemProps & import("react").RefAttributes<ITooltipWrapperRef>>;
+export {};

package/lib/types/views/components/ribbon/ribbon-grid-layout.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 { IMenuSchema } from '../../../services/menu/menu-manager.service';
+export interface IRibbonGridPlacement {
+    item: IMenuSchema;
+    row: number;
+    column: number;
+    rowSpan: number;
+    columnSpan: number;
+    showLabel: boolean;
+    width?: number;
+    iconSize?: number;
+}
+export declare function placeRibbonGridItems(items: IMenuSchema[]): IRibbonGridPlacement[];

package/lib/types/views/components/ribbon/ribbon-menu/RibbonGridMenu.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { IMenuSchema } from '../../../../services/menu/menu-manager.service';
+export declare function RibbonGridMenu({ ribbon, activatedTab, onSelectTab, }: {
+    ribbon: IMenuSchema[];
+    activatedTab: string;
+    onSelectTab: (tab: IMenuSchema) => void;
+}): import("react").JSX.Element;

package/lib/types/views/components/sidebar/Sidebar.d.ts

@@ -13,13 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { CSSProperties } from 'react';
 import type { ICustomLabelProps } from '../../custom-label/CustomLabel';
 export interface ISidebarMethodOptions {
     id?: string;
     header?: ICustomLabelProps;
     children?: ICustomLabelProps;
-    bodyStyle?: CSSProperties;
     footer?: ICustomLabelProps;
     visible?: boolean;
     width?: number | string;

package/lib/types/views/custom-label/CustomLabel.d.ts

@@ -18,6 +18,7 @@ import type { Observable } from 'rxjs';
 import type { IMenuSelectorItem } from '../../services/menu/menu';
 export type ICustomLabelProps<T = undefined> = {
     className?: string;
+    iconSize?: number;
     value?: string | number | undefined;
     value$?: Observable<T>;
     onChange?(v: string | number): void;

package/lib/types/views/emoji-picker/EmojiPicker.d.ts

@@ -15,13 +15,17 @@
  */
 import type { IPopup } from '../../services/popup/canvas-popup.service';
 export declare const EMOJI_PICKER_COMPONENT = "ui.emoji-picker";
-export interface IEmojiPickerPopupProps {
+interface IEmojiPickerPopupProps {
     activeEmoji?: string;
     onSelect?: (emoji: string, options?: {
         keepOpen?: boolean;
     }) => void;
     recentStorageKey?: string;
 }
-export declare function EmojiPicker(props: {
+interface IEmojiPickerProps {
+    embedded?: boolean;
+    onChange?: (emoji: string) => void;
     popup?: IPopup<IEmojiPickerPopupProps>;
-}): import("react").JSX.Element;
+}
+export declare function EmojiPicker(props: IEmojiPickerProps): import("react").JSX.Element;
+export {};

package/lib/types/views/emoji-picker/emoji-picker-utils.d.ts

@@ -27,7 +27,7 @@ export type EmojiCategory = Exclude<keyof typeof emojis, 'frequent'>;
 export declare const EMOJI_RECENT_LIMIT = 11;
 export declare const EMOJI_CATEGORIES: {
     key: EmojiCategory;
-    titleKey: "ui.row" | "ui.column" | "ui.common-edit" | "ui.toggle-shortcut-panel" | "ui.global-shortcut" | "ui.fontFamily.not-supported" | "ui.fontFamily.arial" | "ui.fontFamily.times-new-roman" | "ui.fontFamily.tahoma" | "ui.fontFamily.verdana" | "ui.fontFamily.microsoft-yahei" | "ui.fontFamily.simsun" | "ui.fontFamily.simhei" | "ui.fontFamily.kaiti" | "ui.fontFamily.fangsong" | "ui.fontFamily.nsimsun" | "ui.fontFamily.stxinwei" | "ui.fontFamily.stxingkai" | "ui.fontFamily.stliti" | "ui.ribbon.start" | "ui.ribbon.view" | "ui.ribbon.insert" | "ui.ribbon.data" | "ui.ribbon.startDesc" | "ui.ribbon.insertDesc" | "ui.ribbon.formulas" | "ui.ribbon.formulasDesc" | "ui.ribbon.dataDesc" | "ui.ribbon.viewDesc" | "ui.ribbon.others" | "ui.ribbon.othersDesc" | "ui.ribbon.more" | "ui.clipboard.authentication.title" | "ui.clipboard.authentication.content" | "ui.emojiPicker.search" | "ui.emojiPicker.objects" | "ui.emojiPicker.random" | "ui.emojiPicker.recents" | "ui.emojiPicker.emojis" | "ui.emojiPicker.animals" | "ui.emojiPicker.food" | "ui.emojiPicker.activities" | "ui.emojiPicker.places" | "ui.emojiPicker.symbols" | "ui.emojiPicker.searchResults" | "ui.emojiPicker.noResults" | `ui.emojiPicker.emojiSearchIndex.${string}` | `ui.emojiPicker.emojiTitles.${string}` | "ui.toolbar.heading.title" | "ui.toolbar.heading.normal" | "ui.toolbar.heading.subTitle" | "ui.toolbar.heading.tooltip" | "ui.shortcut-panel.title" | "ui.shortcut.copy" | "ui.shortcut.cut" | "ui.shortcut.paste" | "ui.shortcut.shortcut-panel" | "ui.shortcut.undo" | "ui.shortcut.redo" | "ui.navigation.next" | "ui.navigation.back" | "ui.navigation.previous" | "ui.sidebar.close" | "ui.sidebar.resize" | "ui.sidebar.panel" | "ui.beforeClose.title" | "ui.textEditor.formulaError" | "ui.textEditor.rangeError" | "ui.rangeSelector.title" | "ui.rangeSelector.cancel" | "ui.rangeSelector.addAnotherRange" | "ui.rangeSelector.buttonTooltip" | "ui.rangeSelector.placeHolder" | "ui.rangeSelector.confirm" | "ui.zoom-slider.resetTo";
+    titleKey: "ui.row" | "ui.column" | "ui.common-edit" | "ui.toggle-shortcut-panel" | "ui.global-shortcut" | "ui.fontFamily.not-supported" | "ui.fontFamily.arial" | "ui.fontFamily.times-new-roman" | "ui.fontFamily.tahoma" | "ui.fontFamily.verdana" | "ui.fontFamily.microsoft-yahei" | "ui.fontFamily.simsun" | "ui.fontFamily.simhei" | "ui.fontFamily.kaiti" | "ui.fontFamily.fangsong" | "ui.fontFamily.nsimsun" | "ui.fontFamily.stxinwei" | "ui.fontFamily.stxingkai" | "ui.fontFamily.stliti" | "ui.ribbon.start" | "ui.ribbon.view" | "ui.ribbon.insert" | "ui.ribbon.data" | "ui.ribbon.startDesc" | "ui.ribbon.insertDesc" | "ui.ribbon.formulas" | "ui.ribbon.formulasDesc" | "ui.ribbon.dataDesc" | "ui.ribbon.viewDesc" | "ui.ribbon.others" | "ui.ribbon.othersDesc" | "ui.ribbon.more" | "ui.clipboard.authentication.title" | "ui.clipboard.authentication.content" | "ui.featureSearch.title" | "ui.featureSearch.empty" | "ui.featureSearch.placeholder" | "ui.featureSearch.ribbon" | "ui.featureSearch.contextMenu" | "ui.emojiPicker.search" | "ui.emojiPicker.objects" | "ui.emojiPicker.random" | "ui.emojiPicker.recents" | "ui.emojiPicker.emojis" | "ui.emojiPicker.animals" | "ui.emojiPicker.food" | "ui.emojiPicker.activities" | "ui.emojiPicker.places" | "ui.emojiPicker.symbols" | "ui.emojiPicker.searchResults" | "ui.emojiPicker.noResults" | `ui.emojiPicker.emojiSearchIndex.${string}` | `ui.emojiPicker.emojiTitles.${string}` | "ui.symbolPicker.mathematics" | "ui.symbolPicker.greek" | "ui.symbolPicker.common" | "ui.toolbar.heading.title" | "ui.toolbar.heading.normal" | "ui.toolbar.heading.subTitle" | "ui.toolbar.heading.tooltip" | "ui.shortcut-panel.title" | "ui.shortcut.copy" | "ui.shortcut.cut" | "ui.shortcut.paste" | "ui.shortcut.shortcut-panel" | "ui.shortcut.undo" | "ui.shortcut.redo" | "ui.navigation.next" | "ui.navigation.back" | "ui.navigation.previous" | "ui.sidebar.close" | "ui.sidebar.resize" | "ui.sidebar.panel" | "ui.beforeClose.title" | "ui.textEditor.formulaError" | "ui.textEditor.rangeError" | "ui.rangeSelector.title" | "ui.rangeSelector.cancel" | "ui.rangeSelector.addAnotherRange" | "ui.rangeSelector.buttonTooltip" | "ui.rangeSelector.placeHolder" | "ui.rangeSelector.confirm" | "ui.zoom-slider.resetTo";
 }[];
 export declare function getDefaultRecentEmojis(): IEmojiItem[];
 export declare function getAllEmojis(): IEmojiItem[];

package/lib/types/views/emoji-picker/index.d.ts

@@ -16,4 +16,3 @@
 export { EMOJI_CATEGORIES, EMOJI_RECENT_LIMIT, getAllEmojis, getDefaultRecentEmojis, getEmojiLocaleData, getLocalizedEmojiTitle, getRandomEmoji, parseStoredRecentEmojis, promoteRecentEmoji, searchEmojis, } from './emoji-picker-utils';
 export type { EmojiCategory, IEmojiItem, IEmojiLocaleData } from './emoji-picker-utils';
 export { EMOJI_PICKER_COMPONENT, EmojiPicker } from './EmojiPicker';
-export type { IEmojiPickerPopupProps } from './EmojiPicker';

package/lib/types/views/index.d.ts

@@ -19,3 +19,4 @@ export * from './emoji-picker/index';
 export * from './HeadingItem';
 export { useScrollYOverContainer } from './hooks/layout';
 export { type ISliderProps, type IZoomInputProps, Slider, ZoomInput } from './slider/index';
+export * from './symbol-picker/index';

package/lib/types/views/symbol-picker/SymbolPicker.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { IPopup } from '../../services/popup/canvas-popup.service';
+export declare const SYMBOL_PICKER_COMPONENT = "ui.symbol-picker";
+interface ISymbolPickerPopupProps {
+    activeSymbol?: string;
+    onSelect?: (symbol: string, options?: {
+        keepOpen?: boolean;
+    }) => void;
+}
+interface ISymbolPickerProps {
+    className?: string;
+    embedded?: boolean;
+    onChange?: (symbol: string) => void;
+    popup?: IPopup<ISymbolPickerPopupProps>;
+}
+export declare function SymbolPicker(props: ISymbolPickerProps): import("react").JSX.Element;
+export {};

package/lib/types/views/symbol-picker/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+export { SYMBOL_PICKER_COMPONENT, SymbolPicker } from './SymbolPicker';
+export { SYMBOL_CATEGORIES } from './symbols';
+export type { ISymbolCategory, SymbolCategory } from './symbols';

package/lib/types/views/symbol-picker/symbols.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { LocaleKey } from '../../locale/types';
+export type SymbolCategory = 'mathematics' | 'greek' | 'common';
+export interface ISymbolCategory {
+    key: SymbolCategory;
+    symbols: string[];
+    titleKey: LocaleKey;
+}
+export declare const SYMBOL_CATEGORIES: ISymbolCategory[];