packages/mui-material/src/StepButton/StepButton.js - master - githubmirror/material-ui

packages/mui-material/src/StepButton/StepButton.js
168 строк5 KB
Silviu Alexandru Avram
[step button] Choose higher contrast ripple color for dark mode focus (#48612)
03 июн 2026, 14:41
03 июн 2026, 14:41b5eb884
'use client';
import * as React from 'react';
import PropTypes from 'prop-types';
import clsx from 'clsx';
import composeClasses from '@mui/utils/composeClasses';
import { styled } from '../zero-styled';
import memoTheme from '../utils/memoTheme';
import { useDefaultProps } from '../DefaultPropsProvider';
import ButtonBase from '../ButtonBase';
import StepLabel from '../StepLabel';
import isMuiElement from '../utils/isMuiElement';
import { useRovingTabIndexItem } from '../utils/useRovingTabIndex';
import { useStepperContext } from '../Stepper/StepperContext';
import StepContext from '../Step/StepContext';
import stepButtonClasses, { getStepButtonUtilityClass } from './stepButtonClasses';

const useUtilityClasses = (ownerState) => {
  const { classes, orientation } = ownerState;

  const slots = {
    root: ['root', orientation],
    touchRipple: ['touchRipple'],
  };

  return composeClasses(slots, getStepButtonUtilityClass, classes);
};

const StepButtonRoot = styled(ButtonBase, {
  name: 'MuiStepButton',
  slot: 'Root',
  overridesResolver: (props, styles) => {
    const { ownerState } = props;

    return [
      { [`& .${stepButtonClasses.touchRipple}`]: styles.touchRipple },
      styles.root,
      styles[ownerState.orientation],
    ];
  },
})(
  memoTheme(({ theme }) => ({
    width: '100%',
    padding: '24px 16px',
    margin: '-24px -16px',
    boxSizing: 'content-box',
    [`& .${stepButtonClasses.touchRipple}`]: {
      color: 'rgba(0, 0, 0, 0.3)',
      ...theme.applyStyles('dark', {
        color: 'rgba(255, 255, 255, 0.3)',
      }),
    },
    variants: [
      {
        props: { orientation: 'vertical' },
        style: {
          justifyContent: 'flex-start',
          padding: '8px',
          margin: '-8px',
        },
      },
    ],
  })),
);

const RovingStepButton = React.forwardRef(function RovingStepButton(props, ref) {
  // eslint-disable-next-line react/prop-types
  const { children, disabled, index, ...other } = props;

  const rovingItemProps = useRovingTabIndexItem({
    id: index,
    ref,
    disabled,
  });

  return (
    <StepButtonRoot disabled={disabled} {...rovingItemProps} {...other}>
      {children}
    </StepButtonRoot>
  );
});

const StepButton = React.forwardRef(function StepButton(inProps, ref) {
  const props = useDefaultProps({ props: inProps, name: 'MuiStepButton' });
  const { children, className, icon, optional, ...other } = props;

  const { disabled, active, index } = React.useContext(StepContext);
  const { orientation, totalSteps, isTabList } = useStepperContext();

  const ownerState = { ...props, orientation };

  const classes = useUtilityClasses(ownerState);

  const childProps = {
    icon,
    optional,
  };

  const child = isMuiElement(children, ['StepLabel']) ? (
    React.cloneElement(children, childProps)
  ) : (
    <StepLabel {...childProps}>{children}</StepLabel>
  );

  const stepButtonProps = {
    internalNativeButton: true,
    focusRipple: true,
    disabled,
    TouchRippleProps: { className: classes.touchRipple },
    className: clsx(classes.root, className),
    ownerState,
    'aria-selected': active,
    'aria-posinset': index + 1,
    'aria-setsize': totalSteps,
    role: 'tab',
    ...other,
  };

  if (isTabList) {
    return (
      <RovingStepButton {...stepButtonProps} index={index} ref={ref}>
        {child}
      </RovingStepButton>
    );
  }

  return (
    <StepButtonRoot ref={ref} tabIndex={active ? 0 : -1} {...stepButtonProps}>
      {child}
    </StepButtonRoot>
  );
});

StepButton.propTypes /* remove-proptypes */ = {
  // ┌────────────────────────────── Warning ──────────────────────────────┐
  // │ These PropTypes are generated from the TypeScript type definitions. │
  // │    To update them, edit the d.ts file and run `pnpm proptypes`.     │
  // └─────────────────────────────────────────────────────────────────────┘
  /**
   * Can be a `StepLabel` or a node to place inside `StepLabel` as children.
   */
  children: PropTypes.node,
  /**
   * Override or extend the styles applied to the component.
   */
  classes: PropTypes.object,
  /**
   * @ignore
   */
  className: PropTypes.string,
  /**
   * The icon displayed by the step label.
   */
  icon: PropTypes.node,
  /**
   * The optional node to display.
   */
  optional: PropTypes.node,
  /**
   * The system prop that allows defining system overrides as well as additional CSS styles.
   */
  sx: PropTypes.oneOfType([
    PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])),
    PropTypes.func,
    PropTypes.object,
  ]),
};

export default StepButton;