-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
feat(webapp): redesign the side menu project and organization menus #4066
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
c6138e3
f2e8a0e
440023b
d7c6af0
3aa2886
e9fe1d0
f2a3cbe
8e37da9
2fe465c
8f99e6a
f593730
d5c39f5
24557d8
0b0f66d
26aa1be
6d701ab
347fabe
0645834
72cd93d
c7e7766
ea62538
08c2ab7
1a574d7
71c540b
11efa95
907288a
aa15a48
aec6288
85feda0
a71886a
baeb7bd
635c9c7
f990d56
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| area: webapp | ||
| type: improvement | ||
| --- | ||
|
|
||
| Refresh the side menu and account UI: | ||
|
|
||
| - Add a new "Project" section above the "Environment" section with a popover | ||
| that lists the org's projects (folder icon + checkmark for the selected one) | ||
| and a "New project" item at the bottom. | ||
| - The top-left menu now shows the organization (avatar + org name, no | ||
| project/diagonal divider) and its popover is a clean list of org-level items | ||
| (Settings, Usage, Billing with plan badge, Billing alerts, Team, Private | ||
| connections, Roles, SSO, Vercel integration, Slack integration, Switch | ||
| organization), with a separate account menu button (Profile, Personal Access | ||
| Tokens, Security, admin/impersonation, Logout) beside it. | ||
| - Match the Environment selector popover's item sizing (icons and labels, | ||
| including the branch submenu and its footer) to the Project popover so the two | ||
| side-menu menus are visually consistent. | ||
| - Redesign the account Profile page (/account) into the Security page's | ||
| row-and-divider layout: Profile picture, Full name, Email address, and a | ||
| "Receive onboarding emails" toggle on equal-height rows, with a primary Update | ||
| button. | ||
| - Signal impersonation mode with a yellow side-menu border and a matching | ||
| "Stop impersonating" accent. | ||
| - Move the Settings item to the top of the organization settings side menu. | ||
| - Align the organization settings and account side menus' horizontal padding | ||
| with the main side menu, and tighten the "Personal Access Tokens" label so it | ||
| no longer truncates. | ||
| - Restyle the "Shortcuts" and "Contact us…" entries in the Help & Feedback | ||
| popover to match the other menu items (icon size/alignment, dimmed text, text | ||
| size). | ||
| - Make the main side menu resizable: drag its right edge to set a custom width | ||
| (remembered per user), with the labels, headers, and padding transitioning in | ||
| real time and a snap to open or collapsed when released below the default | ||
| width. Clicking the edge toggles the menu and a tooltip explains both | ||
| gestures. | ||
|
|
||
| The org loader now exposes whether the RBAC and SSO plugins are installed so the | ||
| side menu can gate the Roles and SSO items the same way the settings side menu | ||
| does. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| export function ChainLinkIcon({ className }: { className?: string }) { | ||
| return ( | ||
| <svg | ||
| className={className} | ||
| width="24" | ||
| height="24" | ||
| viewBox="0 0 24 24" | ||
| fill="none" | ||
| xmlns="http://www.w3.org/2000/svg" | ||
| > | ||
| <path | ||
| d="M10 19.0004L9.82843 19.1719C8.26634 20.734 5.73368 20.734 4.17158 19.1719L3.82843 18.8288C2.26634 17.2667 2.26633 14.734 3.82843 13.1719L7.17158 9.8288C8.73368 8.2667 11.2663 8.2667 12.8284 9.8288L13.1716 10.1719C13.8252 10.8256 14.2053 11.6491 14.312 12.5004" | ||
| stroke="currentColor" | ||
| strokeWidth="2" | ||
| strokeLinecap="round" | ||
| strokeLinejoin="round" | ||
| /> | ||
| <path | ||
| d="M9.68799 12.5004C9.79463 13.3516 10.1748 14.1752 10.8284 14.8288L11.1715 15.1719C12.7336 16.734 15.2663 16.734 16.8284 15.1719L20.1715 11.8288C21.7336 10.2667 21.7336 7.73404 20.1715 6.17194L19.8284 5.8288C18.2663 4.2667 15.7336 4.2667 14.1715 5.8288L14 6.00037" | ||
| stroke="currentColor" | ||
| strokeWidth="2" | ||
| strokeLinecap="round" | ||
| strokeLinejoin="round" | ||
| /> | ||
| </svg> | ||
| ); | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| export function LeftSideMenuCollapsedIcon({ className }: { className?: string }) { | ||
| return ( | ||
| <svg | ||
| className={className} | ||
| width="24" | ||
| height="24" | ||
| viewBox="0 0 24 24" | ||
| fill="none" | ||
| xmlns="http://www.w3.org/2000/svg" | ||
| > | ||
| <rect x="4" y="4" width="16" height="16" rx="3" stroke="currentColor" strokeWidth="2" /> | ||
| <rect x="6" y="6" width="2" height="12" rx="1" fill="currentColor" /> | ||
| <path | ||
| d="M12 14.5L14.5 12L12 9.5" | ||
| stroke="currentColor" | ||
| strokeWidth="2" | ||
| strokeLinecap="round" | ||
| strokeLinejoin="round" | ||
| /> | ||
| </svg> | ||
| ); | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| import { motion } from "framer-motion"; | ||
| import { useState } from "react"; | ||
|
|
||
| export function LeftSideMenuIcon({ | ||
| className, | ||
| hovered: controlledHovered, | ||
| }: { | ||
| className?: string; | ||
| /** | ||
| * When provided, the shape animation is driven by this prop (e.g. from a | ||
| * parent button's hover). When omitted, the icon animates on its own hover. | ||
| */ | ||
| hovered?: boolean; | ||
| }) { | ||
| const [internalHovered, setInternalHovered] = useState(false); | ||
| const isControlled = controlledHovered !== undefined; | ||
| const hovered = isControlled ? controlledHovered : internalHovered; | ||
|
|
||
| return ( | ||
| <svg | ||
| className={className} | ||
| width="24" | ||
| height="24" | ||
| viewBox="0 0 24 24" | ||
| fill="none" | ||
| xmlns="http://www.w3.org/2000/svg" | ||
| onMouseEnter={isControlled ? undefined : () => setInternalHovered(true)} | ||
| onMouseLeave={isControlled ? undefined : () => setInternalHovered(false)} | ||
| > | ||
| <rect x="4" y="4" width="16" height="16" rx="2" stroke="currentColor" strokeWidth="2" /> | ||
| {/* Animate a transform (scaleX) rather than the SVG `width` attribute: | ||
| framer snaps the first animation of an SVG geometry attribute after it | ||
| has been idle, whereas transforms animate reliably. Anchoring the origin | ||
| to the left edge collapses the panel from right to left. */} | ||
| <motion.rect | ||
| x="6" | ||
| y="6" | ||
| width="5" | ||
| height="12" | ||
| rx="1" | ||
| fill="currentColor" | ||
| initial={false} | ||
| style={{ originX: 0 }} | ||
| animate={{ scaleX: hovered ? 0.2 : 1 }} | ||
| transition={{ duration: 0.3, ease: "easeInOut" }} | ||
| /> | ||
| </svg> | ||
| ); | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,11 +11,12 @@ import { useSearchParams } from "@remix-run/react"; | |
| import DOMPurify from "dompurify"; | ||
| import { motion } from "framer-motion"; | ||
| import { marked } from "marked"; | ||
| import { useCallback, useEffect, useRef, useState } from "react"; | ||
| import { type ReactNode, useCallback, useEffect, useRef, useState } from "react"; | ||
| import { useTypedRouteLoaderData } from "remix-typedjson"; | ||
| import { AISparkleIcon } from "~/assets/icons/AISparkleIcon"; | ||
| import { SparkleListIcon } from "~/assets/icons/SparkleListIcon"; | ||
| import { useFeatures } from "~/hooks/useFeatures"; | ||
| import { useShortcutKeys } from "~/hooks/useShortcutKeys"; | ||
| import { type loader } from "~/root"; | ||
| import { Button } from "./primitives/Buttons"; | ||
| import { Callout } from "./primitives/Callout"; | ||
|
|
@@ -38,6 +39,105 @@ function useKapaWebsiteId() { | |
| return routeMatch?.kapa.websiteId; | ||
| } | ||
|
|
||
| /** Open/close state for the Ask AI dialog, including the `?aiHelp=` deep-link handling. */ | ||
| function useAskAIState() { | ||
| const [isOpen, setIsOpen] = useState(false); | ||
| const [initialQuery, setInitialQuery] = useState<string | undefined>(); | ||
| const [searchParams, setSearchParams] = useSearchParams(); | ||
|
|
||
| const openAskAI = useCallback((question?: string) => { | ||
| if (question) { | ||
| setInitialQuery(question); | ||
| } else { | ||
| setInitialQuery(undefined); | ||
| } | ||
| setIsOpen(true); | ||
| }, []); | ||
|
|
||
| const closeAskAI = useCallback(() => { | ||
| setIsOpen(false); | ||
| setInitialQuery(undefined); | ||
| }, []); | ||
|
|
||
| // Handle URL param functionality | ||
| useEffect(() => { | ||
| const aiHelp = searchParams.get("aiHelp"); | ||
| if (aiHelp) { | ||
| // Delay to avoid hCaptcha bot detection | ||
| window.setTimeout(() => openAskAI(aiHelp), 1000); | ||
|
|
||
| // Clone instead of mutating in place | ||
| const next = new URLSearchParams(searchParams); | ||
| next.delete("aiHelp"); | ||
| setSearchParams(next); | ||
| } | ||
| }, [searchParams, openAskAI]); | ||
|
|
||
| return { isOpen, setIsOpen, initialQuery, openAskAI, closeAskAI }; | ||
| } | ||
|
|
||
| /** | ||
| * Hosts Ask AI for a menu that renders its own trigger (the side menu's Help & Feedback popover): | ||
| * the Kapa provider, the global ⌘I shortcut, and the dialog all live here, and `children` | ||
| * receives the open function to render a trigger with. Wrap this around the popover rather than | ||
| * inside its content so the dialog and shortcut survive the popover closing. `children` receives | ||
| * undefined when Ask AI is unavailable (self-hosted, no Kapa website id, or during SSR). | ||
| */ | ||
| export function AskAIRoot({ | ||
| children, | ||
| }: { | ||
| children: (openAskAI: (() => void) | undefined) => ReactNode; | ||
| }) { | ||
| const { isManagedCloud } = useFeatures(); | ||
| const websiteId = useKapaWebsiteId(); | ||
|
|
||
| if (!isManagedCloud || !websiteId) { | ||
| return <>{children(undefined)}</>; | ||
| } | ||
|
|
||
| return ( | ||
| <ClientOnly fallback={<>{children(undefined)}</>}> | ||
| {() => <AskAIRootProvider websiteId={websiteId}>{children}</AskAIRootProvider>} | ||
| </ClientOnly> | ||
| ); | ||
| } | ||
|
|
||
| function AskAIRootProvider({ | ||
| websiteId, | ||
| children, | ||
| }: { | ||
| websiteId: string; | ||
| children: (openAskAI: () => void) => ReactNode; | ||
| }) { | ||
| const { isOpen, setIsOpen, initialQuery, openAskAI, closeAskAI } = useAskAIState(); | ||
|
|
||
| useShortcutKeys({ | ||
| shortcut: { modifiers: ["mod"], key: "i", enabledOnInputElements: true }, | ||
| action: () => openAskAI(), | ||
| }); | ||
|
|
||
| return ( | ||
| <KapaProvider | ||
| integrationId={websiteId} | ||
| callbacks={{ | ||
| askAI: { | ||
| onQuerySubmit: () => openAskAI(), | ||
| onAnswerGenerationCompleted: () => openAskAI(), | ||
| }, | ||
| }} | ||
| botProtectionMechanism="hcaptcha" | ||
| > | ||
| {children(() => openAskAI())} | ||
| <AskAIDialog | ||
| initialQuery={initialQuery} | ||
| isOpen={isOpen} | ||
| onOpenChange={setIsOpen} | ||
| closeAskAI={closeAskAI} | ||
| /> | ||
| </KapaProvider> | ||
| ); | ||
| } | ||
|
|
||
| export function AskAI({ isCollapsed = false }: { isCollapsed?: boolean }) { | ||
| const { isManagedCloud } = useFeatures(); | ||
| const websiteId = useKapaWebsiteId(); | ||
|
Comment on lines
141
to
143
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔍 Old AskAI export kept alongside new AskAIRoot — potential for duplicate Kapa providers The original (Refers to lines 141-167) Was this helpful? React with 👍 or 👎 to provide feedback. |
||
|
|
@@ -72,37 +172,7 @@ type AskAIProviderProps = { | |
| }; | ||
|
|
||
| function AskAIProvider({ websiteId, isCollapsed = false }: AskAIProviderProps) { | ||
| const [isOpen, setIsOpen] = useState(false); | ||
| const [initialQuery, setInitialQuery] = useState<string | undefined>(); | ||
| const [searchParams, setSearchParams] = useSearchParams(); | ||
|
|
||
| const openAskAI = useCallback((question?: string) => { | ||
| if (question) { | ||
| setInitialQuery(question); | ||
| } else { | ||
| setInitialQuery(undefined); | ||
| } | ||
| setIsOpen(true); | ||
| }, []); | ||
|
|
||
| const closeAskAI = useCallback(() => { | ||
| setIsOpen(false); | ||
| setInitialQuery(undefined); | ||
| }, []); | ||
|
|
||
| // Handle URL param functionality | ||
| useEffect(() => { | ||
| const aiHelp = searchParams.get("aiHelp"); | ||
| if (aiHelp) { | ||
| // Delay to avoid hCaptcha bot detection | ||
| window.setTimeout(() => openAskAI(aiHelp), 1000); | ||
|
|
||
| // Clone instead of mutating in place | ||
| const next = new URLSearchParams(searchParams); | ||
| next.delete("aiHelp"); | ||
| setSearchParams(next); | ||
| } | ||
| }, [searchParams, openAskAI]); | ||
| const { isOpen, setIsOpen, initialQuery, openAskAI, closeAskAI } = useAskAIState(); | ||
|
|
||
| return ( | ||
| <KapaProvider | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔍 Duplicate ⌘I shortcut and ?aiHelp= handling when AskAIRoot and AskAI are co-mounted
The
useAskAIStatehook (extracted atapps/webapp/app/components/AskAI.tsx:43) is now used by bothAskAIRootProvider(mounted insideHelpAndFeedbackin the main SideMenu) andAskAIProvider(mounted insideBlankStatePanels). When both are on screen simultaneously, two instances of the?aiHelp=URL-param effect and two ⌘I shortcut registrations are active. This is a pre-existing issue (the old code had<AskAI />in both the SideMenu bottom bar and BlankStatePanels), but the refactor makes it more visible since the two code paths now share the same extracted hook.Was this helpful? React with 👍 or 👎 to provide feedback.