ellucian-developer / react-router

A safe react-router wrapper for use in Ellucian Experience Extensions.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

react-router

A safe react-router wrapper for use in Ellucian Experience Extensions. Used as a dependency in react-router-dom.

If you are already using react-router-dom in your Extension, you do not need to include this package.

Check out @ellucian/react-router-dom for more details.

The following components have been modified to take experience history context into account

Differences

Router

Changes have been made to the Router components to always assume history based on the Ellucian Experience Router. This history is stored in context and shared among the other child components

Additionally, a debug prop has been added which can help debug history changes and location during development. debug is a boolean which defaults to false.

Switch

Grabs new history from context, and uses this as a base for all child Route components.

Route

Adds the appropriate URL prefix based on history context. The prop path should remain unchanged from it's standard usage.

Redirect

Adds the appropriate URL prefix redirect paths based on history context. The prop to should remain unchanged from it's standard usage.

Contribute

If there's a bug please open an issue report through GitHub's interface.

Pull Requests are welcomed.

About

A safe react-router wrapper for use in Ellucian Experience Extensions.


Languages

Language:JavaScript 100.0%