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
feat(design): add HoverCard component (#5211)
白熱7441d00fef39
diff --git a/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts-snapshots/dark-mode-ci-chromium-linux.png b/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts-snapshots/dark-mode-ci-chromium-linux.pngindex ce7337ca80..2114ff10bd 100644Binary files a/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts-snapshots/dark-mode-ci-chromium-linux.png and b/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts-snapshots/dark-mode-ci-chromium-linux.png differdiff --git a/package.json b/package.jsonindex d810e695cb..9640a34341 100644--- a/package.json+++ b/package.json@@ -63,7 +63,7 @@"eslint": "9.26.0","eslint-plugin-format": "^1.0.1","eslint-plugin-header": "^3.1.1",- "eslint-plugin-jsdoc": "^50.6.14",+ "eslint-plugin-jsdoc": "^50.6.17","eslint-plugin-no-barrel-import": "^0.0.2","eslint-plugin-no-penetrating-import": "^0.0.1","eslint-plugin-react": "^7.37.5",diff --git a/packages/design/package.json b/packages/design/package.jsonindex 389f7ec691..6bdb800c23 100644--- a/packages/design/package.json+++ b/packages/design/package.json@@ -70,6 +70,7 @@"dependencies": {"@radix-ui/react-dialog": "^1.1.13","@radix-ui/react-dropdown-menu": "^2.1.14",+ "@radix-ui/react-hover-card": "^1.1.13","@radix-ui/react-popover": "^1.1.13","@radix-ui/react-separator": "^1.1.6","@radix-ui/react-slot": "^1.2.2",diff --git a/packages/design/src/components/color-picker/ColorInput.tsx b/packages/design/src/components/color-picker/ColorInput.tsxindex 218c609bce..f0b5dbc3a7 100644--- a/packages/design/src/components/color-picker/ColorInput.tsx+++ b/packages/design/src/components/color-picker/ColorInput.tsx@@ -16,7 +16,7 @@import { ChevronSortSingle } from '@univerjs/icons';import React, { useEffect, useMemo, useState } from 'react';-import { Dropdown } from '../dropdown';+import { Dropdown } from '../dropdown/Dropdown';import { hexToHsv, hslToHsv, hsvToHex, hsvToHsl, hsvToRgb, rgbToHsv } from './color-conversion';interface IColorInputProps {diff --git a/packages/design/src/components/dropdown/Dropdown.tsx b/packages/design/src/components/dropdown/Dropdown.tsxindex 3d006cc78c..ad58603bf3 100644--- a/packages/design/src/components/dropdown/Dropdown.tsx+++ b/packages/design/src/components/dropdown/Dropdown.tsx@@ -14,12 +14,11 @@* limitations under the License.*/-import type { Content } from '@radix-ui/react-popover';import type { ComponentProps, ReactNode } from 'react';import { useState } from 'react';import { PopoverContent, PopoverPrimitive, PopoverTrigger } from './PopoverPrimitive';-export interface IDropdownProps extends ComponentProps<typeof Content> {+export interface IDropdownProps extends ComponentProps<typeof PopoverContent> {children: ReactNode;overlay: ReactNode;disabled?: boolean;diff --git a/packages/design/src/components/dropdown/PopoverPrimitive.tsx b/packages/design/src/components/dropdown/PopoverPrimitive.tsxindex da2f77275d..56a21e0b11 100644--- a/packages/design/src/components/dropdown/PopoverPrimitive.tsx+++ b/packages/design/src/components/dropdown/PopoverPrimitive.tsx@@ -47,7 +47,7 @@ function PopoverContent({`univer-z-[1080] univer-max-h-[var(--radix-popper-available-height)] univer-overflow-y-autouniver-rounded-md univer-bg-white univer-text-gray-900 univer-shadow-md univer-outline-hidden- dark:!univer-bg-gray-900 dark:!univer-text-white+ dark:!univer-bg-gray-900 dark:!univer-text-white dark:focus-visible:univer-border-gray-600data-[side=bottom]:univer-slide-in-from-top-2data-[side=left]:univer-slide-in-from-right-2data-[side=right]:univer-slide-in-from-left-2diff --git a/packages/design/src/components/dropdown/index.ts b/packages/design/src/components/dropdown/index.tsdeleted file mode 100644index 4889b85bb6..0000000000--- a/packages/design/src/components/dropdown/index.ts+++ /dev/null@@ -1,17 +0,0 @@-/**- * 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 { Dropdown, type IDropdownProps } from './Dropdown';diff --git a/packages/design/src/components/hover-card/HoverCard.stories.tsx b/packages/design/src/components/hover-card/HoverCard.stories.tsxnew file mode 100644index 0000000000..c6b3b5054d--- /dev/null+++ b/packages/design/src/components/hover-card/HoverCard.stories.tsx@@ -0,0 +1,70 @@+/**+ * 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 { Meta } from '@storybook/react';++import { borderClassName } from '../../helper/class-utilities';+import { clsx } from '../../helper/clsx';+import { HoverCard } from './HoverCard';++const meta: Meta<typeof HoverCard> = {+ title: 'Components / HoverCard',+ component: HoverCard,+ parameters: {+ layout: 'centered',+ },+ tags: ['autodocs'],+};++export default meta;++export const Playground = {+ render() {+ return (+ <div className="univer-relative">+ <HoverCard+ overlay={(+ <div className="univer-text-primary-500">+ Hello Univer+ <HoverCard+ openDelay={0}+ overlay={(+ <div className="univer-text-cyan-700">+ <div>Nested Content</div>+ <div>Nested Content</div>+ <div>Nested Content</div>+ <div>Nested Content</div>+ </div>+ )}+ >+ <a>Nested Hover Card</a>+ </HoverCard>+ </div>+ )}+ >+ <a+ className={clsx(`+ univer-cursor-pointer univer-rounded-lg univer-px-4 univer-py-2 univer-transition-all+ hover:univer-bg-gray-100+ `, borderClassName)}+ >+ Click me+ </a>+ </HoverCard>+ </div>+ );+ },+};diff --git a/packages/design/src/components/hover-card/HoverCard.tsx b/packages/design/src/components/hover-card/HoverCard.tsxnew file mode 100644index 0000000000..18e69c04c9--- /dev/null+++ b/packages/design/src/components/hover-card/HoverCard.tsx@@ -0,0 +1,68 @@+/**+ * 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 { ComponentProps, ReactNode } from 'react';+import { useState } from 'react';+import { HoverCardContent, HoverCardPrimitive, HoverCardTrigger } from './HoverCardPrimitive';++export interface IHoverCardProps extends ComponentProps<typeof HoverCardContent> {+ children: ReactNode;+ overlay: ReactNode;+ disabled?: boolean;+ /**+ * Delay in milliseconds before the dropdown opens.+ * @default 200+ */+ openDelay?: number;+ open?: boolean;+ onOpenChange?: (open: boolean) => void;+}++export function HoverCard(props: IHoverCardProps) {+ const {+ children,+ overlay,+ disabled,+ openDelay = 200,+ open: controlledOpen,+ onOpenChange: controlledOnOpenChange,+ ...restProps+ } = props;++ const [uncontrolledOpen, setUncontrolledOpen] = useState(false);++ const isControlled = controlledOpen !== undefined;+ const open = isControlled ? controlledOpen : uncontrolledOpen;++ function handleChangeOpen(newOpen: boolean) {+ if (disabled) return;++ if (!isControlled) {+ setUncontrolledOpen(newOpen);+ }++ controlledOnOpenChange?.(newOpen);+ }++ return (+ <HoverCardPrimitive open={open} onOpenChange={handleChangeOpen} openDelay={openDelay}>+ <HoverCardTrigger asChild>{children}</HoverCardTrigger>+ <HoverCardContent {...restProps}>+ {overlay}+ </HoverCardContent>+ </HoverCardPrimitive>+ );+}diff --git a/packages/design/src/components/hover-card/HoverCardPrimitive.tsx b/packages/design/src/components/hover-card/HoverCardPrimitive.tsxnew file mode 100644index 0000000000..e556bd96e5--- /dev/null+++ b/packages/design/src/components/hover-card/HoverCardPrimitive.tsx@@ -0,0 +1,57 @@+/**+ * 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 { ComponentPropsWithoutRef, ElementRef } from 'react';+import { Content, Root, Trigger } from '@radix-ui/react-hover-card';+import { forwardRef } from 'react';+import { borderClassName } from '../../helper/class-utilities';+import { clsx } from '../../helper/clsx';++const HoverCardPrimitive = Root;++const HoverCardTrigger = Trigger;++const HoverCardContent = forwardRef<+ ElementRef<typeof Content>,+ ComponentPropsWithoutRef<typeof Content>+>(({ className, align = 'center', sideOffset = 4, ...props }, ref) => (+ <Content+ ref={ref}+ align={align}+ sideOffset={sideOffset}+ className={clsx(+ `+ univer-z-[1080] univer-w-64 univer-origin-[--radix-hover-card-content-transform-origin] univer-rounded-md+ univer-bg-white univer-text-gray-900 univer-shadow-md univer-outline-none+ dark:univer-bg-gray-900 dark:univer-text-white+ data-[side=bottom]:univer-slide-in-from-top-2+ data-[side=left]:univer-slide-in-from-right-2+ data-[side=right]:univer-slide-in-from-left-2+ data-[side=top]:univer-slide-in-from-bottom-2+ data-[state=closed]:univer-animate-out data-[state=closed]:univer-fade-out-0+ data-[state=closed]:univer-zoom-out-95+ data-[state=open]:univer-animate-in data-[state=open]:univer-fade-in-0 data-[state=open]:univer-zoom-in-95+ `,+ borderClassName,+ className+ )}+ {...props}+ />+));++HoverCardContent.displayName = Content.displayName;++export { HoverCardContent, HoverCardPrimitive, HoverCardTrigger };diff --git a/packages/design/src/index.ts b/packages/design/src/index.tsindex e22cf5f23b..391bb7d075 100644--- a/packages/design/src/index.ts+++ b/packages/design/src/index.ts@@ -26,7 +26,8 @@ export { ColorPicker, type IColorPickerProps } from './components/color-picker/Cexport { ConfigContext, ConfigProvider, type IConfigProviderProps } from './components/config-provider/ConfigProvider';export { Confirm, type IConfirmProps } from './components/confirm/Confirm';export { Dialog, type IDialogProps } from './components/dialog/Dialog';-export { Dropdown, type IDropdownProps } from './components/dropdown';+export { Dropdown, type IDropdownProps } from './components/dropdown/Dropdown';+export { HoverCard, type IHoverCardProps } from './components/hover-card/HoverCard';export { type IInputProps, Input } from './components/input/Input';export { type IInputNumberProps, InputNumber } from './components/input-number/InputNumber';export { type IMessageProps, message, Messager, MessageType, removeMessage } from './components/message/Message';diff --git a/packages/ui/src/components/font-size/FontSize.tsx b/packages/ui/src/components/font-size/FontSize.tsxindex 8636657f93..12714e312d 100644--- a/packages/ui/src/components/font-size/FontSize.tsx+++ b/packages/ui/src/components/font-size/FontSize.tsx@@ -46,8 +46,8 @@ export const FontSize = (props: IFontSizeProps) => {className={`univer-block univer-h-6 univer-border-none univer-bg-transparent univer-leading-6[&_input:focus]:!univer-ring-0- [&_input]:univer-h-6 [&_input]:univer-w-7 [&_input]:univer-border-none [&_input]:univer-bg-transparent- [&_input]:univer-p-0 [&_input]:univer-text-sm+ [&_input]:univer-h-6 [&_input]:univer-w-7 [&_input]:univer-border-none+ [&_input]:!univer-bg-transparent [&_input]:univer-p-0 [&_input]:univer-text-sm`}value={_value}controls={false}diff --git a/packages/ui/src/views/components/ribbon/Ribbon.tsx b/packages/ui/src/views/components/ribbon/Ribbon.tsxindex 205af1d2b4..eb82d10829 100644--- a/packages/ui/src/views/components/ribbon/Ribbon.tsx+++ b/packages/ui/src/views/components/ribbon/Ribbon.tsx@@ -18,7 +18,7 @@ import type { ComponentType } from 'react';import type { Observable } from 'rxjs';import type { IMenuSchema } from '../../../services/menu/menu-manager.service';import { LocaleService } from '@univerjs/core';-import { borderBottomClassName, borderClassName, clsx, divideXClassName, Dropdown } from '@univerjs/design';+import { borderBottomClassName, borderClassName, clsx, divideXClassName, Dropdown, HoverCard } from '@univerjs/design';import { DatabaseSingle, EyeSingle, FunctionSingle, HomeSingle, InsertSingle, MoreDownSingle, MoreFunctionSingle } from '@univerjs/icons';import { Fragment, useCallback, useEffect, useMemo, useRef, useState } from 'react';import { combineLatest } from 'rxjs';@@ -253,8 +253,8 @@ export function Ribbon(props: IRibbonProps) {</search> */}{ribbon.length > 1 && (- <Dropdown- className="univer-max-w-96 !univer-rounded-xl univer-animate-in univer-fade-in"+ <HoverCard+ className="univer-max-w-96 !univer-rounded-xl"align="start"open={groupSelectorVisible}overlay={(@@ -322,7 +322,7 @@ export function Ribbon(props: IRibbonProps) {`}/></a>- </Dropdown>+ </HoverCard>)}<div ref={containerRef} className={clsx('univer-flex univer-overflow-hidden', divideXClassName)}>@@ -336,9 +336,11 @@ export function Ribbon(props: IRibbonProps) {</Fragment>))}+ {/* More functions dropdown */}{collapsedIds.length > 0 && (<div className="univer-pl-2"><Dropdown+ collisionPadding={{ right: 12 }}overlay={(<divclassName={`diff --git a/packages/ui/src/views/components/ribbon/ToolbarButton.tsx b/packages/ui/src/views/components/ribbon/ToolbarButton.tsxindex dd58f5cd56..540b29ebcd 100644--- a/packages/ui/src/views/components/ribbon/ToolbarButton.tsx+++ b/packages/ui/src/views/components/ribbon/ToolbarButton.tsx@@ -95,7 +95,7 @@ export function ToolbarButton(props: IBaseToolbarButtonProps) {hover:univer-bg-gray-100`, {'univer-px-2': noIcon,- '!univer-bg-gray-200 dark:!!univer-bg-gray-500': active,+ '!univer-bg-gray-200 dark:!univer-bg-gray-500': active,})}style={style}disabled={disabled}diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex c8f04276b3..e7847825f9 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -69,8 +69,8 @@ importers:specifier: ^3.1.1version: 3.1.1([email protected]([email protected]))eslint-plugin-jsdoc:- specifier: ^50.6.14- version: 50.6.14([email protected]([email protected]))+ specifier: ^50.6.17+ version: 50.6.17([email protected]([email protected]))eslint-plugin-no-barrel-import:specifier: ^0.0.2version: 0.0.2([email protected]([email protected]))@@ -1121,6 +1121,9 @@ importers:'@radix-ui/react-dropdown-menu':specifier: ^2.1.14version: 2.1.14(@types/[email protected](@types/[email protected]))(@types/[email protected])([email protected]([email protected]))([email protected])+ '@radix-ui/react-hover-card':+ specifier: ^1.1.13+ version: 1.1.13(@types/[email protected](@types/[email protected]))(@types/[email protected])([email protected]([email protected]))([email protected])'@radix-ui/react-popover':specifier: ^1.1.13version: 1.1.13(@types/[email protected](@types/[email protected]))(@types/[email protected])([email protected]([email protected]))([email protected])@@ -4011,14 +4014,14 @@ packages:'@emnapi/[email protected]':resolution: {integrity: sha512-5n3nTJblwRi8LlXkJ9eBzu+kZR8Yxcc7ubakyQTFzPMtIhFpUBRbsnc2Dv88IZDIbCDlBiWrknhB4Lsz7mg6BA==}- '@es-joy/[email protected]':- resolution: {integrity: sha512-xjZTSFgECpb9Ohuk5yMX5RhUEbfeQcuOp8IF60e+wyzWEF0M5xeSgqsfLtvPEX8BIyOX9saZqzuGPmZ8oWc+5Q==}- engines: {node: '>=16'}-'@es-joy/[email protected]':resolution: {integrity: sha512-+zZymuVLH6zVwXPtCAtC+bDymxmEwEqDftdAK+f407IF1bnX49anIxvBhCA1AqUIfD6egj1jM1vUnSuijjNyYg==}engines: {node: '>=18'}+ '@es-joy/[email protected]':+ resolution: {integrity: sha512-fas3qe1hw38JJgU/0m5sDpcrbZGysBeZcMwW5Ws9brYxY64MJyWLXRZCj18keTycT1LFTrFXdSNMS+GRVaU6Hw==}+ engines: {node: '>=18'}+'@esbuild/[email protected]':resolution: {integrity: sha512-1VCICWypeQKhVbE9oW/sJaAmjLxhVqacdkvPLEjwlttjfwENRSClS8EjBz0KzRyFSCPDIkuXW34Je/vk7zdB7Q==}engines: {node: '>=18'}@@ -4727,6 +4730,19 @@ packages:'@types/react-dom':optional: true+ '@radix-ui/[email protected]':+ resolution: {integrity: sha512-Wtjvx0d/6Bgd/jAYS1mW6IPSUQ25y0hkUSOS1z5/4+U8+DJPwKroqJlM/AlVFl3LywGoruiPmcvB9Aks9mSOQw==}+ peerDependencies:+ '@types/react': ^19.1.3+ '@types/react-dom': ^19.1.5+ react: ^19.1.0+ react-dom: ^19.1.0+ peerDependenciesMeta:+ '@types/react':+ optional: true+ '@types/react-dom':+ optional: true+'@radix-ui/[email protected]':resolution: {integrity: sha512-kGkGegYIdQsOb4XjsfM97rXsiHaBwco+hFI66oO4s9LU+PLAC5oJ7khdOVFxkhsmlbpUqDAvXw11CluXP+jkHg==}peerDependencies:@@ -7397,8 +7413,8 @@ packages:peerDependencies:eslint: ^8.57.0 || ^9.0.0- resolution: {integrity: sha512-JUudvooQbUx3iB8n/MzXMOV/VtaXq7xL4CeXhYryinr8osck7nV6fE2/xUXTiH3epPXcvq6TE3HQfGQuRHErTQ==}+ resolution: {integrity: sha512-hq+VQylhd12l8qjexyriDsejZhqiP33WgMTy2AmaGZ9+MrMWVqPECsM87GPxgHfQn0zw+YTuhqjUfk1f+q67aQ==}engines: {node: '>=18'}peerDependencies:eslint: ^7.0.0 || ^8.0.0 || ^9.0.0@@ -11344,7 +11360,7 @@ snapshots:eslint-plugin-antfu: 3.1.1([email protected]([email protected]))eslint-plugin-command: 3.2.0([email protected]([email protected]))- eslint-plugin-jsdoc: 50.6.14([email protected]([email protected]))+ eslint-plugin-jsdoc: 50.6.17([email protected]([email protected]))eslint-plugin-jsonc: 2.20.0([email protected]([email protected]))eslint-plugin-n: 17.18.0([email protected]([email protected]))eslint-plugin-no-only-tests: 3.3.0@@ -11918,13 +11934,16 @@ snapshots:tslib: 2.8.1optional: true- '@es-joy/[email protected]':+ '@es-joy/[email protected]':dependencies:+ '@types/eslint': 9.6.1+ '@types/estree': 1.0.7+ '@typescript-eslint/types': 8.32.0comment-parser: 1.4.1esquery: 1.6.0jsdoc-type-pratt-parser: 4.1.0- '@es-joy/[email protected]':+ '@es-joy/[email protected]':dependencies:'@types/eslint': 9.6.1'@types/estree': 1.0.7@@ -12632,6 +12651,23 @@ snapshots:'@types/react': 19.1.3'@types/react-dom': 19.1.5(@types/[email protected])+ '@radix-ui/[email protected](@types/[email protected](@types/[email protected]))(@types/[email protected])([email protected]([email protected]))([email protected])':+ dependencies:+ '@radix-ui/primitive': 1.1.2+ '@radix-ui/react-compose-refs': 1.1.2(@types/[email protected])([email protected])+ '@radix-ui/react-context': 1.1.2(@types/[email protected])([email protected])+ '@radix-ui/react-dismissable-layer': 1.1.9(@types/[email protected](@types/[email protected]))(@types/[email protected])([email protected]([email protected]))([email protected])+ '@radix-ui/react-popper': 1.2.6(@types/[email protected](@types/[email protected]))(@types/[email protected])([email protected]([email protected]))([email protected])+ '@radix-ui/react-portal': 1.1.8(@types/[email protected](@types/[email protected]))(@types/[email protected])([email protected]([email protected]))([email protected])+ '@radix-ui/react-presence': 1.1.4(@types/[email protected](@types/[email protected]))(@types/[email protected])([email protected]([email protected]))([email protected])+ '@radix-ui/react-primitive': 2.1.2(@types/[email protected](@types/[email protected]))(@types/[email protected])([email protected]([email protected]))([email protected])+ '@radix-ui/react-use-controllable-state': 1.2.2(@types/[email protected])([email protected])+ react: 19.1.0+ react-dom: 19.1.0([email protected])+ optionalDependencies:+ '@types/react': 19.1.3+ '@types/react-dom': 19.1.5(@types/[email protected])+dependencies:'@radix-ui/react-use-layout-effect': 1.1.1(@types/[email protected])([email protected])@@ -15512,9 +15548,9 @@ snapshots:- supports-color- typescriptdependencies:- '@es-joy/jsdoccomment': 0.49.0+ '@es-joy/jsdoccomment': 0.50.1are-docs-informative: 0.0.2comment-parser: 1.4.1debug: 4.4.0