JGuang
中

EmptyState

EmptyState · Mantine Core

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

EmptyState

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

Explain an empty result and next action.

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.

This minimal example passes children only; no additional props are invented. Optional props are in the source reference.

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 }) {

return <M.EmptyState><M.EmptyState.Title>No results / 没有结果</M.EmptyState.Title><M.EmptyState.Description>Try another search</M.EmptyState.Description></M.EmptyState>;
}
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

EmptyState displays a placeholder for "no data" situations: empty search results, empty tables and lists, first-run states or error illustrations with an optional call to action. The simplest way to use it is with icon, title and description props:

Compound components

For full control over the content, use compound components instead of or together with the shorthand props:

When both are used, the content from icon, title and description props is rendered first, followed by children:

import { Button, EmptyState } from '@mantine/core';

function Demo() {
  return (
    <EmptyState icon={<Icon />} title="No results found">
      {/* Rendered after the title */}
      <EmptyState.Actions>
        <Button variant="default">Reset filters</Button>
      </EmptyState.Actions>
    </EmptyState>
  );
}

Variant

Set the variant prop to filled or light to display the icon inside a colored circular indicator. Use the color prop to change the indicator color. If variant is not set, the icon is displayed with a dimmed color:

Indicator background

Set withIndicatorBackground prop to display a neutral circular background behind the indicator without setting a variant:

Title heading level

By default, EmptyState.Title renders a div element. Set the order prop to render it as an h1–h6 heading:

import { EmptyState } from '@mantine/core';

function Demo() {
  return (
    <EmptyState>
      <EmptyState.Title order={2}>No results found</EmptyState.Title>
    </EmptyState>
  );
}

Accessibility

  • The root element does not have a landmark role
  • EmptyState.Title is not a heading by default, set the order prop to change that
  • Make sure that action buttons have accessible labels

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.

EmptyState(_props)

export type EmptyStateStylesNames =
  | 'root'
  | 'body'
  | EmptyStateIndicatorStylesNames
  | EmptyStateTitleStylesNames
  | EmptyStateDescriptionStylesNames
  | EmptyStateActionsStylesNames;

export type EmptyStateVariant = 'filled' | 'light';

export type EmptyStateCssVariables = {
  root:
    | '--empty-state-indicator-size'
    | '--empty-state-gap'
    | '--empty-state-title-fz'
    | '--empty-state-description-fz'
    | '--empty-state-indicator-bg'
    | '--empty-state-indicator-color';
};

export interface EmptyStateProps
  extends BoxProps, StylesApiProps<EmptyStateFactory>, ElementProps<'div', 'title'> {
  /** Controls indicator size, gap between elements and font sizes of title and description @default 'md' */
  size?: MantineSize;

  /** Content alignment. `center` stacks the content in a centered column, `left`/`right` place the indicator on the side with the content next to it @default 'center' */
  align?: 'left' | 'center' | 'right';

  /** Controls the indicator appearance. `filled` and `light` display a colored circular background behind the icon. If not set, the icon is displayed with dimmed color */
  variant?: EmptyStateVariant;

  /** Key of `theme.colors` or any valid CSS color, used by `filled` and `light` variants @default theme.primaryColor */
  color?: MantineColor;

  /** Title content, rendered inside `EmptyState.Title` */
  title?: React.ReactNode;

  /** Description content, rendered inside `EmptyState.Description` */
  description?: React.ReactNode;

  /** Icon or illustration, rendered inside `EmptyState.Indicator` */
  icon?: React.ReactNode;

  /** If set, a neutral circular background is displayed behind the indicator. Setting `variant` always displays a colored background regardless of this prop @default false */
  withIndicatorBackground?: boolean;

  /** `EmptyState` compound components, rendered after the shorthand props content */
  children?: React.ReactNode;
}

export type EmptyStateFactory = Factory<{
  props: EmptyStateProps;
  ref: HTMLDivElement;
  stylesNames: EmptyStateStylesNames;
  vars: EmptyStateCssVariables;
  variant: EmptyStateVariant;
  staticComponents: {
    Indicator: typeof EmptyStateIndicator;
    Title: typeof EmptyStateTitle;
    Description: typeof EmptyStateDescription;
    Actions: typeof EmptyStateActions;
  };
}>;

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: EmptyStateProps;
  ref: HTMLDivElement;
  stylesNames: EmptyStateStylesNames;
  vars: EmptyStateCssVariables;
  variant: EmptyStateVariant;
  staticComponents: {
    Indicator: typeof EmptyStateIndicator;
    Title: typeof EmptyStateTitle;
    Description: typeof EmptyStateDescription;
    Actions: typeof EmptyStateActions;
  };
}>
MantineStyleProps
React.CSSProperties
MantineTheme
Partial<Record<Variable, string>>
Record<Variable, string>
Variable
MantineBreakpoint
Record<string, any>
StylesApiProps<EmptyStateFactory>
React.ElementType
Omit<React.ComponentProps<ElementType>, 'style' | PropsToOmit>
React.ComponentProps<ElementType>
ElementType
PropsToOmit
MantineSize
MantineColor
React.ReactNode
HTMLDivElement
EmptyStateIndicatorStylesNames
EmptyStateTitleStylesNames
EmptyStateDescriptionStylesNames
EmptyStateActionsStylesNames