Skip to main content

Module: components/router

Namespaces

Functions

router

router(props): ReactElement<any, string | JSXElementConstructor<any>>

info

This component is used to navigate through the application.

Usage

In order to use router you need to import this components first:

import {SCRoutingContextType, useSCRouting, Link, SCRoutes} from '@selfcommunity/react-core';
Usage Example:
const scRoutingContext: SCRoutingContextType = useSCRouting();
<Button component={Link} to={scRoutingContext.url(SCRoutes.USER_PROFILE_ROUTE_NAME, {id: user.id})>Go to profile</Button>

or

const scRoutingContext: SCRoutingContextType = useSCRouting();
<Link to={scRoutingContext.url('profile', {id: user.id})}>Go to profile</Link>

Parameters

NameType
propsPick<{ children: any }, string | number> & RefAttributes<unknown>

Returns

ReactElement<any, string | JSXElementConstructor<any>>

Defined in

node_modules/@types/react/index.d.ts:350