React MUI TimelineConnector API

Material-UI is a UI library providing predefined robust and customizable components for React for easier web development. The MUI design is based on top of Material Design by Google. 

In this article, we will discuss the React MUI TimelineConnector API. The TimelineConnector is used to connect the TimelineItems which forms a line between the items. The API provides a lot of functionality and we are going to learn to implement them.

Import TimelineConnector API:

import TimelineConnector from '@mui/lab/TimelineConnector';
// or
import { TimelineConnector } from '@mui/lab';

Props List: Here is the list of props used with this component. We can access them and modify them according to our needs.

• children (node): It is a component similar to the table row.
• classes (object): This overrides the existing styles or adds new styles to the component.
• sx (Array<func/object/bool> func/object): The system prop allows defining system overrides as well as additional CSS styles. 

CSS Rules:

• root (.MuiTimelineConnector-root): It is the style applied to the root element.

Syntax: Create a TimelineConnecter inside TimelineItem as follows:

<TimelineItem>
      <TimelineSeparator>
        <TimelineDot color="primary" />
        <TimelineConnector />
      </TimelineSeparator>
      <TimelineContent>HTML</TimelineContent>
</TimelineItem>

Installing and Creating React app, and adding the MUI dependencies:

Step 1: Create a react project using the following command.

npx create-react-app gfg_tutorial

Step 2: Get into the project directory

cd gfg_tutorial

Step 3: Install the MUI dependencies as follows:

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

Step 4: Run the project as follows:

npm start

Example 1: In the following example, we have a timeline tree with timeline items containing the TimelineConnector component.

App.js

import "./App.css";
import Timeline from "@mui/lab/Timeline";
import TimelineItem from "@mui/lab/TimelineItem";
import TimelineSeparator from "@mui/lab/TimelineSeparator";
import TimelineConnector from "@mui/lab/TimelineConnector";
import TimelineContent from "@mui/lab/TimelineContent";
import TimelineDot from "@mui/lab/TimelineDot";
function App() {
    return (
        <div className="App">
            <div
                className="head"
                style={{
                    width: "fit-content",
                    margin: "auto",
                }}
            >
                <h1
                    style={{
                        color: "green",
                    }}
                >
                    GeeksforGeeks
                </h1>
                <strong>
                    React MUI TimelineConnector API
                </strong>
            </div>

            <Timeline>
                <TimelineItem position="left">
                    <TimelineSeparator>
                        <TimelineDot />
                        <TimelineConnector />
                    </TimelineSeparator>
                    <TimelineContent>
                        Frontend Learning Path
                    </TimelineContent>
                </TimelineItem>
                <TimelineItem>
                    <TimelineSeparator>
                        <TimelineDot />
                        <TimelineConnector />
                    </TimelineSeparator>
                    <TimelineContent>HTML</TimelineContent>
                </TimelineItem>
                <TimelineItem>
                    <TimelineSeparator>
                        <TimelineDot />
                        <TimelineConnector />
                    </TimelineSeparator>
                    <TimelineContent>CSS</TimelineContent>
                </TimelineItem>
                <TimelineItem>
                    <TimelineSeparator>
                        <TimelineDot />
                    </TimelineSeparator>
                    <TimelineContent>
                        Javascript
                    </TimelineContent>
                </TimelineItem>
            </Timeline>
        </div>
    );
}

export default App;

Output:

Example 2: In the following example, we have customized the color of the TimelineConnector using the sx field.

App.js

import "./App.css";
import Timeline from "@mui/lab/Timeline";
import TimelineItem from "@mui/lab/TimelineItem";
import TimelineSeparator from "@mui/lab/TimelineSeparator";
import TimelineConnector from "@mui/lab/TimelineConnector";
import TimelineContent from "@mui/lab/TimelineContent";
import TimelineDot from "@mui/lab/TimelineDot";
function App() {
    return (
        <div className="App">
            <div
                className="head"
                style={{
                    width: "fit-content",
                    margin: "auto",
                }}
            >
                <h1
                    style={{
                        color: "green",
                    }}
                >
                    GeeksforGeeks
                </h1>
                <strong>
                    React MUI TimelineConnector API
                </strong>
            </div>

            <Timeline>
                <TimelineItem position="left">
                    <TimelineSeparator>
                        <TimelineDot />
                        <TimelineConnector
                            sx={{
                                backgroundColor: "red",
                            }}
                        />
                    </TimelineSeparator>
                    <TimelineContent>
                        Frontend Learning Path
                    </TimelineContent>
                </TimelineItem>
                <TimelineItem>
                    <TimelineSeparator>
                        <TimelineDot />
                        <TimelineConnector
                            sx={{
                                backgroundColor: "orange",
                            }}
                        />
                    </TimelineSeparator>
                    <TimelineContent>HTML</TimelineContent>
                </TimelineItem>
                <TimelineItem>
                    <TimelineSeparator>
                        <TimelineDot />
                        <TimelineConnector
                            sx={{
                                backgroundColor: "green",
                            }}
                        />
                    </TimelineSeparator>
                    <TimelineContent>CSS</TimelineContent>
                </TimelineItem>
                <TimelineItem>
                    <TimelineSeparator>
                        <TimelineDot />
                    </TimelineSeparator>
                    <TimelineContent>
                        Javascript
                    </TimelineContent>
                </TimelineItem>
            </Timeline>
        </div>
    );
}

export default App;

Output:

Reference: https://mui.com/material-ui/api/timeline-connector/