@univerjs/drawing-ui 1.0.0-rc.0 → 1.0.1

package/lib/types/views/image-popup-menu/ImagePopupMenu.d.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import type { IValueOption } from '@univerjs/ui';
 export interface IImagePopupMenuItem {
     label: string;
     index: number;
@@ -23,7 +24,7 @@ export interface IImagePopupMenuItem {
     value?: string;
     options?: Array<{
         icon?: string;
-        label: unknown;
+        label: IValueOption['label'];
         value: string;
     }>;
     commandParamsFactory?: (value: string) => object;

package/lib/types/views/image-popup-menu/MobileImagePopupMenu.d.ts

@@ -16,8 +16,9 @@
 import type { IImagePopupMenuExtraProps } from './ImagePopupMenu';
 interface IMobileImagePopupMenuProps {
     popup: {
-        extraProps?: Pick<IImagePopupMenuExtraProps, 'menuItems'> & {
+        extraProps?: Pick<IImagePopupMenuExtraProps, 'menuItems' | 'variant'> & {
             dialogId?: string;
+            onClose?: () => void;
         };
     };
 }

package/lib/types/views/image-preview/mobile-image-preview-button.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 { ThemeService } from '@univerjs/core';
+import type { Image, Scene, UniverRenderingContext } from '@univerjs/engine-render';
+import { Rect } from '@univerjs/engine-render';
+/** Transient canvas chrome: never part of the image model or its transformer. */
+export declare class MobileImagePreviewButton extends Rect {
+    private readonly _image;
+    private readonly _scene;
+    private _enabled;
+    private readonly _icon;
+    private readonly _iconContainer;
+    private readonly _gesture;
+    private _pressed;
+    private _background;
+    private _border;
+    private _pressedBackground;
+    constructor(_image: Image, _scene: Scene, themeService: ThemeService, preview: () => void);
+    setPreviewEnabled(enabled: boolean): void;
+    dispose(): void;
+    private _setPressed;
+    private _syncPosition;
+    protected _draw(ctx: UniverRenderingContext): void;
+}

package/lib/types/views/object-list-panel/MobileObjectListPanel.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 { IObjectListPanelBaseProps } from './ObjectListPanelBase';
+export declare function MobileObjectListPanel(props: IObjectListPanelBaseProps): import("react").JSX.Element;

package/lib/types/views/object-list-panel/ObjectListPanelBase.d.ts

@@ -13,7 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { ReactNode } from 'react';
+import type { ComponentProps, ComponentType, FocusEvent, KeyboardEvent, ReactNode } from 'react';
+import { Input } from '@univerjs/design';
 export interface IObjectListPanelCapabilities {
     arrange?: boolean;
     description?: boolean;
@@ -23,6 +24,7 @@ export interface IObjectListPanelCapabilities {
     selectable?: boolean;
     visible?: boolean;
 }
+type ObjectListFilterMode = 'all' | 'hidden' | 'locked';
 export interface IObjectListPanelItem {
     id: string;
     name: string;
@@ -75,11 +77,6 @@ export interface IObjectListPanelLabels {
     sectionFloating: string;
 }
 export type ObjectListPanelTypeNameKey = 'chart' | 'connector' | 'container' | 'dom' | 'group' | 'image' | 'object' | 'placeholder' | 'shape' | 'smartArt' | 'table' | 'text' | 'unit' | 'video';
-interface IObjectListPanelLocaleService {
-    t: (key: string) => string;
-}
-export declare function getObjectListPanelLabels(localeService: IObjectListPanelLocaleService): IObjectListPanelLabels;
-export declare function getObjectListPanelTypeName(localeService: IObjectListPanelLocaleService, typeName: ObjectListPanelTypeNameKey): string;
 export interface IObjectListPanelBaseProps {
     items: IObjectListPanelItem[];
     selectedIds: string[];
@@ -102,8 +99,76 @@ export interface IObjectListPanelBaseProps {
     onLocate?: (objectId: string) => void;
     onReorder?: (sourceObjectId: string, targetObjectId: string) => void;
 }
+export declare function hasCapability(panelCapabilities: IObjectListPanelCapabilities | undefined, item: Pick<IObjectListPanelItem, 'capabilities'> | null | undefined, key: keyof IObjectListPanelCapabilities, fallback?: boolean): boolean;
+export declare function useObjectListPanel(props: IObjectListPanelBaseProps): {
+    selectedIdSet: Set<string>;
+    draggingId: string | null;
+    setDraggingId: import("react").Dispatch<import("react").SetStateAction<string | null>>;
+    searchQuery: string;
+    setSearchQuery: import("react").Dispatch<import("react").SetStateAction<string>>;
+    filterMode: ObjectListFilterMode;
+    setFilterMode: import("react").Dispatch<import("react").SetStateAction<ObjectListFilterMode>>;
+    collapsedSectionIds: Set<string>;
+    selectedItem: IObjectListPanelItem | null;
+    visibleItems: IObjectListPanelItem[];
+    visibleItemSections: {
+        id: string;
+        title: string;
+        items: IObjectListPanelItem[];
+    }[];
+    showSectionHeaders: boolean;
+    visibilityItems: Pick<IObjectListPanelItem, "id" | "disabled" | "selectable" | "visible" | "capabilities">[];
+    selectableItems: Pick<IObjectListPanelItem, "id" | "disabled" | "selectable" | "visible" | "capabilities">[];
+    allVisible: boolean;
+    allLocked: boolean;
+    canMoveForward: boolean;
+    canMoveBackward: boolean;
+    showArrangeControls: boolean;
+    showLocateControl: boolean;
+    canReorder: boolean;
+    handleDrop: (targetId: string) => void;
+    toggleSectionCollapsed: (sectionId: string) => void;
+};
 export declare function ObjectListPanelBase(props: IObjectListPanelBaseProps): import("react").JSX.Element;
+export interface IObjectListRowProps {
+    permissionAction?: ReactNode;
+    item: IObjectListPanelItem;
+    selected: boolean;
+    labels: IObjectListPanelLabels;
+    showLock: boolean;
+    showName: boolean;
+    showVisible: boolean;
+    draggable: boolean;
+    dragging: boolean;
+    onSelect: (multiSelect: boolean) => void;
+    onToggleExpanded: () => void;
+    onToggleVisible: () => void;
+    onToggleSelectable: () => void;
+    onCommitName: (value: string) => void;
+    onDragStart: () => void;
+    onDragEnd: () => void;
+    onDrop: () => void;
+}
+export declare function ObjectDetailsEditor(props: {
+    item: IObjectListPanelItem | null;
+    InputComponent?: ComponentType<ComponentProps<typeof Input>>;
+    descriptionClassName?: string;
+    labels: IObjectListPanelLabels;
+    showName: boolean;
+    showDescription: boolean;
+    onCommitName: (value: string) => void;
+    onCommitDescription: (value: string) => void;
+}): import("react").JSX.Element;
 export type IDrawingObjectListItem = IObjectListPanelItem;
 export type IDrawingObjectListPanelLabels = IObjectListPanelLabels;
 export type IDrawingObjectListPanelProps = IObjectListPanelBaseProps;
+export declare function useObjectListRow({ item, onCommitName }: Pick<IObjectListRowProps, 'item' | 'onCommitName'>): {
+    draftName: string;
+    setDraftName: import("react").Dispatch<import("react").SetStateAction<string>>;
+    disabled: boolean;
+    level: number;
+    locked: boolean;
+    handleBlur: (event: FocusEvent<HTMLInputElement>) => void;
+    handleKeyDown: (event: KeyboardEvent<HTMLInputElement>) => void;
+};
 export {};

package/lib/types/views/panel/DrawingCommonPanel.d.ts

@@ -21,5 +21,6 @@ export interface IDrawingCommonPanelProps {
     hasAlign?: boolean;
     hasCropper?: boolean;
     hasGroup?: boolean;
+    onCropStart?: () => void;
 }
 export declare const DrawingCommonPanel: (props: IDrawingCommonPanelProps) => import("react").JSX.Element | null;

package/lib/types/views/panel/ImageCropper.d.ts

@@ -17,5 +17,6 @@ import type { IDrawingParam } from '@univerjs/core';
 export interface IImageCropperProps {
     drawings: IDrawingParam[];
     cropperShow: boolean;
+    onCropStart?: () => void;
 }
 export declare const ImageCropper: (props: IImageCropperProps) => import("react").JSX.Element | null;

package/lib/types/views/panel/MobileDrawingArrange.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 { IDrawingParam } from '@univerjs/core';
+interface IMobileDrawingArrangeProps {
+    arrangeShow: boolean;
+    drawings: IDrawingParam[];
+}
+export declare function MobileDrawingArrange(props: IMobileDrawingArrangeProps): import("react").JSX.Element;
+export {};

package/lib/types/views/panel/MobileDrawingControls.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { IDrawingParam } from '@univerjs/core';
+interface IMobileDrawingTransformProps {
+    transformShow: boolean;
+    drawings: IDrawingParam[];
+}
+interface IMobileDrawingAlignProps {
+    drawings: IDrawingParam[];
+    alignShow: boolean;
+}
+interface IMobileDrawingGroupProps {
+    drawings: IDrawingParam[];
+    hasGroup: boolean;
+}
+export declare function MobileDrawingTransform(props: IMobileDrawingTransformProps): import("react").JSX.Element | null;
+export declare function MobileDrawingAlign(props: IMobileDrawingAlignProps): import("react").JSX.Element;
+export declare function MobileDrawingGroup(props: IMobileDrawingGroupProps): import("react").JSX.Element;
+export {};

package/lib/types/views/panel/MobileImageCropper.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 { IImageCropperProps } from './ImageCropper';
+export declare function MobileImageCropper(props: IImageCropperProps): import("react").JSX.Element | null;

package/lib/types/views/panel/component-name.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 declare const DRAWING_ARRANGE_COMPONENT = "drawing-ui.arrange";
+export declare const IMAGE_CROPPER_COMPONENT = "drawing-ui.cropper";
+export declare const DRAWING_TRANSFORM_COMPONENT = "drawing-ui.transform";
+export declare const DRAWING_ALIGN_COMPONENT = "drawing-ui.align";
+export declare const DRAWING_GROUP_COMPONENT = "drawing-ui.group";

package/lib/types/views/panel/use-image-cropper.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 { IImageCropperProps } from './ImageCropper';
+import { LocaleService } from '@univerjs/core';
+import { CropType } from '../../commands/operations/image-crop.operation';
+export declare function useImageCropper(props: IImageCropperProps): {
+    drawingParam: import("@univerjs/core").IDrawingParam;
+    cropperShow: boolean;
+    localeService: LocaleService;
+    cropValue: CropType;
+    cropOptions: {
+        label: string;
+        value: CropType;
+    }[];
+    handleCropChange: (value: string | number | boolean) => void;
+    onCropperBtnClick: (val: CropType) => Promise<void>;
+    ShapeClipPicker: any;
+};