The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Restyle NavLink with primary and secondary variants (#80640)
Oleh K11be7cb3e763
diff --git a/.loki/reference/chrome_laptop_Components_Navigation_NavLink_Overview.png b/.loki/reference/chrome_laptop_Components_Navigation_NavLink_Overview.pngnew file mode 100644index 00000000000..3c6d2e7b9faBinary files /dev/null and b/.loki/reference/chrome_laptop_Components_Navigation_NavLink_Overview.png differdiff --git a/.loki/reference/chrome_laptop_Design_System_Colors_Default.png b/.loki/reference/chrome_laptop_Design_System_Colors_Default.pngindex f7488fedbf7..a6f15260f1d 100644Binary files a/.loki/reference/chrome_laptop_Design_System_Colors_Default.png and b/.loki/reference/chrome_laptop_Design_System_Colors_Default.png differdiff --git a/enterprise/frontend/src/embedding/data-picker/SimpleDataPicker/SimpleDataPickerView.tsx b/enterprise/frontend/src/embedding/data-picker/SimpleDataPicker/SimpleDataPickerView.tsxindex dc2bffe666e..6c2217947da 100644--- a/enterprise/frontend/src/embedding/data-picker/SimpleDataPicker/SimpleDataPickerView.tsx+++ b/enterprise/frontend/src/embedding/data-picker/SimpleDataPicker/SimpleDataPickerView.tsx@@ -83,7 +83,7 @@ export function SimpleDataPickerView({leftSection={<Icon c={iconColor} name="table" aria-hidden />}label={tc(option.name)}onClick={() => onClick(option.id)}- variant="default"+ variant="primary"/>);})}diff --git a/frontend/src/metabase/admin/components/AdminNav/AdminNav.tsx b/frontend/src/metabase/admin/components/AdminNav/AdminNav.tsxindex f71e08e5858..1112ae5b2c5 100644--- a/frontend/src/metabase/admin/components/AdminNav/AdminNav.tsx+++ b/frontend/src/metabase/admin/components/AdminNav/AdminNav.tsx@@ -47,7 +47,7 @@ export function AdminNavItem({to={path ?? ""}defaultOpened={folderPattern ? subpath.includes(folderPattern) : false}active={path === subpath}- variant="admin-nav"+ variant="secondary"label={label}mb="xs"{...(icon ? { leftSection: <Icon name={icon} /> } : undefined)}diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/ItemList.tsx b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/ItemList.tsxindex 3b3d8208ae5..2842f4beebb 100644--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/ItemList.tsx+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/ItemList.tsx@@ -158,7 +158,7 @@ export function ItemList({onChange(item);}}}- variant={isCurrentLevel ? "default" : "mb-light"}+ variant={isCurrentLevel ? "primary" : "secondary"}{...navLinkProps?.(isSelected)}/></Tooltip>diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/SearchResults.tsx b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/SearchResults.tsxindex 6d410cd679c..5b3c9b0b7b3 100644--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/SearchResults.tsx+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/SearchResults.tsx@@ -134,7 +134,7 @@ export const SearchResults = ({}}}}- variant="default"+ variant="primary"/></Box>);diff --git a/frontend/src/metabase/ui/colors/constants/themes/dark.ts b/frontend/src/metabase/ui/colors/constants/themes/dark.tsindex e340fd71ab5..ad52ac2e648 100644--- a/frontend/src/metabase/ui/colors/constants/themes/dark.ts+++ b/frontend/src/metabase/ui/colors/constants/themes/dark.ts@@ -43,9 +43,13 @@ const deprecatedColors = {filter: baseColors.octopus[40],focus: baseColors.blue[70],"icon-brand": baseColors.brand[40], // Matches text-brand+ "icon-brand-inverse": baseColors.brand[50],"icon-primary": baseColors.orionAlphaInverse[80], // Matches text-primary+ "icon-primary-inverse": baseColors.orionAlpha[80], // Matches text-primary-inverse"icon-disabled": baseColors.orionAlphaInverse[40], // Matches text-disabled+ "icon-disabled-inverse": baseColors.orionAlpha[40], // Matches text-disabled-inverse"icon-secondary": baseColors.orionAlphaInverse[60], // Matches text-secondary+ "icon-secondary-inverse": baseColors.orionAlpha[60], // Matches text-secondary-inverse"illustration-brand-secondary": baseColors.brand[80],"illustration-brand-tertiary": baseColors.brand[90],"metabase-brand": baseColors.blue[40],diff --git a/frontend/src/metabase/ui/colors/constants/themes/light.ts b/frontend/src/metabase/ui/colors/constants/themes/light.tsindex 31a683236e6..9cfae977c15 100644--- a/frontend/src/metabase/ui/colors/constants/themes/light.ts+++ b/frontend/src/metabase/ui/colors/constants/themes/light.ts@@ -38,9 +38,13 @@ const deprecatedColors = {filter: baseColors.octopus[50],focus: baseColors.blue[20],"icon-brand": baseColors.brand[50], // Matches text-brand+ "icon-brand-inverse": baseColors.brand[20],"icon-primary": baseColors.orionAlpha[80], // Matches text-primary+ "icon-primary-inverse": baseColors.orionAlphaInverse[80], // Matches text-primary-inverse"icon-disabled": baseColors.orionAlpha[40], // Matches text-disabled+ "icon-disabled-inverse": baseColors.orionAlphaInverse[40], // Matches text-disabled-inverse"icon-secondary": baseColors.orionAlpha[60], // Matches text-secondary+ "icon-secondary-inverse": baseColors.orionAlphaInverse[60], // Matches text-secondary-inverse"illustration-brand-secondary": baseColors.brand[10],"illustration-brand-tertiary": baseColors.brand[5],"metabase-brand": baseColors.blue[40],diff --git a/frontend/src/metabase/ui/colors/types/color-keys.ts b/frontend/src/metabase/ui/colors/types/color-keys.tsindex 395bf9ac60e..c2871e65f4c 100644--- a/frontend/src/metabase/ui/colors/types/color-keys.ts+++ b/frontend/src/metabase/ui/colors/types/color-keys.ts@@ -52,9 +52,13 @@ export type MetabaseColorKey =| "focus"| "gold"| "icon-brand"+ | "icon-brand-inverse"| "icon-disabled"+ | "icon-disabled-inverse"| "icon-primary"+ | "icon-primary-inverse"| "icon-secondary"+ | "icon-secondary-inverse"| "illustration-brand-secondary"| "illustration-brand-tertiary"| "info"diff --git a/frontend/src/metabase/ui/components/navigation/NavLink/NavLink.module.css b/frontend/src/metabase/ui/components/navigation/NavLink/NavLink.module.cssindex fd211e8fe19..a31919eadb1 100644--- a/frontend/src/metabase/ui/components/navigation/NavLink/NavLink.module.css+++ b/frontend/src/metabase/ui/components/navigation/NavLink/NavLink.module.css@@ -1,76 +1,74 @@.NavLink {border-radius: 0.5rem;- &[data-variant="default"] {- &:hover {- background-color: var(--mb-color-background_surface-hover);- }+ &[data-variant="secondary"],+ &[data-variant="primary"] {+ border-radius: var(--mantine-radius-sm);- &[data-active] {- color: var(--mb-color-text-primary-inverse);+ .NavLinkSection[data-position="left"] {+ color: var(--mb-color-icon-brand);+ }- &,- &:hover {- background-color: var(--mb-color-core-brand);- }+ &:hover:not([data-active], :has([data-navlink-button]:hover)) {+ background-color: var(--mb-color-background_surface-primary-hover);+ }- .NavLinkLabel {- color: var(--mb-color-text-primary-inverse);- }+ &:active:not([data-active], :has([data-navlink-button]:active)) {+ background-color: var(--mb-color-background_surface-primary-pressed);+ }- .NavLinkChevron {- color: var(--mb-color-text-primary-inverse);- }+ [data-navlink-button]:hover {+ background-color: var(--mb-color-background_surface-primary-hover);}- &:not([data-active]) {- /* apply default icon color for section icons when inactive */- .NavLinkSection {- color: var(--mb-color-text-primary);- }+ [data-navlink-button]:active {+ background-color: var(--mb-color-background_surface-primary-pressed);}}- &[data-variant="mb-light"] {+ &[data-variant="secondary"][data-active] {+ color: var(--mb-color-text-primary);++ &,&:hover {- background-color: var(--mb-color-background_surface-hover);+ background-color: var(--mb-color-background_surface-secondary);}- &[data-active] {- &,- .NavLinkLabel {- color: var(--mb-color-text-primary);- }-- background-color: var(--mb-color-background_page-tertiary);+ .NavLinkLabel {+ color: var(--mb-color-text-primary);}}- &[data-variant="admin-nav"] {+ &[data-variant="primary"][data-active] {+ color: var(--mb-color-text-primary-inverse);++ &,&:hover {- background-color: var(--mb-color-background_surface-hover);+ background-color: var(--mb-color-background_surface-brand-strong);}.NavLinkLabel {- color: var(--mb-color-text-primary);+ color: var(--mb-color-text-primary-inverse);}- &[data-active] {- color: var(--mb-color-text-brand);+ .NavLinkSection {+ color: var(--mb-color-icon-primary-inverse);+ }- &,- &:hover {- background-color: var(--mb-color-background_surface-selected);- }+ .NavLinkSection[data-position="left"] {+ color: var(--mb-color-icon-brand-inverse);+ }- .NavLinkLabel {- color: var(--mb-color-text-brand);- }+ .NavLinkChevron {+ color: var(--mb-color-text-primary-inverse);+ }- .NavLinkChevron {- color: var(--mb-color-text-brand);- }+ [data-navlink-button] {+ color: var(--mb-color-text-primary-inverse);}++ --navlink-badge-bg: var(--mb-color-background_surface-secondary-inverse);+ --navlink-badge-color: var(--mb-color-text-primary-inverse);}}diff --git a/frontend/src/metabase/ui/components/navigation/NavLink/NavLink.stories.tsx b/frontend/src/metabase/ui/components/navigation/NavLink/NavLink.stories.tsxindex e57ff197db2..08a8664ad26 100644--- a/frontend/src/metabase/ui/components/navigation/NavLink/NavLink.stories.tsx+++ b/frontend/src/metabase/ui/components/navigation/NavLink/NavLink.stories.tsx@@ -1,44 +1,169 @@-import type { NavLinkProps } from "@mantine/core";+import type { StoryFn } from "@storybook/react";+import { Fragment, type ReactNode } from "react";-import { Icon, NavLink } from "metabase/ui";+import {+ Box,+ Icon,+ NavLink,+ NavLinkBadge,+ NavLinkButton,+ type NavLinkProps,+ Stack,+ Text,+} from "metabase/ui";+import { StoryJsx, StoryShowcase } from "metabase/ui/stories/showcase";++const LABEL = "Label";++type ContentColumn = {+ key: string;+ header: string;+ rightSection: ReactNode;+};++const COLUMNS: ContentColumn[] = [+ {+ key: "plain",+ header: `<NavLink leftSection={<Icon />} />`,+ rightSection: null,+ },+ {+ key: "icon",+ header: `<NavLink rightSection={<Icon />} />`,+ rightSection: <Icon name="chevronright" />,+ },+ {+ key: "button",+ header: `<NavLink rightSection={<NavLinkButton />} />`,+ rightSection: <NavLinkButton>Button</NavLinkButton>,+ },+ {+ key: "badge",+ header: `<NavLink rightSection={<NavLinkBadge />} />`,+ rightSection: <NavLinkBadge>3</NavLinkBadge>,+ },+];++type NavLinkState = {+ id: string;+ label: string;+ active?: boolean;+ disabled?: boolean;+};++const STATES: NavLinkState[] = [+ { id: "default", label: "Default" },+ { id: "hover", label: "Hover" },+ { id: "pressed", label: "Pressed" },+ { id: "selected", label: "Selected", active: true },+ { id: "disabled", label: "Disabled", disabled: true },+];++const VARIANTS = [+ { variant: "primary", title: "NavLink — primary" },+ { variant: "secondary", title: "NavLink — secondary" },+] as const;++const rowSelector = (id: string) => `[data-state-row="${id}"]`;++const PSEUDO_STATE_PARAMETERS = {+ pseudo: {+ hover: [rowSelector("hover")],+ active: [rowSelector("pressed")],+ },+};++type VariantMatrixProps = {+ variant: NavLinkProps["variant"];+ title: string;+};++function VariantMatrix({ variant, title }: VariantMatrixProps) {+ return (+ <StoryShowcase title={title}>+ <Box+ style={{+ display: "grid",+ gridTemplateColumns: `10rem repeat(${COLUMNS.length}, minmax(13rem, max-content))`,+ columnGap: "2rem",+ rowGap: "0.75rem",+ alignItems: "center",+ }}+ >+ <div />+ {COLUMNS.map((column) => (+ <StoryJsx key={column.key}>{column.header}</StoryJsx>+ ))}++ {STATES.map((state) => (+ <Fragment key={state.id}>+ <Text size="sm" c="text-secondary">+ {state.label}+ </Text>+ {COLUMNS.map((column) => (+ <NavLink+ key={column.key}+ component="div"+ data-state-row={state.id}+ variant={variant}+ label={LABEL}+ leftSection={<Icon name="home" />}+ rightSection={column.rightSection}+ active={state.active ?? false}+ disabled={state.disabled ?? false}+ />+ ))}+ </Fragment>+ ))}+ </Box>+ </StoryShowcase>+ );+}++const OverviewTemplate: StoryFn<NavLinkProps> = () => (+ <Stack gap="xl" align="flex-start">+ {VARIANTS.map(({ variant, title }) => (+ <VariantMatrix key={variant} variant={variant} title={title} />+ ))}+ </Stack>+);++const RIGHT_SECTIONS: Record<string, ReactNode> = {+ none: null,+ icon: <Icon name="chevronright" />,+ button: <NavLinkButton>Button</NavLinkButton>,+ badge: <NavLinkBadge>3</NavLinkBadge>,+};const args: Partial<NavLinkProps> = {- label: "Label",+ variant: "secondary",+ label: LABEL,+ active: false,disabled: false,leftSection: "icon",- rightSection: null,- mod: "inactive",+ rightSection: "none",};const argTypes = {+ variant: {+ control: "inline-radio",+ options: ["secondary", "primary"],+ },leftSection: {control: "select",- options: [null, "icon"],+ options: ["none", "icon"],mapping: {- null: null,- icon: <Icon name="chevronright" size="10" />,+ none: null,+ icon: <Icon name="home" />,},},rightSection: {control: "select",- options: [null, "icon"],- mapping: {- null: null,- icon: <Icon name="ai" />,- },- },- mod: {- control: "inline-radio",- options: ["active", "inactive"],- mapping: {- active: { active: true },- inactive: { active: false },- },- },- variant: {- control: "inline-radio",- options: ["default", "mb-light"],+ options: ["none", "icon", "button", "badge"],+ mapping: RIGHT_SECTIONS,},+ active: { control: "boolean" },+ disabled: { control: "boolean" },};export default {@@ -48,29 +173,12 @@ export default {argTypes,};-export const Default = {- args: {- variant: "default",- mod: "inactive",- },-};-export const DefaultActive = {- args: {- variant: "default",- mod: "active",- },-};--export const MBLightInactive = {- args: {- variant: "mb-light",- mod: "inactive",- },-};+export const Default = {};-export const MBLightActive = {- args: {- variant: "mb-light",- mod: "active",+export const Overview = {+ render: OverviewTemplate,+ parameters: {+ ...PSEUDO_STATE_PARAMETERS,+ controls: { include: [] },},};diff --git a/frontend/src/metabase/ui/components/navigation/NavLinkBadge/NavLinkBadge.tsx b/frontend/src/metabase/ui/components/navigation/NavLinkBadge/NavLinkBadge.tsxnew file mode 100644index 00000000000..b37bfbfdfab--- /dev/null+++ b/frontend/src/metabase/ui/components/navigation/NavLinkBadge/NavLinkBadge.tsx@@ -0,0 +1,29 @@+import { forwardRef } from "react";++import { Badge, type BadgeProps } from "metabase/ui";++export type NavLinkBadgeProps = BadgeProps;++/**+ * A notification badge for a `NavLink`'s right section.+ */+export const NavLinkBadge = forwardRef<HTMLDivElement, NavLinkBadgeProps>(+ function NavLinkBadge(props, ref) {+ return (+ <Badge+ ref={ref}+ variant="light"+ {...props}+ styles={{+ root: {+ backgroundColor:+ "var(--navlink-badge-bg, var(--mb-color-background_surface-secondary))",+ },+ label: {+ color: "var(--navlink-badge-color, var(--mb-color-text-primary))",+ },+ }}+ />+ );+ },+);diff --git a/frontend/src/metabase/ui/components/navigation/NavLinkBadge/index.ts b/frontend/src/metabase/ui/components/navigation/NavLinkBadge/index.tsnew file mode 100644index 00000000000..e06efbccb84--- /dev/null+++ b/frontend/src/metabase/ui/components/navigation/NavLinkBadge/index.ts@@ -0,0 +1 @@+export { NavLinkBadge, type NavLinkBadgeProps } from "./NavLinkBadge";diff --git a/frontend/src/metabase/ui/components/navigation/NavLinkButton/NavLinkButton.module.css b/frontend/src/metabase/ui/components/navigation/NavLinkButton/NavLinkButton.module.cssnew file mode 100644index 00000000000..fde9f64bae9--- /dev/null+++ b/frontend/src/metabase/ui/components/navigation/NavLinkButton/NavLinkButton.module.css@@ -0,0 +1,21 @@+.root {+ display: inline-flex;+ align-items: center;+ justify-content: center;+ height: 1rem;+ min-height: 1rem;+ padding: 0 var(--mantine-spacing-xs);+ border-radius: var(--mantine-radius-xs);+ color: var(--mb-color-text-brand);+ font-size: 0.75rem;+ font-weight: 500;+ line-height: 1rem;+ white-space: nowrap;+ cursor: pointer;+ user-select: none;++ &[aria-disabled="true"] {+ color: var(--mb-color-text-disabled);+ cursor: default;+ }+}diff --git a/frontend/src/metabase/ui/components/navigation/NavLinkButton/NavLinkButton.tsx b/frontend/src/metabase/ui/components/navigation/NavLinkButton/NavLinkButton.tsxnew file mode 100644index 00000000000..3331c999f27--- /dev/null+++ b/frontend/src/metabase/ui/components/navigation/NavLinkButton/NavLinkButton.tsx@@ -0,0 +1,63 @@+import cx from "classnames";+import {+ type ComponentPropsWithoutRef,+ type KeyboardEvent,+ type MouseEvent,+ forwardRef,+} from "react";++import { Box } from "metabase/ui";++import S from "./NavLinkButton.module.css";++export type NavLinkButtonProps = ComponentPropsWithoutRef<"div"> & {+ disabled?: boolean;+};++/**+ * A compact action button sized to sit in a `NavLink`'s right section.+ *+ * A `NavLink` renders as an `<a>`, and a nested `<button>` would be invalid+ * HTML, so this is a `<div role="button">` (with keyboard activation) instead.+ */+export const NavLinkButton = forwardRef<HTMLDivElement, NavLinkButtonProps>(+ function NavLinkButton(+ { onClick, disabled, className, children, ...props },+ ref,+ ) {+ const handleClick = (event: MouseEvent<HTMLDivElement>) => {+ if (disabled) {+ return;+ }+ // The button is an independent target inside a clickable NavLink; keep its+ // click from bubbling up and triggering the row.+ event.stopPropagation();+ onClick?.(event);+ };++ const handleKeyDown = (event: KeyboardEvent<HTMLDivElement>) => {+ // A `<div role="button">` doesn't activate on keyboard like a native+ // button, so wire up Enter/Space ourselves.+ if (!disabled && (event.key === "Enter" || event.key === " ")) {+ event.preventDefault();+ event.currentTarget.click();+ }+ };++ return (+ <Box+ {...props}+ ref={ref}+ role="button"+ tabIndex={disabled ? -1 : 0}+ aria-disabled={disabled || undefined}+ data-navlink-button+ className={cx(S.root, className)}+ onClick={handleClick}+ onKeyDown={handleKeyDown}+ >+ {children}+ </Box>+ );+ },+);diff --git a/frontend/src/metabase/ui/components/navigation/NavLinkButton/index.ts b/frontend/src/metabase/ui/components/navigation/NavLinkButton/index.tsnew file mode 100644index 00000000000..0909bf42510--- /dev/null+++ b/frontend/src/metabase/ui/components/navigation/NavLinkButton/index.ts@@ -0,0 +1 @@+export { NavLinkButton, type NavLinkButtonProps } from "./NavLinkButton";diff --git a/frontend/src/metabase/ui/components/navigation/index.ts b/frontend/src/metabase/ui/components/navigation/index.tsindex f54f6b7b584..f757b8bc495 100644--- a/frontend/src/metabase/ui/components/navigation/index.ts+++ b/frontend/src/metabase/ui/components/navigation/index.ts@@ -1,3 +1,5 @@export * from "./Breadcrumbs";export * from "./NavLink";+export * from "./NavLinkBadge";+export * from "./NavLinkButton";export * from "./Tabs";diff --git a/loki.config.js b/loki.config.jsindex 4f305496568..b9103d2553c 100644--- a/loki.config.js+++ b/loki.config.js@@ -18,6 +18,7 @@ module.exports = {"^Components/Feedback/Alert","^Components/Ask Before Using/Chip Overview","^Components/Data display/Badge Sizes and variants",+ "^Components/Navigation/NavLink Overview","^Components/Data display/KeyboardShortcut Overview","^Components/Table","^App/Palette",