React手写一个手风琴组件示例

知识点

结构分析

AccordionItem子组件

Accordion容器组件

知识点

emotion语法

react语法

css语法

typescript类型语法

结构分析

根据上图，我们来分析一下，一个手风琴组件应该包含一个手风琴容器组件和多个手风琴子元素组件。因此，假设我们实现好了所有的逻辑，并写出使用demo，那么代码应该如下:

<Accordion defaultIndex="1" onItemClick={console.log}>
   <AccordionItem label="A" index="1">
     Lorem ipsum
   </AccordionItem>
   <AccordionItem label="B" index="2">
      Dolor sit amet
   </AccordionItem>
</Accordion>

根据以上的结构，我们可以得知，首先容器组件Accordion会暴露一个defaultIndex属性以及一个onItemClick事件。顾名思义，defaultIndex代表默认展开的子元素组件AccordionItem的索引，onItemClick代表点击每一个子元素组件所触发的事件。然后，我们可以看到子元素组件有label属性和index属性，很显然，label代表当前子元素的标题，index代表当前子元素组件的索引值，而我们的Lorem ipsum就是子元素的内容。根据这些分析，我们先来实现一下AccordionItem组件。

AccordionItem子组件

首先我们定义好子组件的结构，函数组件写法如下:

const AccordionItem = (props) =&gt; {
   //返回元素
};

子元素组件分成三个部分，一个容器元素，一个标题元素和一个内容元素，因此我们可以将结构写成如下:

<div className="according-item-container">
   <div className="according-item-header"></div>
   <div className="according-item-content"></div>
</div>

知道了结构之后，我们就知道props会有哪些属性，首先是索引index属性，它的类型为string 或者number，然后是判断内容是否展开的属性isCollapsed,它的类型是布尔值，其次我们还有渲染标题的属性label，它应该是一个react节点，类型为ReactNode，同理，还有一个内容属性即children,类型也应该是ReactNode,最后就是我们要暴露的事件方法handleClick,它的类型应该是一个方法，因此我们可以定义如下的接口:

interface AccordionItemType {
  index: string | number;
  label: string;
  isCollapsed: boolean;
  //SyntheticEvent代表react合成事件对象的类型
  handleClick(e: SyntheticEvent): void;
  children: ReactNode;
}

接口定义好之后，接下来我们就在接口里面拿值(采用对象解构的方式),这些值都算是可选的，即:

const { label, isCollapsed, handleClick, children } = props;

此时我们的AccordionItem子组件应该是如下:

const AccordionItem = (props: Partial<AccordionItemType>) => {
  const { label, isCollapsed, handleClick, children } = props;
  return (
    <div className={AccordionItemContainer} onClick={handleClick}>
      <div className={AccordionItemHeader}>{label}</div>
      <div
        aria-expanded={isCollapsed}
        className={`${AccordionItemContent}${
          isCollapsed ? ' collapsed' : ' expanded'
        }`}
      >
        {children}
      </div>
    </div>
  );
};

这里我们可以使用emotion/css来写css类名样式，代码如下:

const baseStyle = css`
  line-height: 1.5715;
`;
const AccordionItemContainer = css`
  border-bottom: 1px solid #d9d9d9;
`;
const AccordionItemHeader = cx(
  baseStyle,
  css`
    position: relative;
    display: flex;
    flex-wrap: nowrap;
    align-items: flex-start;
    padding: 12px 16px;
    color: rgba(0, 0, 0, 0.85);
    cursor: pointer;
    transition: all 0.3s, visibility 0s;
    box-sizing: border-box;
  `,
);
const AccordionItemContent = css`
  color: #000000d9;
  background-color: #fff;
  border-top: 1px solid #d9d9d9;
  transition: all 0.3s ease-in-out;
  padding: 16px;
  &.collapsed {
    display: none;
  }
  &.expanded {
    display: block;
  }
`;

以上的css后面跟模板字符串再跟css样式就是emotion/css语法，cx也就是组合样式写法，样式都是常规的写法，也没什么好说的。这里有一个难点，那就是display:none和display:block没有过渡效果，因此可以采用visibility:hidden和opacity:0的方式来替换，但是这里为了简单，没考虑动画效果，所以也就将问题放着，后面有时间再优化。

到目前为止，这个子组件就算是完成了，这也就意味着我们的手风琴组件已经完成一半了，接下来我们来看容器组件Accordion的写法。

Accordion容器组件

首先我们先把结构写好:

const Accordion = (props) =&gt; {
  //后续代码
};

我们再来分析一下需要传给Accordion组件的属性有哪些，很显然有defaultIndex,onItemClick和children，因此我们可以定义如下的接口:

interface AccordionType {
  defaultIndex: number | string;
  onItemClick(key: number | string): void;
  children: JSX.Element[];
}

注意这里的children不应该是ReactNode，而是JSX.Element元素数组，这是为什么呢，我们后面再来解释这个问题。现在我们知道了props的属性之后，我们可以拿到这些属性，代码如下:

const Accordion = (props:Partial<AccordionType>) => {
  const { defaultIndex, onItemClick, children } = props;
  //后续代码
};

现在我们再维护一个状态，用来代表当前显示的子元素组件的索引，使用useState hook函数，初始化默认值就应该是defaultIndex。如下:

const Accordion = (props:Partial&lt;AccordionType&gt;) =&gt; {
  const { defaultIndex, onItemClick, children } = props;
  //新增的代码
  const [bindIndex, setBindIndex] = useState(defaultIndex);
  //后续代码
};

接下来，我们编写好容器元素，并写好样式，如下所示:

const Accordion = (props: Partial<AccordionType>) => {
  const { defaultIndex, onItemClick, children } = props;
  const [bindIndex, setBindIndex] = useState(defaultIndex);
  return (
    <div className={AccordionContainer}></div>
  );
};

容器元素的样式如下:

const baseStyle = css`
  line-height: 1.5715;
`;
const AccordionContainer = cx(
  baseStyle,
  css`
    box-sizing: border-box;
    margin: 0;
    padding: 0;
    color: #000000d9;
    font-size: 14px;
    background-color: #fafafa;
    border: 1px solid #d9d9d9;
    border-bottom: 0;
    border-radius: 2px;
  `,
);

好的，接下来，我们实际上容器元素的子元素应该是多个AccordionItem元素，也正因为如此，这里的children类型就是JSX.Element []，我们应该如何获取这些子元素呢？我们应该知道，每一个子元素对应的就是一个节点，在react中用的是链表来表示这些节点，每个节点对应的就有个type属性，我们只需要拿到容器元素的子组件元素中type属性为AccordionItem的元素数组，如下:

//name不是AccordionItem,代表子元素不是AccordionItem，不是的我们需要过滤掉
const items = children?.filter(
    (item) => item?.type?.name === 'AccordionItem,代表子元素不是AccordionItem，所以我们需要过滤掉',
 );

到了这里，我们就知道了，容器元素的子元素是一个数组，我们就需要遍历，使用map方法，如下:

items?.map(({ props: { index, label, children } }) => (
  <AccordionItem
     key={index}
     label={label}
     children={children}
     isCollapsed={bindIndex !== index}
     handleClick={() => changeItem(index)}
  />
))

请注意这一段代码:

handleClick={() => changeItem(index)}

这就是我们之前子组件绑定的事件，也是我们需要暴露出去的事件，在这个事件方法中，我们无非执行的就是更改当前被展开元素的索引。所以代码就很好写了:

const changeItem = (index: number | string) => {
   //暴露点击事件方法接口
   if (typeof onItemClick === 'function') {
     onItemClick(index);
   }
   //设置索引
   if (index !== bindIndex) {
     setBindIndex(index);
   }
};

到了这里，我们的一个手风琴组件就完成了，完整代码如下:

import { cx, css } from '@emotion/css';
import React, { useState } from 'react';
import type { ReactNode, SyntheticEvent } from 'react';
const baseStyle = css`
  line-height: 1.5715;
`;
const AccordionContainer = cx(
  baseStyle,
  css`
    box-sizing: border-box;
    margin: 0;
    padding: 0;
    color: #000000d9;
    font-size: 14px;
    background-color: #fafafa;
    border: 1px solid #d9d9d9;
    border-bottom: 0;
    border-radius: 2px;
  `,
);
const AccordionItemContainer = css`
  border-bottom: 1px solid #d9d9d9;
`;
const AccordionItemHeader = cx(
  baseStyle,
  css`
    position: relative;
    display: flex;
    flex-wrap: nowrap;
    align-items: flex-start;
    padding: 12px 16px;
    color: rgba(0, 0, 0, 0.85);
    cursor: pointer;
    transition: all 0.3s, visibility 0s;
    box-sizing: border-box;
  `,
);
const AccordionItemContent = css`
  color: #000000d9;
  background-color: #fff;
  border-top: 1px solid #d9d9d9;
  transition: all 0.3s ease-in-out;
  padding: 16px;
  &.collapsed {
    display: none;
  }
  &.expanded {
    display: block;
  }
`;
interface AccordionItemType {
  index: string | number;
  label: string;
  isCollapsed: boolean;
  handleClick(e: SyntheticEvent): void;
  children: ReactNode;
}
interface AccordionType {
  defaultIndex: number | string;
  onItemClick(key: number | string): void;
  children: JSX.Element[];
}
const AccordionItem = (props: Partial<AccordionItemType>) => {
  const { label, isCollapsed, handleClick, children } = props;
  return (
    <div className={AccordionItemContainer} onClick={handleClick}>
      <div className={AccordionItemHeader}>{label}</div>
      <div
        aria-expanded={isCollapsed}
        className={`${AccordionItemContent}${
          isCollapsed ? ' collapsed' : ' expanded'
        }`}
      >
        {children}
      </div>
    </div>
  );
};
const Accordion = (props: Partial<AccordionType>) => {
  const { defaultIndex, onItemClick, children } = props;
  const [bindIndex, setBindIndex] = useState(defaultIndex);
  const changeItem = (index: number | string) => {
    if (typeof onItemClick === 'function') {
      onItemClick(index);
    }
    if (index !== bindIndex) {
      setBindIndex(index);
    }
  };
  const items = children?.filter(
    (item) => item?.type?.name === 'AccordionItem',
  );
  return (
    <div className={AccordionContainer}>
      {items?.map(({ props: { index, label, children } }) => (
        <AccordionItem
          key={index}
          label={label}
          children={children}
          isCollapsed={bindIndex !== index}
          handleClick={() => changeItem(index)}
        />
      ))}
    </div>
  );
};

让我们来看一下效果: