Add Routing to a UI5 Web Components Project

In src create a Detail.jsx file.

Inside of that file, create the Detail component that will return a title to your linking.

import React from "react";
import { Title } from "@ui5/webcomponents-react/lib/Title";

export function Detail() {
  return <Title>Hello World!</Title>;
}

1. Install react-router-dom.

   React Router is a collection of navigational components that compose declaratively with your application.

   Execute the following line in the terminal in your root location of the project.

   npm install react-router-dom --save
   

2. Import HashRouter in src/App.js.

   import { HashRouter } from "react-router-dom";
   

   And wrap your root component inside of it:

   <HashRouter>
     <ThemeProvider withToastContainer>
       <MyApp />
     </ThemeProvider>
   </HashRouter>
   

   You can replace your div with the HashRouter as the HashRouter also functions as container.

1. In src, create a new Home.jsx file.

   For now only create a Home component that returns null.

   import React from "react";
   
   export function Home() {
     return null;
   }
   

2. Refactor MyApp.jsx.

   Some refactoring is necessary now. Extract every component and the corresponding logic except for the ShellBar from MyApp.jsx and move it to Home.jsx.

   MyApp.jsx should now look like this:

   import React from "react";
   import { ShellBar, ShellBarItem } from "@ui5/webcomponents-react";
   import "@ui5/webcomponents-icons/dist/icons/add.js";
   
   export function MyApp() {
     return (
       <div>
         <ShellBar
           logo={"reactLogo.png"}
           profile={"profilePictureExample.png"}
           primaryTitle={"My App"}
         >
           <ShellBarItem icon="add" text="Add" />
         </ShellBar>
       </div>
     );
   }
   

   And Home.jsx like this:

   import React, { useState } from "react";
   import {
     Card,
     Text,
     List,
     StandardListItem,
     ValueState,
     ProgressIndicator,
     Title,
     TitleLevel,
     FlexBox,
     FlexBoxJustifyContent,
     FlexBoxWrap,
     FlexBoxDirection,
     AnalyticalTable,
     Icon
   } from "@ui5/webcomponents-react";
   import { spacing } from "@ui5/webcomponents-react-base";
   import { BarChart, LineChart } from "@ui5/webcomponents-react-charts";
   import "@ui5/webcomponents-icons/dist/icons/horizontal-bar-chart.js";
   import "@ui5/webcomponents-icons/dist/icons/line-chart.js";
   import "@ui5/webcomponents-icons/dist/icons/list.js";
   import "@ui5/webcomponents-icons/dist/icons/table-view.js";
   
   export function Home() {
     const [toggleCharts, setToggleCharts] = useState("lineChart");
     const [loading, setLoading] = useState(false);
   
     const handleHeaderClick = () => {
       if (toggleCharts === "lineChart") {
         setLoading(true);
         setTimeout(() => {
           setLoading(false);
           setToggleCharts("barChart");
         }, 2000);
       } else {
         setLoading(true);
         setTimeout(() => {
           setLoading(false);
           setToggleCharts("lineChart");
         }, 2000);
       }
     };
     const datasets = [
       {
         label: "Stock Price",
         data: [65, 59, 80, 81, 56, 55, 40]
       }
     ];
     const labels = [
       "January",
       "February",
       "March",
       "April",
       "May",
       "June",
       "July"
     ];
     const tableData = new Array(500).fill(null).map((_, index) => {
       return {
         name: `name${index}`,
         age: Math.floor(Math.random() * 100),
         friend: {
           name: `friend.Name${index}`,
           age: Math.floor(Math.random() * 100)
         }
       };
     });
   
     const tableColumns = [
       {
         Header: "Name",
         accessor: "name" // String-based value accessors!
       },
       {
         Header: "Age",
         accessor: "age"
       },
       {
         Header: "Friend Name",
         accessor: "friend.name"
       },
       {
         Header: "Friend Age",
         accessor: "friend.age"
       }
     ];
     const contentTitle =
       toggleCharts === "lineChart" ? "Line Chart" : "Bar Chart";
     const switchToChart =
       toggleCharts === "lineChart" ? "Bar Chart" : "Line Chart";
     return (
       <FlexBox
         justifyContent={FlexBoxJustifyContent.Center}
         wrap={FlexBoxWrap.Wrap}
       >
         <Card
           avatar={
             <Icon
               name={
                 toggleCharts === "lineChart"
                   ? "line-chart"
                   : "horizontal-bar-chart"
               }
             />
           }
           heading="Stock Price"
           headerInteractive
           onHeaderClick={handleHeaderClick}
           subtitle={`Click here to switch to ${switchToChart}`}
           style={{ width: "300px", ...spacing.sapUiContentPadding }}
         >
           <Text style={spacing.sapUiContentPadding}>{contentTitle}</Text>
           {toggleCharts === "lineChart" ? (
             <LineChart datasets={datasets} labels={labels} loading={loading} />
           ) : (
             <BarChart datasets={datasets} labels={labels} loading={loading} />
           )}
         </Card>
         <Card
           heading="Progress"
           subtitle="List"
           style={{ width: "300px", ...spacing.sapUiContentPadding }}
           avatar={<Icon name="list" />}
         >
           <List>
             <StandardListItem info="finished" infoState={ValueState.Success}>
               Activity 1
             </StandardListItem>
             <StandardListItem info="failed" infoState={ValueState.Error}>
               Activity 2
             </StandardListItem>
             <StandardListItem
               info="in progress"
               infoState={ValueState.Warning}
               style={{ height: "80px" }}
             >
               <FlexBox direction={FlexBoxDirection.Column}>
                 <Title level={TitleLevel.H5}>Activity 3</Title>
                 <ProgressIndicator
                   displayValue="89%"
                   percentValue={89}
                   width="180px"
                   state={ValueState.Success}
                 />
               </FlexBox>
             </StandardListItem>
             <StandardListItem
               info="in progress"
               infoState={ValueState.Warning}
               style={{ height: "80px" }}
             >
               <FlexBox direction={FlexBoxDirection.Column}>
                 <Title level={TitleLevel.H5}>Activity 4</Title>
                 <ProgressIndicator
                   displayValue="5%"
                   percentValue={5}
                   width="180px"
                   state={ValueState.Error}
                 />
               </FlexBox>
             </StandardListItem>
           </List>
         </Card>
         <Card
           heading="AnalyticalTable"
           style={{ maxWidth: "900px", ...spacing.sapUiContentPadding }}
           avatar={<Icon name="table-view" />}
         >
           <AnalyticalTable
             data={tableData}
             columns={tableColumns}
             visibleRows={5}
           />
         </Card>
       </FlexBox>
     );
   }
   

1. In MyApp.jsx, import Switch, Route and Redirect from react-router-dom and the Home and Detail components.

   import { Switch, Route, Redirect } from "react-router-dom";
   import { Home } from "./Home";
   import { Detail } from "./Detail";
   

2. Wrap your ShellBar component inside of Fragments and set up paths with Switch and the component displayed respectively.

   return (
       <>
           <ShellBar
               logo={"reactLogo.png"}
               profile={"profilePictureExample.png"}
               primaryTitle={"My App"}>
               <ShellBarItem src="sap-icon://add" text="Add" />
           </ShellBar>
           <Switch>
               <Route path="/home" component={Home} />
               <Route path="/detail" component={Detail} />
               <Redirect from="/" to="/home" />
           </Switch>
       </>
   );
   

The Redirect component will redirect the user if the URL doesn’t match any given paths.

Your current URL now displays the #/home path. If you replace home with detail, you will be routed to the detail page.

Except for changing the URL of the App the user doesn’t have options to navigate to the Detail page. The page could contain some more information about activities and should therefore be connected to the Progress Card.

1. Go into your Home component and add headerInteractive and onHeaderClick={handleProgressHeaderClick} to your second Card component.

   <Card
     heading="Progress"
     subtitle="List"
     style={{ width: "300px", ...spacing.sapUiContentPadding }}
     headerInteractive
     onHeaderClick={handleProgressHeaderClick} >
   

2. Define the handleProgressHeaderClick function as follows. And import the useHistory hook from react-router-dom.

   import { useHistory } from "react-router-dom";
   

   const history = useHistory();
   const handleProgressHeaderClick = () => {
     history.push("/detail");
   };
   

   Now it is possible to navigate to the Details component, but right now, there is no way to go back except for the back button of the browser and typing in the URL manually.

3. Navigate back to the Home Screen

   Normally when you click on the Logo of the app, it should send you back to your Home screen. Let’s implement that.

   Go into your MyApp.jsx file where your ShellBar is located and add an onLogoClick prop. The function is almost the same as for the onHeaderClick, but this time the destination should be the default page.

   const history = useHistory();
   const handleLogoClick = () => {
     history.push("./");
   };
   

   <ShellBar
     logo={"reactLogo.png"}
     onLogoClick={handleLogoClick}
     profile={"profilePictureExample.png"}
     primaryTitle={"My App"}
   >
   

If needed, you can compare your files with the following solutions:

MyApp.jsx:

import React from "react";
import { ShellBar, ShellBarItem } from "@ui5/webcomponents-react";
import "@ui5/webcomponents-icons/dist/icons/add.js";
import { Switch, Route, Redirect } from "react-router-dom";
import { Home } from "./Home";
import { Detail } from "./Detail";
import { useHistory } from "react-router-dom";

export function MyApp() {
  const history = useHistory();
  const handleLogoClick = () => {
    history.push("./");
  };
  return (
    <>
      <ShellBar
        logo={"reactLogo.png"}
        onLogoClick={handleLogoClick}
        profile={"profilePictureExample.png"}
        primaryTitle={"My App"}
      >
        <ShellBarItem icon="add" text="Add" />
      </ShellBar>
      <Switch>
        <Route path="/home" component={Home} />
        <Route path="/detail" component={Detail} />
        <Redirect from="/" to="/home" />
      </Switch>
    </>
  );
}

Home.jsx:

import React, { useState } from "react";
import {
  Card,
  Text,
  List,
  StandardListItem,
  ValueState,
  ProgressIndicator,
  Title,
  TitleLevel,
  FlexBox,
  FlexBoxJustifyContent,
  FlexBoxWrap,
  FlexBoxDirection,
  AnalyticalTable,
  Icon
} from "@ui5/webcomponents-react";
import { spacing } from "@ui5/webcomponents-react-base";
import { BarChart, LineChart } from "@ui5/webcomponents-react-charts";
import "@ui5/webcomponents-icons/dist/icons/horizontal-bar-chart.js";
import "@ui5/webcomponents-icons/dist/icons/line-chart.js";
import "@ui5/webcomponents-icons/dist/icons/list.js";
import "@ui5/webcomponents-icons/dist/icons/table-view.js";
import { useHistory } from "react-router-dom";

export function Home() {
  const [toggleCharts, setToggleCharts] = useState("lineChart");
  const [loading, setLoading] = useState(false);

  const handleHeaderClick = () => {
    if (toggleCharts === "lineChart") {
      setLoading(true);
      setTimeout(() => {
        setLoading(false);
        setToggleCharts("barChart");
      }, 2000);
    } else {
      setLoading(true);
      setTimeout(() => {
        setLoading(false);
        setToggleCharts("lineChart");
      }, 2000);
    }
  };
  const history = useHistory();
  const handleProgressHeaderClick = () => {
    history.push("/detail");
  };
  const datasets = [
    {
      label: "Stock Price",
      data: [65, 59, 80, 81, 56, 55, 40]
    }
  ];
  const labels = [
    "January",
    "February",
    "March",
    "April",
    "May",
    "June",
    "July"
  ];
  const tableData = new Array(500).fill(null).map((_, index) => {
    return {
      name: `name${index}`,
      age: Math.floor(Math.random() * 100),
      friend: {
        name: `friend.Name${index}`,
        age: Math.floor(Math.random() * 100)
      }
    };
  });

  const tableColumns = [
    {
      Header: "Name",
      accessor: "name" // String-based value accessors!
    },
    {
      Header: "Age",
      accessor: "age"
    },
    {
      Header: "Friend Name",
      accessor: "friend.name"
    },
    {
      Header: "Friend Age",
      accessor: "friend.age"
    }
  ];
  const contentTitle =
    toggleCharts === "lineChart" ? "Line Chart" : "Bar Chart";
  const switchToChart =
    toggleCharts === "lineChart" ? "Bar Chart" : "Line Chart";
  return (
    <FlexBox
      justifyContent={FlexBoxJustifyContent.Center}
      wrap={FlexBoxWrap.Wrap}
    >
      <Card
        avatar={
          <Icon
            name={
              toggleCharts === "lineChart"
                ? "line-chart"
                : "horizontal-bar-chart"
            }
          />
        }
        heading="Stock Price"
        headerInteractive
        onHeaderClick={handleHeaderClick}
        subtitle={`Click here to switch to ${switchToChart}`}
        style={{ width: "300px", ...spacing.sapUiContentPadding }}
      >
        <Text style={spacing.sapUiContentPadding}>{contentTitle}</Text>
        {toggleCharts === "lineChart" ? (
          <LineChart datasets={datasets} labels={labels} loading={loading} />
        ) : (
          <BarChart datasets={datasets} labels={labels} loading={loading} />
        )}
      </Card>
      <Card
        heading="Progress"
        subtitle="List"
        style={{ width: "300px", ...spacing.sapUiContentPadding }}
        headerInteractive
        onHeaderClick={handleProgressHeaderClick}
        avatar={<Icon name="list" />}
      >
        <List>
          <StandardListItem info="finished" infoState={ValueState.Success}>
            Activity 1
          </StandardListItem>
          <StandardListItem info="failed" infoState={ValueState.Error}>
            Activity 2
          </StandardListItem>
          <StandardListItem
            info="in progress"
            infoState={ValueState.Warning}
            style={{ height: "80px" }}
          >
            <FlexBox direction={FlexBoxDirection.Column}>
              <Title level={TitleLevel.H5}>Activity 3</Title>
              <ProgressIndicator
                displayValue="89%"
                percentValue={89}
                width="180px"
                state={ValueState.Success}
              />
            </FlexBox>
          </StandardListItem>
          <StandardListItem
            info="in progress"
            infoState={ValueState.Warning}
            style={{ height: "80px" }}
          >
            <FlexBox direction={FlexBoxDirection.Column}>
              <Title level={TitleLevel.H5}>Activity 4</Title>
              <ProgressIndicator
                displayValue="5%"
                percentValue={5}
                width="180px"
                state={ValueState.Error}
              />
            </FlexBox>
          </StandardListItem>
        </List>
      </Card>
      <Card
        heading="AnalyticalTable"
        style={{ maxWidth: "900px", ...spacing.sapUiContentPadding }}
        avatar={<Icon name="table-view" />}
      >
        <AnalyticalTable
          data={tableData}
          columns={tableColumns}
          visibleRows={5}
        />
      </Card>
    </FlexBox>
  );
}