JGuang

浮动指示条

FloatingIndicator · Mantine Core

交互预览
npm install @mantine/core@9.7.1 @mantine/hooks@9.7.1

浮动指示条

Mantine Core 的独立组件,请不要替换为 JGuang UI/Base UI 的同名 API。

安装

npm install @mantine/core@9.7.1 @mantine/hooks@9.7.1

入口引入 @mantine/core/styles.css,并在根组件使用 MantineProvider;通过 forceColorScheme 同步深浅色主题。

使用与验证

在左侧选择组件,在预览中操作它的状态;使用“查看代码”检查真实源码。安装后执行类型检查和构建,再验证键盘焦点、手机布局与深浅色主题。

来源

https://github.com/mantinedev/mantine/tree/f0e2bc6d28b0f0b8aaefb5b859937bf77f539df7 MIT 许可证;不包括付费内容。下方提供上游英文参考内容,中文使用指南已适配;上游详细参考暂保留英文。


版本与兼容性

固定的 Mantine Core 9.7.1 要求 React 和 React DOM 满足 ^19.2.0,并配套 @mantine/hooks@9.7.1。此条件来自实际 npm 包的 peerDependencies。React 18 或其他不兼容版本不能强行安装;先向项目负责人说明升级影响并确认方案,不使用 --force/--legacy-peer-deps 掩盖冲突。入口的原生 Provider 开启 theme.respectReducedMotion,并用 forceColorScheme 控制深浅色。

适用场景

在引用的目标元素之间移动指示条。

本地示例使用的原生参数

以下参数由本地、经过类型检查的 JSX 示例提取,按所属组件区分。不是全部属性清单;完整签名和继承关系见下方固定源码参考。

组件参数说明
Box.posMantine 定位样式参数。
Button.variant原生视觉变体,不是清单页面的场景标识。
Button.onClick本地点击处理,应按需替换为明确的业务操作。
Button.style本地样式或布局对象。
FloatingIndicator.parent包含区域的 DOM 元素引用。
FloatingIndicator.target当前组件要求的目标 DOM 引用或选择器。
FloatingIndicator.bgMantine 背景样式参数。
FloatingIndicator.style本地样式或布局对象。

交互与状态检查

当前场景:默认。切换支持的禁用、错误或只读场景后检查真实行为;无此原生状态的组件不会被强行添加统一属性。验证键盘焦点和退出方式,修改值后按原生回调签名连接业务状态。

业务接入边界

需要真实 parent 和 target DOM 引用;初始空引用是正常状态,不能用索引替代元素。

宿主配置

先安装固定版本 @mantine/core 和 @mantine/hooks,在入口引入 @mantine/core/styles.css,并使用 MantineProvider。示例的 theme 和 variant 是 JGuang 编写的宿主参数,不是所有原生组件都接受的统一 API;通过 forceColorScheme 同步应用主题。源码面板中的原生实现仅供阅读,使用 npm 导出,不要单独复制内部实现。此批只覆盖 Core,不包括日期、图表和表单扩展包。上游详细说明保留英文,不宣称全文中文化。

可运行用法

以下代码使用资源原生 API;不是把其他设计系统的同名组件替换进来。

import { useState } from 'react';
import * as M from '@mantine/core';
import '@mantine/core/styles.css';

const fruit = ["Apple", "Banana", "Orange"];
function ComponentPreview({ variant = 'Default' }: { variant?: string }) {
const [indicatorParent, setIndicatorParent] = useState<HTMLDivElement | null>(null);
const [indicatorTarget, setIndicatorTarget] = useState<HTMLButtonElement | null>(null);
return <M.Box ref={setIndicatorParent} pos="relative"><M.Group>{fruit.map((item, index) => <M.Button key={item} ref={index === 0 ? setIndicatorTarget : undefined} variant="subtle" onClick={(event) => setIndicatorTarget(event.currentTarget)} style={{ position: "relative", zIndex: 1 }}>{item}</M.Button>)}</M.Group><M.FloatingIndicator parent={indicatorParent} target={indicatorTarget} bg="blue.1" style={{ borderRadius: 8 }} /></M.Box>;
}
export default function Example({ variant = 'Default', theme = 'light' }: { variant?: string; theme?: 'light' | 'dark' }) {
return <M.MantineProvider forceColorScheme={theme} theme={{ respectReducedMotion: true }}><ComponentPreview variant={variant} /></M.MantineProvider>;
}

可用状态与示例

默认

示例遵循 Mantine 原生 API。支持多状态的输入组件可将示例中的 variant 改为 Disabled、Invalid 或 Read only;这些只是示例标签,不是新增的组件属性。改造时保留组件要求的数据、受控值、store 和复合子组件结构。

Usage

FloatingIndicator is designed to highlight the active element in a group. It can be used to create custom segmented controls, tabs and other similar components.

FloatingIndicator renders an element over the target element. To calculate the position, it is required to pass a parent element. The parent element must have position: relative CSS property – this is essential for correct positioning. The component returns null and renders nothing if either target or parent is not provided.

By default, FloatingIndicator does not have any visible styles. You can use the className prop or Styles API to apply styles. Note that the indicator's transform, width, and height styles are set directly via JavaScript to enable smooth position transitions – these cannot be overridden via the Styles API.

Multiple rows

FloatingIndicator can be used to highlight the active element in a group with multiple rows:

Example: Tabs

源码参数参考

以下实现签名和类型从本地固定版本源码生成。保留可选属性、原生继承类型、联合分支和 never 限制;不会将其他设计系统的 API 混入。forwardRef 实现中的 ref 属于 React 引用,不是新增业务属性。此区域是原始类型参考,不是上游说明的全文翻译。

FloatingIndicator(_props)
export type FloatingIndicatorStylesNames = 'root';

export type FloatingIndicatorCssVariables = {
  root: '--transition-duration';
};

export interface FloatingIndicatorProps
  extends BoxProps, StylesApiProps<FloatingIndicatorFactory>, ElementProps<'div'> {
  /** Target element over which the indicator is displayed.
   * The indicator will be positioned to match the target's size and position.
   * */
  target: HTMLElement | null | undefined;

  /** Parent container element that must have `position: relative`.
   * The indicator's position is calculated relative to this element.
   * */
  parent: HTMLElement | null | undefined;

  /** Transition duration in ms @default 150 */
  transitionDuration?: number | string;

  /** Controls whether the indicator should be hidden initially and displayed after the parent's transition ends.
   * Set to `true` when the parent container has CSS transitions (e.g., `transform: scale()`) to prevent
   * the indicator from appearing at the wrong position during the parent's animation.
   * @default false
   * */
  displayAfterTransitionEnd?: boolean;

  /** Called when the indicator starts transitioning to a new position */
  onTransitionStart?: () => void;

  /** Called when the indicator finishes transitioning to a new position */
  onTransitionEnd?: () => void;
}

export type FloatingIndicatorFactory = Factory<{
  props: FloatingIndicatorProps;
  ref: HTMLDivElement;
  stylesNames: FloatingIndicatorStylesNames;
  vars: FloatingIndicatorCssVariables;
  ctx: { shouldReduceMotion: boolean };
}>;

export type Mod = Record<string, any> | string;

export type BoxMod = Mod | Mod[] | BoxMod[];

export interface BoxProps extends MantineStyleProps {
  /** Class added to the root element, if applicable */
  className?: string | undefined;

  /** Inline style added to root component element, can subscribe to theme defined on MantineProvider */
  style?: MantineStyleProp;

  /** CSS variables defined on root component element */
  __vars?: CssVarsProp;

  /** `size` property passed down the HTML element */
  __size?: string;

  /** Breakpoint above which the component is hidden with `display: none` */
  hiddenFrom?: MantineBreakpoint;

  /** Breakpoint below which the component is hidden with `display: none` */
  visibleFrom?: MantineBreakpoint;

  /** Determines whether component should be hidden in light color scheme with `display: none` */
  lightHidden?: boolean;

  /** Determines whether component should be hidden in dark color scheme with `display: none` */
  darkHidden?: boolean;

  /** Element modifiers transformed into `data-` attributes, for example, `{ 'data-size': 'xl' }`, falsy values are removed */
  mod?: BoxMod;
}

export type ElementProps<
  ElementType extends React.ElementType,
  PropsToOmit extends string = never,
> = Omit<React.ComponentProps<ElementType>, 'style' | PropsToOmit>;

export interface CSSProperties extends React.CSSProperties {
  [key: string]: any;
}

type MantineStyle = CSSProperties | ((theme: MantineTheme) => CSSProperties);

export type MantineStyleProp = MantineStyle | MantineStyle[] | MantineStyleProp[] | undefined;

export type CssVariable = `--${string}`;

export type CssVariables<Variable extends string = CssVariable> = Partial<Record<Variable, string>>;

export type CssVars<Variable extends string = CssVariable> =
  | CssVariables<Variable>
  | ((theme: MantineTheme) => CssVariables<Variable>)
  | CssVars<Variable>[];

export type CssVarsProp<Variable extends string = CssVariable> =
  | CssVars<Variable>
  | CssVars<Variable>[];

原生与外部类型

以下外部类型仍由 React 或资源自身依赖定义,没有手工展开为虚构属性。实际可用类型以安装版本的 TypeScript 检查为准。

Factory<{
  props: FloatingIndicatorProps;
  ref: HTMLDivElement;
  stylesNames: FloatingIndicatorStylesNames;
  vars: FloatingIndicatorCssVariables;
  ctx: { shouldReduceMotion: boolean };
}>
MantineStyleProps
React.CSSProperties
MantineTheme
Partial<Record<Variable, string>>
Record<Variable, string>
Variable
MantineBreakpoint
Record<string, any>
StylesApiProps<FloatingIndicatorFactory>
React.ElementType
Omit<React.ComponentProps<ElementType>, 'style' | PropsToOmit>
React.ComponentProps<ElementType>
ElementType
PropsToOmit
HTMLElement
HTMLDivElement