Skip to main content

addRouter(routerFn)

Sets a router function that pages can use to update the page's URL without triggering a reload. To learn more about using addRouter, see our section about adding a router for SPAs.

Example

// React-Router v6 example
import { useNavigate } from "react-router-dom";

const MyComponent = () => {
let navigate = useNavigate();

React.useEffect(() => {
const routerFunc = (newUrl) => navigate(newUrl);
window.CommandBar.addRouter(routerFunc);
}, []);
};

Method parameters

routerFn Required

function

The router function. It should accept the following arguments:

PropertyTypeDescription
url RequiredstringThe url to navigate to