Timeline时间轴

垂直展示的时间流信息。

何时使用

当有一系列信息需按时间排列时，可正序和倒序。
需要有一条时间轴进行视觉上的串联时。

5.2.0版本之后，我们提供了更简单的用法 <Timeline items={[...]} /> 以获得更好的性能，使您能在应用中编写更简单的代码。与此同时，我们弃用了旧的用法，并且将在下一个 major 版本中删除它。

// >=5.2.0 可用，推荐的写法 ✅
const items = [{ children: 'sample', label: 'sample' }];
return <Timeline items={items} />;

// <5.2.0 可用，>=5.2.0 时不推荐 🙅🏻‍♀️
return (
  <Timeline onChange={onChange}>
    <Timeline.Item>Sample</Timeline.Item>
  </Timeline>
);

代码演示

Create a services site 2015-09-01
Solve initial network problems 2015-09-01
Technical testing 2015-09-01
Network problems being solved 2015-09-01

基本用法

基本的时间轴。

TypeScript
JavaScript
import React from 'react';
import { Timeline } from 'antd';

const App: React.FC = () => (
  <Timeline
    items={[
      {
        children: 'Create a services site 2015-09-01',
      },
      {
        children: 'Solve initial network problems 2015-09-01',
      },
      {
        children: 'Technical testing 2015-09-01',
      },
      {
        children: 'Network problems being solved 2015-09-01',
      },
    ]}
  />
);

export default App;

Create a services site 2015-09-01
Solve initial network problems 2015-09-01
Technical testing 2015-09-01
Recording...

最后一个及排序

当任务状态正在发生，还在记录过程中，可用幽灵节点来表示当前的时间节点，当 pending 为真值时展示幽灵节点，如果 pending 是 React 元素可用于定制该节点内容，同时 pendingDot 将可以用于定制其轴点。reverse 属性用于控制节点排序，为 false 时按正序排列，为 true 时按倒序排列。

TypeScript
JavaScript
import React, { useState } from 'react';
import { Button, Timeline } from 'antd';

const App: React.FC = () => {
  const [reverse, setReverse] = useState(false);

  const handleClick = () => {
    setReverse(!reverse);
  };

  return (
    <div>
      <Timeline
        pending="Recording..."
        reverse={reverse}
        items={[
          {
            children: 'Create a services site 2015-09-01',
          },
          {
            children: 'Solve initial network problems 2015-09-01',
          },
          {
            children: 'Technical testing 2015-09-01',
          },
        ]}
      />
      <Button type="primary" style={{ marginTop: 16 }} onClick={handleClick}>
        Toggle Reverse
      </Button>
    </div>
  );
};

export default App;

Create a services site 2015-09-01
Solve initial network problems 2015-09-01
Technical testing 2015-09-01
Network problems being solved 2015-09-01

自定义时间轴点

可以设置为图标或其他自定义元素。

TypeScript
JavaScript
import React from 'react';
import { ClockCircleOutlined } from '@ant-design/icons';
import { Timeline } from 'antd';

const App: React.FC = () => (
  <Timeline
    items={[
      {
        children: 'Create a services site 2015-09-01',
      },
      {
        children: 'Solve initial network problems 2015-09-01',
      },
      {
        dot: <ClockCircleOutlined className="timeline-clock-icon" />,
        color: 'red',
        children: 'Technical testing 2015-09-01',
      },
      {
        children: 'Network problems being solved 2015-09-01',
      },
    ]}
  />
);

export default App;
.timeline-clock-icon {
  font-size: 16px;
}

LeftRightAlternate

2015-09-01
Create a services
2015-09-01 09:12:11
Solve initial network problems
Technical testing
2015-09-01 09:12:11
Network problems being solved

标签

使用 label 标签单独展示时间。

TypeScript
JavaScript
import React, { useState } from 'react';
import type { RadioChangeEvent } from 'antd';
import { Radio, Timeline } from 'antd';

const App: React.FC = () => {
  const [mode, setMode] = useState<'left' | 'alternate' | 'right'>('left');

  const onChange = (e: RadioChangeEvent) => {
    setMode(e.target.value);
  };

  return (
    <>
      <Radio.Group
        onChange={onChange}
        value={mode}
        style={{
          marginBottom: 20,
        }}
      >
        <Radio value="left">Left</Radio>
        <Radio value="right">Right</Radio>
        <Radio value="alternate">Alternate</Radio>
      </Radio.Group>
      <Timeline
        mode={mode}
        items={[
          {
            label: '2015-09-01',
            children: 'Create a services',
          },
          {
            label: '2015-09-01 09:12:11',
            children: 'Solve initial network problems',
          },
          {
            children: 'Technical testing',
          },
          {
            label: '2015-09-01 09:12:11',
            children: 'Network problems being solved',
          },
        ]}
      />
    </>
  );
};

export default App;

Create a services site 2015-09-01
Create a services site 2015-09-01
Solve initial network problems 1
Solve initial network problems 2
Solve initial network problems 3 2015-09-01
Technical testing 1
Technical testing 2
Technical testing 3 2015-09-01
Technical testing 1
Technical testing 2
Technical testing 3 2015-09-01
Technical testing 1
Technical testing 2
Technical testing 3 2015-09-01
Custom color testing

圆圈颜色

圆圈颜色，绿色用于已完成、成功状态，红色表示告警或错误状态，蓝色可表示正在进行或其他默认状态，灰色表示未完成或失效状态。

TypeScript
JavaScript
import React from 'react';
import { SmileOutlined } from '@ant-design/icons';
import { Timeline } from 'antd';

const App: React.FC = () => (
  <Timeline
    items={[
      {
        color: 'green',
        children: 'Create a services site 2015-09-01',
      },
      {
        color: 'green',
        children: 'Create a services site 2015-09-01',
      },
      {
        color: 'red',
        children: (
          <>
            <p>Solve initial network problems 1</p>
            <p>Solve initial network problems 2</p>
            <p>Solve initial network problems 3 2015-09-01</p>
          </>
        ),
      },
      {
        children: (
          <>
            <p>Technical testing 1</p>
            <p>Technical testing 2</p>
            <p>Technical testing 3 2015-09-01</p>
          </>
        ),
      },
      {
        color: 'gray',
        children: (
          <>
            <p>Technical testing 1</p>
            <p>Technical testing 2</p>
            <p>Technical testing 3 2015-09-01</p>
          </>
        ),
      },
      {
        color: 'gray',
        children: (
          <>
            <p>Technical testing 1</p>
            <p>Technical testing 2</p>
            <p>Technical testing 3 2015-09-01</p>
          </>
        ),
      },
      {
        color: '#00CCFF',
        dot: <SmileOutlined />,
        children: <p>Custom color testing</p>,
      },
    ]}
  />
);

export default App;

Create a services site 2015-09-01
Solve initial network problems 2015-09-01
Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
Network problems being solved 2015-09-01
Create a services site 2015-09-01
Technical testing 2015-09-01

交替展现

内容在时间轴两侧轮流出现。

TypeScript
JavaScript
import React from 'react';
import { ClockCircleOutlined } from '@ant-design/icons';
import { Timeline } from 'antd';

const App: React.FC = () => (
  <Timeline
    mode="alternate"
    items={[
      {
        children: 'Create a services site 2015-09-01',
      },
      {
        children: 'Solve initial network problems 2015-09-01',
        color: 'green',
      },
      {
        dot: <ClockCircleOutlined style={{ fontSize: '16px' }} />,
        children: `Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.`,
      },
      {
        color: 'red',
        children: 'Network problems being solved 2015-09-01',
      },
      {
        children: 'Create a services site 2015-09-01',
      },
      {
        dot: <ClockCircleOutlined style={{ fontSize: '16px' }} />,
        children: 'Technical testing 2015-09-01',
      },
    ]}
  />
);

export default App;

Create a services site 2015-09-01
Solve initial network problems 2015-09-01
Technical testing 2015-09-01
Network problems being solved 2015-09-01

右侧时间轴点

时间轴点可以在内容的右边。

TypeScript
JavaScript
import React from 'react';
import { ClockCircleOutlined } from '@ant-design/icons';
import { Timeline } from 'antd';

const App: React.FC = () => (
  <Timeline
    mode="right"
    items={[
      {
        children: 'Create a services site 2015-09-01',
      },
      {
        children: 'Solve initial network problems 2015-09-01',
      },
      {
        dot: <ClockCircleOutlined style={{ fontSize: '16px' }} />,
        color: 'red',
        children: 'Technical testing 2015-09-01',
      },
      {
        children: 'Network problems being solved 2015-09-01',
      },
    ]}
  />
);

export default App;

API

Timeline

参数	说明	类型	默认值
mode	通过设置 `mode` 可以改变时间轴和内容的相对位置	`left` \| `alternate` \| `right`	-
pending	指定最后一个幽灵节点是否存在或内容	boolean \| ReactNode	false
pendingDot	当最后一个幽灵节点存在時，指定其时间图点	ReactNode	<LoadingOutlined />
reverse	节点排序	boolean	false
items	选项配置	Items[]	5.2.0

Items

时间轴的每一个节点。

参数	说明	类型	默认值
color	指定圆圈颜色 `blue`、`red`、`green`、`gray`，或自定义的色值	string	`blue`
dot	自定义时间轴点	ReactNode	-
label	设置标签	ReactNode	-
children	设置内容	ReactNode	-
position	自定义节点位置	`left` \| `right`	-

// >=5.2.0 可用，推荐的写法 ✅

const items = [{ children: 'sample', label: 'sample' }];

return <Timeline items={items} />;

// <5.2.0 可用，>=5.2.0 时不推荐 🙅🏻‍♀️

return (

<Timeline.Item>Sample</Timeline.Item>

</Timeline>

);

import React from 'react'; import { Timeline } from 'antd'; const App: React.FC = () => ( <Timeline items={[ { children: 'Create a services site 2015-09-01', }, { children: 'Solve initial network problems 2015-09-01', }, { children: 'Technical testing 2015-09-01', }, { children: 'Network problems being solved 2015-09-01', }, ]} /> ); export default App;

import React, { useState } from 'react'; import { Button, Timeline } from 'antd'; const App: React.FC = () => { const [reverse, setReverse] = useState(false); const handleClick = () => { setReverse(!reverse); }; return ( <div> <Timeline pending="Recording..." reverse={reverse} items={[ { children: 'Create a services site 2015-09-01', }, { children: 'Solve initial network problems 2015-09-01', }, { children: 'Technical testing 2015-09-01', }, ]} /> <Button type="primary" style={{ marginTop: 16 }} onClick={handleClick}> Toggle Reverse </Button> </div> ); }; export default App;

import React from 'react'; import { ClockCircleOutlined } from '@ant-design/icons'; import { Timeline } from 'antd'; const App: React.FC = () => ( <Timeline items={[ { children: 'Create a services site 2015-09-01', }, { children: 'Solve initial network problems 2015-09-01', }, { dot: <ClockCircleOutlined className="timeline-clock-icon" />, color: 'red', children: 'Technical testing 2015-09-01', }, { children: 'Network problems being solved 2015-09-01', }, ]} /> ); export default App;

import React, { useState } from 'react'; import type { RadioChangeEvent } from 'antd'; import { Radio, Timeline } from 'antd'; const App: React.FC = () => { const [mode, setMode] = useState<'left' | 'alternate' | 'right'>('left'); const onChange = (e: RadioChangeEvent) => { setMode(e.target.value); }; return ( <> <Radio.Group onChange={onChange} value={mode} style={{ marginBottom: 20, }} > <Radio value="left">Left</Radio> <Radio value="right">Right</Radio> <Radio value="alternate">Alternate</Radio> </Radio.Group> <Timeline mode={mode} items={[ { label: '2015-09-01', children: 'Create a services', }, { label: '2015-09-01 09:12:11', children: 'Solve initial network problems', }, { children: 'Technical testing', }, { label: '2015-09-01 09:12:11', children: 'Network problems being solved', }, ]} /> </> ); }; export default App;

import React from 'react'; import { SmileOutlined } from '@ant-design/icons'; import { Timeline } from 'antd'; const App: React.FC = () => ( <Timeline items={[ { color: 'green', children: 'Create a services site 2015-09-01', }, { color: 'green', children: 'Create a services site 2015-09-01', }, { color: 'red', children: ( <> Solve initial network problems 1 Solve initial network problems 2 Solve initial network problems 3 2015-09-01 </> ), }, { children: ( <> Technical testing 1 Technical testing 2 Technical testing 3 2015-09-01 </> ), }, { color: 'gray', children: ( <> Technical testing 1 Technical testing 2 Technical testing 3 2015-09-01 </> ), }, { color: 'gray', children: ( <> Technical testing 1 Technical testing 2 Technical testing 3 2015-09-01 </> ), }, { color: '#00CCFF', dot: <SmileOutlined />, children: Custom color testing, }, ]} /> ); export default App;

import React from 'react'; import { ClockCircleOutlined } from '@ant-design/icons'; import { Timeline } from 'antd'; const App: React.FC = () => ( <Timeline mode="alternate" items={[ { children: 'Create a services site 2015-09-01', }, { children: 'Solve initial network problems 2015-09-01', color: 'green', }, { dot: <ClockCircleOutlined style={{ fontSize: '16px' }} />, children: `Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.`, }, { color: 'red', children: 'Network problems being solved 2015-09-01', }, { children: 'Create a services site 2015-09-01', }, { dot: <ClockCircleOutlined style={{ fontSize: '16px' }} />, children: 'Technical testing 2015-09-01', }, ]} /> ); export default App;

import React from 'react'; import { ClockCircleOutlined } from '@ant-design/icons'; import { Timeline } from 'antd'; const App: React.FC = () => ( <Timeline mode="right" items={[ { children: 'Create a services site 2015-09-01', }, { children: 'Solve initial network problems 2015-09-01', }, { dot: <ClockCircleOutlined style={{ fontSize: '16px' }} />, color: 'red', children: 'Technical testing 2015-09-01', }, { children: 'Network problems being solved 2015-09-01', }, ]} /> ); export default App;

API

Timeline

参数	说明	类型	默认值
mode	通过设置 `mode` 可以改变时间轴和内容的相对位置	`left` \| `alternate` \| `right`	-
pending	指定最后一个幽灵节点是否存在或内容	boolean \| ReactNode	false
pendingDot	当最后一个幽灵节点存在時，指定其时间图点	ReactNode	<LoadingOutlined />
reverse	节点排序	boolean	false
items	选项配置	Items[]	5.2.0

Items

时间轴的每一个节点。

参数	说明	类型	默认值
color	指定圆圈颜色 `blue`、`red`、`green`、`gray`，或自定义的色值	string	`blue`
dot	自定义时间轴点	ReactNode	-
label	设置标签	ReactNode	-
children	设置内容	ReactNode	-
position	自定义节点位置	`left` \| `right`	-

Ant Design

Timeline时间轴

Ant Design

Timeline时间轴

何时使用

代码演示

API

Timeline

Items

何时使用

代码演示

API

Timeline

Items