Skip to content

Improve UI of RuleEngine tabs #1247

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.

Sign up for GitHub

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

Open
pfferrari wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve UI of RuleEngine tabs #1247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
302 changes: 233 additions & 69 deletions packages/app-elements/src/ui/forms/RuleEngine/RuleEngineComponent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,18 @@ import type { OnMount } from "@monaco-editor/react"
import classNames from "classnames"
import { isEqual } from "lodash-es"
import type React from "react"
import { useCallback, useEffect, useRef, useState } from "react"
import {
useCallback,
useEffect,
useLayoutEffect,
useRef,
useState,
} from "react"
import type { SetOptional } from "type-fest"
import { useTokenProvider } from "#providers/TokenProvider/TokenProvider"
import { Button } from "#ui/atoms/Button"
import { Icon, type IconProps } from "#ui/atoms/Icon"
import { Tooltip } from "#ui/atoms/Tooltip"
import { Dropdown, DropdownDivider, DropdownItem } from "#ui/composite/Dropdown"
import { CodeEditor, type CodeEditorProps } from "#ui/forms/CodeEditor"
import {
Expand Down Expand Up @@ -127,6 +134,11 @@ export function RuleEngine(props: RuleEngineProps): React.JSX.Element {
)
}

// Same shape as the drag handle of the columns menu: a small rounded rectangle,
// narrower than the circle button so the tabs bar keeps more room for the tabs.
const headerButtonClassName =
"flex items-center justify-center shrink-0 w-6 h-7 rounded text-black outline-hidden hover:bg-gray-100 focus-visible:bg-gray-100"

function RuleEditorComponent(props: RuleEngineProps): React.JSX.Element {
const {
state: { value, selectedRuleIndex },
Expand All @@ -143,6 +155,73 @@ function RuleEditorComponent(props: RuleEngineProps): React.JSX.Element {
const selectedRule = value.rules?.[selectedRuleIndex]
const codeEditorRef = useRef<Parameters<OnMount>[0] | null>(null)
const [forcedRender, setForcedRender] = useState(0)
const tabRefs = useRef<Array<HTMLDivElement | null>>([])
const tabsScrollerRef = useRef<HTMLDivElement>(null)

/**
* Store, on each tab, where its menu trigger sits within the menu's containing block,
* which is outside of the tabs scroller. The static position of the menu would not
* account for the scroller being scrolled.
*/
const positionTabMenus = useCallback(() => {
for (const tab of tabRefs.current) {
const trigger = tab?.querySelector("[aria-haspopup]")
const containingBlock = tab?.offsetParent
if (tab == null || trigger == null || containingBlock == null) {
continue
}

const triggerRect = trigger.getBoundingClientRect()
const origin =
containingBlock.getBoundingClientRect().left +
containingBlock.clientLeft -
containingBlock.scrollLeft
tab.style.setProperty(
"--tab-menu-start",
`${triggerRect.left - origin}px`,
)
tab.style.setProperty("--tab-menu-end", `${triggerRect.right - origin}px`)
}
}, [])

const [hasHiddenTabsOnRight, setHasHiddenTabsOnRight] = useState(false)

const updateTabsFade = useCallback(() => {
const scroller = tabsScrollerRef.current
if (scroller != null) {
setHasHiddenTabsOnRight(
scroller.scrollLeft + scroller.clientWidth < scroller.scrollWidth - 1,
)
}
}, [])

useEffect(
function observeTabsOverflow() {
updateTabsFade()

const scroller = tabsScrollerRef.current
if (scroller == null || typeof ResizeObserver === "undefined") {
return
}

const observer = new ResizeObserver(updateTabsFade)
observer.observe(scroller)
return () => {
observer.disconnect()
}
},
[value.rules],
)

useEffect(
function scrollSelectedTabIntoView() {
tabRefs.current[selectedRuleIndex]?.scrollIntoView?.({
block: "nearest",
inline: "nearest",
})
},
[selectedRuleIndex, value.rules?.length],
)

useEffect(
function updateCodeEditor() {
Expand Down Expand Up @@ -186,71 +265,109 @@ function RuleEditorComponent(props: RuleEngineProps): React.JSX.Element {
className={`shrink-0 basis-3/5 overflow-x-auto relative flex flex-col ${editorVisible ? "" : "grow"}`}
>
<header className="w-full bg-white border-b border-gray-200 px-4 flex text-[13px] gap-4 text-gray-400 font-semibold items-center">
<div className="flex items-center flex-wrap basis-full">
{value.rules?.map((rule, ruleIndex, rules) => {
const label = `#${(ruleIndex + 1).toString().padStart(2, "0")}`
return (
<div
// biome-ignore lint/suspicious/noArrayIndexKey: The index is used as part of a more complex key.
key={`${ruleIndex}-${rule.id}`}
className="flex items-center py-3 pl-4 pr-2 border-r basis-[88px] justify-center"
>
<button
type="button"
className={classNames("font-bold mr-2", {
"text-black": selectedRuleIndex === ruleIndex,
})}
onClick={() => {
setSelectedRuleIndex(ruleIndex)
<div className="flex items-center min-w-0 grow">
<div
ref={tabsScrollerRef}
className="flex items-center min-w-0 overflow-x-auto [scrollbar-width:thin]"
// Measured before a menu opens, and again on scroll so an open menu follows its tab
onPointerDownCapture={positionTabMenus}
onKeyDownCapture={positionTabMenus}
onScroll={() => {
positionTabMenus()
updateTabsFade()
}}
>
{value.rules?.map((rule, ruleIndex, rules) => {
const label =
rule.name?.trim() ||
`#${(ruleIndex + 1).toString().padStart(2, "0")}`
return (
<div
// biome-ignore lint/suspicious/noArrayIndexKey: The index is used as part of a more complex key.
key={`${ruleIndex}-${rule.id}`}
ref={(element) => {
tabRefs.current[ruleIndex] = element
}}
className="flex items-center shrink-0 py-3 pl-4 pr-2 border-r"
>
{label}
</button>

<Dropdown
menuPosition={
ruleIndex === 0 ? "bottom-left" : "bottom-right"
}
dropdownLabel={
<Button variant="circle">
<Icon name="dotsThreeVertical" size={16} />
</Button>
}
dropdownItems={
<>
<DropdownItem
onClick={() => {
const ruleIndex = value.rules?.length ?? 0
setPath(`rules.${ruleIndex}`, {
...rule,
id: undefined,
name: `${rule.name} (copy)`,
})
setSelectedRuleIndex(ruleIndex)
}}
label="Duplicate"
/>
<DropdownDivider />
<DropdownItem
disabled={rules.length === 1}
onClick={() => {
setPath(`rules.${ruleIndex}`, null)
if (selectedRuleIndex >= ruleIndex) {
setSelectedRuleIndex(selectedRuleIndex - 1)
}
}}
label="Delete"
/>
</>
}
/>
</div>
)
})}
<div className="min-h-[49px] flex items-center">
<Button
variant="circle"
className="mx-4"
<RuleTabLabel
label={label}
selected={selectedRuleIndex === ruleIndex}
onClick={() => {
setSelectedRuleIndex(ruleIndex)
}}
/>

<Dropdown
// The tabs live in a horizontal scroller, which also clips vertically.
// The menu is positioned against an ancestor outside of it, so it is not
// cut off: below the trigger, at the offsets `positionTabMenus` measures.
// Past the first tab it ends at the trigger's right edge.
className={classNames(
"static! [&>div:last-child]:top-auto! [&>div:last-child]:right-auto!",
ruleIndex === 0
? "[&>div:last-child]:left-(--tab-menu-start)!"
: "[&>div:last-child]:left-(--tab-menu-end)! [&>div:last-child]:-translate-x-full",
)}
menuPosition={
ruleIndex === 0 ? "bottom-left" : "bottom-right"
}
dropdownLabel={
<button
type="button"
className={headerButtonClassName}
>
<Icon
name="dotsThreeVertical"
size={16}
weight="bold"
/>
</button>
}
dropdownItems={
<>
<DropdownItem
onClick={() => {
const ruleIndex = value.rules?.length ?? 0
setPath(`rules.${ruleIndex}`, {
...rule,
id: undefined,
name: `${rule.name} (copy)`,
})
setSelectedRuleIndex(ruleIndex)
}}
label="Duplicate"
/>
<DropdownDivider />
<DropdownItem
disabled={rules.length === 1}
onClick={() => {
setPath(`rules.${ruleIndex}`, null)
if (selectedRuleIndex >= ruleIndex) {
setSelectedRuleIndex(selectedRuleIndex - 1)
}
}}
label="Delete"
/>
</>
}
/>
</div>
)
})}
</div>
{/* Hints at the tabs hidden on the right. Not positioned: as a later flex item it paints over the tabs, and below tooltips and menus. */}
<div
aria-hidden
className={classNames(
"shrink-0 self-stretch w-8 -ml-8 pointer-events-none bg-linear-to-l from-white to-transparent transition-opacity",
{ "opacity-0": !hasHiddenTabsOnRight },
)}
/>
<div className="min-h-[49px] flex items-center shrink-0">
<button
type="button"
className={classNames(headerButtonClassName, "mx-4")}
onClick={() => {
setPath(`rules.${value.rules?.length ?? 0}`, {
name: "Rule name",
Expand All @@ -261,19 +378,20 @@ function RuleEditorComponent(props: RuleEngineProps): React.JSX.Element {
}}
>
<Icon name="plus" size={16} className="shrink-0" />
</Button>
</button>
</div>
</div>

<div className="grow flex justify-end">
<Button
variant="circle"
<div className="shrink-0 flex justify-end">
<button
type="button"
className={headerButtonClassName}
onClick={() => {
setEditorVisible(!editorVisible)
}}
>
<Icon name="sidebarSimple" size={16} />
</Button>
</button>
</div>
</header>

Expand Down Expand Up @@ -365,6 +483,52 @@ function RuleEditorComponent(props: RuleEngineProps): React.JSX.Element {
)
}

/**
* The rule name shown on its tab, truncated when too long.
* Only a truncated name gets a tooltip with the full name.
*/
function RuleTabLabel({
label,
selected,
onClick,
}: {
label: string
selected: boolean
onClick: () => void
}): React.JSX.Element {
const labelRef = useRef<HTMLButtonElement>(null)
const [isTruncated, setIsTruncated] = useState(false)

useLayoutEffect(
function detectTruncation() {
const element = labelRef.current
if (element != null) {
setIsTruncated(element.scrollWidth > element.clientWidth)
}
},
[label],
)

const button = (
<button
ref={labelRef}
type="button"
className={classNames("font-bold mr-2 max-w-[160px] truncate", {
"text-black": selected,
})}
onClick={onClick}
>
{label}
</button>
)

return isTruncated ? (
<Tooltip label={button} content={label} direction="bottom-start" />
) : (
button
)
}

function CardConnector({ children }: { children: string }): React.JSX.Element {
return (
<div className="text-gray-500 flex items-center justify-center flex-col">
Expand Down
19 changes: 14 additions & 5 deletions packages/app-elements/src/ui/forms/RuleEngine/__snapshots__/index.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,21 @@ exports[`RuleEngine > renders empty without any error 1`] = `
class="w-full bg-white border-b border-gray-200 px-4 flex text-[13px] gap-4 text-gray-400 font-semibold items-center"
>
<div
class="flex items-center flex-wrap basis-full"
class="flex items-center min-w-0 grow"
>
<div
class="min-h-[49px] flex items-center"
class="flex items-center min-w-0 overflow-x-auto [scrollbar-width:thin]"
/>
<div
aria-hidden="true"
class="shrink-0 self-stretch w-8 -ml-8 pointer-events-none bg-linear-to-l from-white to-transparent transition-opacity opacity-0"
/>
<div
class="min-h-[49px] flex items-center shrink-0"
>
<button
class="mx-4 font-medium whitespace-nowrap leading-5 inline-flex items-center gap-1 justify-center transition-opacity duration-500 button h-10 min-w-10 text-base bg-white text-black hover:opacity-80 hover:bg-gray-50 rounded-full"
class="flex items-center justify-center shrink-0 w-6 h-7 rounded text-black outline-hidden hover:bg-gray-100 focus-visible:bg-gray-100 mx-4"
type="button"
>
<svg
class="shrink-0"
Expand All @@ -42,10 +50,11 @@ exports[`RuleEngine > renders empty without any error 1`] = `
</div>
</div>
<div
class="grow flex justify-end"
class="shrink-0 flex justify-end"
>
<button
class="font-medium whitespace-nowrap leading-5 inline-flex items-center gap-1 justify-center transition-opacity duration-500 button h-10 min-w-10 text-base bg-white text-black hover:opacity-80 hover:bg-gray-50 rounded-full"
class="flex items-center justify-center shrink-0 w-6 h-7 rounded text-black outline-hidden hover:bg-gray-100 focus-visible:bg-gray-100"
type="button"
>
<svg
fill="currentColor"
Expand Down
Loading