emekaorji / pathpunk

A react component based router with most of the functionalities of an SPA router

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Pathpunk

npm package Downloads Issues Code Coverage

My awesome module Note: This does not replace conventional react routers. Use this when you want a fairly small nagigation system on the same page

Install

npm install pathpunk

Usage

import Pathpunk from 'pathpunk';

const App = () => {
  return (
    <MiniRouter
      name="hobbies"
      routes={[
        { path: '/', component: <HobbiesComponent /> },
        { path: '/hobbies', component: <HobbiesComponent /> },
        {
          path: '/hobbies/[hobbyName]',
          component: <SingleHobbyComponent />,
        },
        {
          path: '/hobbies/:hobbyName',
          component: <SingleHobbyComponent />,
        },
      ]}
    />
  );
};

API

MiniRouter(props: MiniRouterProps): JSX.Element

props

Type: MiniRouterProps

Lorem ipsum.

name

Type: string

routes

Type: Array

Lorem ipsum.

About

A react component based router with most of the functionalities of an SPA router

License:MIT License


Languages

Language:TypeScript 100.0%