JGuang
中

Marquee

Marquee · Mantine Core

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

Marquee

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

Version and compatibility

Pinned Mantine Core 9.7.1 requires React and React DOM ^19.2.0 and matching @mantine/hooks@9.7.1, from the installed npm package's peerDependencies. Do not force it into React 18 or another incompatible version. Explain upgrade impact and agree on a plan with the project owner; do not hide conflicts with --force/--legacy-peer-deps. The native Provider enables theme.respectReducedMotion and uses forceColorScheme for light/dark.

Use case

Move repeated content through a viewport.

Native props used by this example

These props are extracted from the local typechecked JSX and grouped by their owning native component. This is not an exhaustive prop list; see pinned source signatures and inheritance below.

Component propExplanation
Marquee.wMantine width style prop.

Interaction and state checks

Current scenarios: Default. Check actual behavior after selecting supported disabled/error/read-only scenarios; components without those native states do not receive invented universal props. Verify keyboard focus and exits, then connect changed values through the native callback signature.

Business integration boundary

Demo content/state is local, without server persistence, authorization or fetching. A static display component is not a completed business workflow.

Host setup

Install pinned @mantine/core and @mantine/hooks, import @mantine/core/styles.css at the entry and use MantineProvider. The example's theme/variant are JGuang-authored host props, not universal native component APIs; forceColorScheme synchronizes the app theme. Native implementation source is a reading reference: use npm exports rather than copying internal engines. This batch covers Core, not dates/charts/forms extension packages. Detailed upstream prose remains English.

Runnable usage

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


function ComponentPreview({ variant = 'Default' }: { variant?: string }) {
const content = <M.Text>Build something beautiful / 构建美好的界面</M.Text>;
return <M.Marquee w={300}>{content}</M.Marquee>;
}
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>;
}

Preview states

Default

The example uses the native Mantine API. For supported input demos, change the local variant to Disabled, Invalid or Read only; these are example labels, not new component props. Keep the documented data, controlled values, stores and compound children when adapting the example.

Usage

Marquee component creates a continuous scrolling animation for its children. It is commonly used for displaying logos, testimonials, or any repeating content.

Pause on hover

Set pauseOnHover prop to pause the animation when the user hovers over the component:

Vertical orientation

Set orientation="vertical" to scroll content vertically. Note that you need to set a fixed height on the container for vertical scrolling:

Multiple rows

You can combine multiple Marquee components with different directions to create more complex layouts:

Fade edges

By default, Marquee displays gradient fade on edges to create a smooth transition effect. You can customize the fade using the following props:

  • fadeEdges – enables/disables fade gradient (default: true)
  • fadeEdgeColor – color of the fade gradient (default: var(--mantine-color-body))
  • fadeEdgeSize – size of the fade area (default: 5%)

Customization

Use the following props to customize the marquee behavior:

  • reverse – reverses animation direction
  • repeat – number of times children are repeated (default: 4)
  • duration – animation duration in ms (default: 100000)
  • gap – gap between repeated children, key of theme.spacing or any valid CSS value

Source-backed parameter reference

Implementation signatures and types are generated from the pinned local source. Optional props, native inherited types, union branches and never exclusions are preserved. A forwardRef implementation's ref is a React reference, not an additional business prop.

Marquee(_props)

export type MarqueeStylesNames = 'root' | 'content' | 'group';

export type MarqueeCssVariables = {
  root:
    | '--marquee-duration'
    | '--marquee-gap'
    | '--marquee-repeat'
    | '--marquee-fade-color'
    | '--marquee-fade-size';
};

export interface MarqueeProps
  extends BoxProps, StylesApiProps<MarqueeFactory>, ElementProps<'div'> {
  /** Reverses animation direction @default false */
  reverse?: boolean;

  /** Pauses animation on hover @default false */
  pauseOnHover?: boolean;

  /** Content to scroll */
  children: React.ReactNode;

  /** Scroll orientation @default 'horizontal' */
  orientation?: 'horizontal' | 'vertical';

  /** Number of times children are repeated inline for seamless scrolling @default 4 */
  repeat?: number;

  /** Animation duration in ms @default 100000 */
  duration?: number;

  /** Gap between repeated children, key of `theme.spacing` or any valid CSS value @default 'md' */
  gap?: MantineSpacing;

  /** Whether to show gradient fade on edges, @default true */
  fadeEdges?: boolean;

  /** Color of the fade gradient, @default 'var(--mantine-color-body)' */
  fadeEdgeColor?: string;

  /** Size of the fade gradient, @default '5%' */
  fadeEdgeSize?: string;
}

export type MarqueeFactory = Factory<{
  props: MarqueeProps;
  ref: HTMLDivElement;
  stylesNames: MarqueeStylesNames;
  vars: MarqueeCssVariables;
}>;

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>[];

Native and external types

External types remain defined by React or native dependencies, not manually expanded into guessed props. The installed version's TypeScript definitions are authoritative.

Factory<{
  props: MarqueeProps;
  ref: HTMLDivElement;
  stylesNames: MarqueeStylesNames;
  vars: MarqueeCssVariables;
}>
MantineStyleProps
React.CSSProperties
MantineTheme
Partial<Record<Variable, string>>
Record<Variable, string>
Variable
MantineBreakpoint
Record<string, any>
StylesApiProps<MarqueeFactory>
React.ElementType
Omit<React.ComponentProps<ElementType>, 'style' | PropsToOmit>
React.ComponentProps<ElementType>
ElementType
PropsToOmit
React.ReactNode
MantineSpacing
HTMLDivElement