Skip to main content

Function: link()

link(component, name, params): string

Defined in: packages/react-page-renderer/src/componentHelpers.ts:68

Generates an absolute URL using the provided route name (see the app/config/routes.js file). The provided parameters will replace the placeholders in the route pattern, while the extraneous parameters will be appended to the generated URL's query string.

Parameters​

component​

The component requiring the generating of the URL.

AbstractComponent<unknown, unknown, unknown> | AbstractPureComponent<unknown, unknown, unknown>

name​

string

The route name.

params​

Router parameters and extraneous parameters to add to the URL as a query string.

Returns​

string

The generated URL.