Material UI 框架中的 Accordion 组件详解

person  smartzeng    watch_later 2024-10-04 10:57:40
visibility 452    class Accordion     bookmark 专栏

在构建复杂的用户界面时，组织内容以提升用户体验是至关重要的。Accordion 组件是 Material UI 提供的一种用于折叠和展开内容的组件，允许用户按需查看和隐藏内容。通过 Accordion 组件，开发者可以创建一个层次化、可扩展的 UI 元素，让界面显得更为简洁和直观。

本文将详细介绍 Material UI 中 Accordion 组件的使用，包括其各个属性、方法，并通过结合其他组件展示不同的使用场景。我们会通过详细的示例代码，帮助你熟悉 Accordion 的多种用法。

1. 什么是 Accordion？

Accordion 组件是一种用于折叠和展开的容器组件。它通常用于列表或表单，能有效地节省页面空间，按需展示隐藏内容。当用户点击标题时，Accordion 会展开以显示更多信息，再次点击时会收起内容。

常见的应用场景：

  • FAQ（常见问题解答）页面
  • 分类列表
  • 内容分块展示

2. 安装 Material UI

在开始之前，确保已经安装好 Material UI 库：

npm install @mui/material @emotion/react @emotion/styled

3. 基本用法

Material UI 中的 Accordion 组件由几个核心子组件组成：

  • Accordion: 外层容器，包含所有内容。
  • AccordionSummary: 显示在 Accordion 折叠状态下的标题部分。
  • AccordionDetails: 显示在 Accordion 展开时的内容部分。

示例：基本的 Accordion 使用

import React from 'react';
import Accordion from '@mui/material/Accordion';
import AccordionSummary from '@mui/material/AccordionSummary';
import AccordionDetails from '@mui/material/AccordionDetails';
import Typography from '@mui/material/Typography';
import ExpandMoreIcon from '@mui/icons-material/ExpandMore';

function SimpleAccordion() {
  return (
    <div>
      <Accordion>
        <AccordionSummary
          expandIcon={<ExpandMoreIcon />}
          aria-controls="panel1a-content"
          id="panel1a-header"
        >
          <Typography>Accordion 1</Typography>
        </AccordionSummary>
        <AccordionDetails>
          <Typography>
            这是第一个 Accordion 的详细内容。你可以根据需要折叠或展开它。
          </Typography>
        </AccordionDetails>
      </Accordion>
      <Accordion>
        <AccordionSummary
          expandIcon={<ExpandMoreIcon />}
          aria-controls="panel2a-content"
          id="panel2a-header"
        >
          <Typography>Accordion 2</Typography>
        </AccordionSummary>
        <AccordionDetails>
          <Typography>
            这是第二个 Accordion 的详细内容。
          </Typography>
        </AccordionDetails>
      </Accordion>
    </div>
  );
}

export default SimpleAccordion;

示例解析：

  • Accordion: 组件的整体容器。
  • AccordionSummary: 标题部分，用户点击时展开或折叠内容。
  • AccordionDetails: 显示详细内容的部分。
  • expandIcon: 用于显示或隐藏内容的图标（在此示例中为向下箭头图标 ExpandMoreIcon）。

4. 受控和非受控模式

Accordion 组件可以是受控组件（controlled），也可以是非受控组件（uncontrolled）。在非受控模式下，Accordion 的展开和折叠状态是由组件自身维护的。而在受控模式下，展开和折叠的状态是通过外部状态来控制的。

示例：受控模式下的 Accordion

import React, { useState } from 'react';
import Accordion from '@mui/material/Accordion';
import AccordionSummary from '@mui/material/AccordionSummary';
import AccordionDetails from '@mui/material/AccordionDetails';
import Typography from '@mui/material/Typography';
import ExpandMoreIcon from '@mui/icons-material/ExpandMore';

function ControlledAccordion() {
  const [expanded, setExpanded] = useState(false);

  const handleChange = (panel) => (event, isExpanded) => {
    setExpanded(isExpanded ? panel : false);
  };

  return (
    <div>
      <Accordion expanded={expanded === 'panel1'} onChange={handleChange('panel1')}>
        <AccordionSummary
          expandIcon={<ExpandMoreIcon />}
          aria-controls="panel1a-content"
          id="panel1a-header"
        >
          <Typography>Accordion 1</Typography>
        </AccordionSummary>
        <AccordionDetails>
          <Typography>
            这是第一个 Accordion 的内容。
          </Typography>
        </AccordionDetails>
      </Accordion>
      <Accordion expanded={expanded === 'panel2'} onChange={handleChange('panel2')}>
        <AccordionSummary
          expandIcon={<ExpandMoreIcon />}
          aria-controls="panel2a-content"
          id="panel2a-header"
        >
          <Typography>Accordion 2</Typography>
        </AccordionSummary>
        <AccordionDetails>
          <Typography>
            这是第二个 Accordion 的内容。
          </Typography>
        </AccordionDetails>
      </Accordion>
    </div>
  );
}

export default ControlledAccordion;

示例解析：

  • expanded: 设置当前展开的 Accordion，通过外部状态 expanded 控制。
  • onChange: 当用户点击时，通过 handleChange 来修改 expanded 的状态。
  • handleChange: 通过条件判断设置 Accordion 是否展开。

5. 默认展开

Accordion 允许在页面加载时默认展开特定的内容。只需要设置 defaultExpanded 属性。

示例：默认展开的 Accordion

import React from 'react';
import Accordion from '@mui/material/Accordion';
import AccordionSummary from '@mui/material/AccordionSummary';
import AccordionDetails from '@mui/material/AccordionDetails';
import Typography from '@mui/material/Typography';
import ExpandMoreIcon from '@mui/icons-material/ExpandMore';

function DefaultExpandedAccordion() {
  return (
    <div>
      <Accordion defaultExpanded>
        <AccordionSummary
          expandIcon={<ExpandMoreIcon />}
          aria-controls="panel1a-content"
          id="panel1a-header"
        >
          <Typography>默认展开的 Accordion</Typography>
        </AccordionSummary>
        <AccordionDetails>
          <Typography>
            该 Accordion 在页面加载时默认展开。
          </Typography>
        </AccordionDetails>
      </Accordion>
    </div>
  );
}

export default DefaultExpandedAccordion;

示例解析：

  • defaultExpanded: 设置 Accordion 在初始加载时展开。

6. 禁用 Accordion

有时候，某些 Accordion 项目可能处于不可用状态。Material UI 允许通过 disabled 属性禁用整个 Accordion，使用户无法与其交互。

示例：禁用的 Accordion

import React from 'react';
import Accordion from '@mui/material/Accordion';
import AccordionSummary from '@mui/material/AccordionSummary';
import AccordionDetails from '@mui/material/AccordionDetails';
import Typography from '@mui/material/Typography';
import ExpandMoreIcon from '@mui/icons-material/ExpandMore';

function DisabledAccordion() {
  return (
    <div>
      <Accordion disabled>
        <AccordionSummary
          expandIcon={<ExpandMoreIcon />}
          aria-controls="panel1a-content"
          id="panel1a-header"
        >
          <Typography>禁用的 Accordion</Typography>
        </AccordionSummary>
        <AccordionDetails>
          <Typography>
            这个 Accordion 被禁用了，无法展开或折叠。
          </Typography>
        </AccordionDetails>
      </Accordion>
    </div>
  );
}

export default DisabledAccordion;

示例解析：

  • disabled: 设置 Accordion 为禁用状态，用户无法点击展开或折叠。

7. 动画效果

Accordion 支持折叠和展开时的动画效果，这些效果默认情况下已经内置在 Material UI 中，无需额外配置。然而，开发者可以通过使用 TransitionComponent 自定义折叠和展开的动画效果。

示例：自定义动画的 Accordion

import React from 'react';
import Accordion from '@mui/material/Accordion';
import AccordionSummary from '@mui/material/AccordionSummary';
import AccordionDetails from '@mui/material/AccordionDetails';
import Typography from '@mui/material/Typography';
import ExpandMoreIcon from '@mui/icons-material/ExpandMore';
import Slide from '@mui/material/Slide';

function CustomAnimationAccordion() {
  return (
    <div>
      <Accordion TransitionComponent={Slide}>
        <AccordionSummary
          expandIcon={<ExpandMoreIcon />}
          aria-controls="panel1a-content"
          id="panel1a-header"
        >
          <Typography>自定义动画的 Accordion</Typography>
        </AccordionSummary>
        <AccordionDetails>
          <Typography>
            这个 Accordion 使用 Slide 动画进行折叠和展开。
          </Typography>
        </AccordionDetails>
      </Accordion>
    </div>
  );
}

export default CustomAnimationAccordion;

示例解析：

  • TransitionComponent: 用于自定义展开和折叠时的动画效果。在此示例中，我们使用 Slide 组件实现了滑动动画。

8. 结合其他组件使用

Accordion 组件经常与其他 Material UI 组件一起使用，比如 Typography、Icon、List、Table 等，以便创建更为复杂和有趣的 UI 组件。

示例：结合 List 组件的 Accordion

import React from 'react';
import Accordion from '@mui/material/Accordion';
import AccordionSummary from '@mui/material/AccordionSummary';
import AccordionDetails from '@mui/material/AccordionDetails';
import Typography from '@mui/material/Typography';
import List from '@mui/material/List';
import ListItem from '@mui/material/ListItem';
import ListItemText from '@mui/material/ListItemText';
import ExpandMoreIcon from '@mui/icons-material/ExpandMore';

function ListAccordion() {
  return (
    <div>
      <Accordion>
        <AccordionSummary
          expandIcon={<ExpandMoreIcon />}
          aria-controls="panel1a-content"
          id="panel1a-header"
        >
          <Typography>展开查看列表</Typography>
        </AccordionSummary>
        <AccordionDetails>
          <List>
            <ListItem>
              <ListItemText primary="列表项 1" />
            </ListItem>
            <ListItem>
              <ListItemText primary="列表项 2" />
            </ListItem>
            <ListItem>
              <ListItemText primary="列表项 3" />
            </ListItem>
          </List>
        </AccordionDetails>
      </Accordion>
    </div>
  );
}

export default ListAccordion;

示例解析：

  • 通过在 AccordionDetails 中嵌套 List 组件，我们可以在 Accordion 展开时显示一个动态的列表。

9. 总结

Material UI 的 Accordion 组件为用户界面提供了一种灵活、可扩展的方式来组织和展示内容。通过组合不同的属性和子组件，开发者可以创建出美观、响应式的 UI 元素。

在本篇博客中，我们深入探讨了 Accordion 的基本用法、受控与非受控模式、默认展开和禁用状态、动画效果及与其他组件的结合使用。希望这些示例代码能帮助你在自己的项目中更好地使用 Material UI 的 Accordion 组件，为用户提供更好的交互体验。

chat评论区
评论列表
作者信息

像向日葵一样向着太阳

热门专栏

Vue Material 框架中的 Dialog 组件使用详解

在网页中使用 Materialize 实现中文日期选择器

MaterializeCSS轮播组件：构建动态网页内容的利器

在网页中使用 Materialize 实现日期选择器

使用 Materialize 实现图文列表布局

使用 Materialize 实现响应式布局

深入了解 Material UI 的 MobileDateRangePicker API 使用

Material UI 框架中 MobileDatePicker API 的全面使用指南

深入解析 Material UI 的 `LocalizationProvider API` 使用指南

深入解析 Material UI 的 `DesktopDateRangePicker API` 使用指南

menu