React.cloneElement的使用詳解

因為要接手維護一些項目,團隊的技術棧最近從 vue 轉向 react ,作為一個 react 新手,加上一向喜歡通過源碼來學習新的東西,就選擇瞭通過閱讀 antd 這個大名鼎鼎的項目源碼來學習一些 react 的用法。

在閱讀源碼的過程中,發現好些組件都使用瞭 React.cloneElement 這個 api ,雖然通過名字可以猜測它做瞭什麼,但是並不知道具體的作用;然後去看官方文檔,文檔很清晰地描述瞭它的作用,卻沒有告訴我們什麼場景下需要使用它。於是我根據文檔的描述,結合源碼的使用,面向 google 和 stackoverflow,總結出來一些使用場景。

cloneElement 的作用

React.cloneElement(
 element,
 [props],
 [...children]
)

首先看一下官方文檔對這個 API 的描述:

Clone and return a new React element using element as the starting point. The resulting element will have the original element’s props with the new props merged in shallowly. New children will replace existing children. key and ref from the original element will be preserved.

總結下來就是:

  1. 克隆原來的元素,返回一個新的 React 元素;
  2. 保留原始元素的 props,同時可以添加新的 props,兩者進行淺合並;
  3. key 和 ref 會被保留,因為它們本身也是 props ,所以也可以修改;
  4. 根據 react 的源碼,我們可以從第三個參數開始定義任意多的子元素,如果定義瞭新的 children ,會替換原來的 children ;

使用場景

根據上面的定義分解,我們可以在不同的場景下根據需要來使用這個 api 。

添加新的 props

當我們創建一個通用組件時,根據內部的邏輯,想要給每個子元素添加不同的類名,這個時候我們可以修改它的 className

假設我們有一個 Timeline 組件,允許我們根據需要定義多個 TimelineItem ,在內部我們想要給最後一個TimelineItem 添加一個 timeline-item-last 類來渲染特殊的效果,這個時候我們可以這樣做:

const MyTimeline = () => {
 return (
  <Timeline>
   <TimelineItem>2020-06-01</TimelineItem>
   <TimelineItem>2020-06-08</TimelineItem>
   <TimelineItem>2020-07-05</TimelineItem>
  </Timeline>
 )
}

// 在 Timeline 內部,邏輯可能是這樣的
import class from 'classnames';
const Timeline = props => {
 // ...
 // ...
 const itemCount = React.children.count(props.children);
 const items = React.children.map(props.children, (item, index) => {
  return React.cloneElement(item, {
   className: class([
    item.props.className,
    'timeline-item',
    index === count - 1 ? 'timeline-item-last' : ''
   ])
  })
 }
 return <div className={'timeline'}>{ items }</div>
}

除瞭添加 className ,還可以動態給子組件添加更多的 props 信息,react-router Switch 會給匹配的子組件添加 locationcomputedMatch 信息:

class Switch extends React.Component {
 render() {
  return (
   <RouterContext.Consumer>
    {context => {
     invariant(context, "You should not use <Switch> outside a <Router>");

     const location = this.props.location || context.location;

     let element, match;

     // We use React.Children.forEach instead of React.Children.toArray().find()
     // here because toArray adds keys to all child elements and we do not want
     // to trigger an unmount/remount for two <Route>s that render the same
     // component at different URLs.
     React.Children.forEach(this.props.children, child => {
      if (match == null && React.isValidElement(child)) {
       element = child;

       const path = child.props.path || child.props.from;

       match = path
        ? matchPath(location.pathname, { ...child.props, path })
        : context.match;
      }
     });

     return match
      ? React.cloneElement(element, { location, computedMatch: match })
      : null;
    }}
   </RouterContext.Consumer>
  );
 }
}

修改 props 的事件

假設我們有一個 Tab 組件,它下面包含多個 TabPane 子組件,我們想要點擊每個 TabPane 子組件的同時觸發 Tab 的 onClick 事件,用戶自己本身可能給每個 TabPane 定義瞭獨立的 onClick 事件,這時候我們就要修改子組件 onClick 事件:

const Tab = props => {
 const { onClick } = props;
 const tabPanes = React.children.map(props.children, (tabPane, index) => {
  const paneClick = () => {
   onClick && onClick(index);
   tabPane.props?.onClick();
  }
  return React.cloneElement(tabPane, {
    onClick: paneClick,
  })
 })
 return <div>{ tabPanes }</div>
}

定制樣式

創建一個叫 FollowMouse 組件時,我們允許用戶定義內容組件 Content ,當鼠標移動時,根據內容的大小,自動計算 Content 的位置避免溢出屏幕,這個時候我們就可以使用 cloneElement 來動態修改它的樣式。

// 簡單起見,這裡省略鼠標事件。
const FollowMouse = props => {
 const { Content } = props;
 const customContent = React.isValidElement ? Content : <span>{ Content }</span>
 const getOffset = () => {
  return {
   position: 'absolute',
   top: ...,
   left: ...,
  }
 }
 const renderContent = React.cloneElement(custonContent, {
  style: {
   ...getOffset()
  }
 })
 return <div>{ renderContent() }</div>
}

添加 key

當我們創建一個元素列表時,可以通過 cloneElement 給每個節點添加一個 key 。

const ComponentButton = props => {
 const { addonAfter, children } = props;
 const button = <button key='button'>{ children }</button>
 const list = [button, addonAfter ? React.cloneElement(addonAfter, { key: 'button-addon' } : null)
 return <div>{ list } <div>
}

總結

在開發復雜組件中,經常會根據需要給子組件添加不同的功能或者顯示效果,react 元素本身是不可變的 (immutable) 對象, props.children 事實上並不是 children 本身,它隻是 children 的描述符 (descriptor) ,我們不能修改任何它的任何屬性,隻能讀到其中的內容,因此 React.cloneElement 允許我們拷貝它的元素,並且修改或者添加新的 props 從而達到我們的目的。

當然,得益於 react 強大的組合模式,這並不僅僅局限於 props.children ,不管是 props.left 還是 props.right 或者任何其它的 props 傳進來的內容,隻要是合法的 react 元素,我們都可以使用這個 React.cloneElement 對其進行操作。

以上就是React.cloneElement的使用詳解的詳細內容,更多關於React.cloneElement的使用的資料請關註WalkonNet其它相關文章!