Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@blumjs/router

Package Overview
Dependencies
Maintainers
1
Versions
64
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@blumjs/router

  • 1.1.0
  • npm
  • Socket score

Version published
Weekly downloads
10
decreased by-60%
Maintainers
1
Weekly downloads
 
Created
Source

Description

This library based on effector and window.history.state without changing url and hash. Created for routing vk-mini-apps. I recomend use it with @blumjs/cli.

Usage

Initialization

To Route handle prev button in browser, you should init first:

`import { useInitRouter } from '@blumjs/router';

const App = () => { useInitRouter({ view: "Main", panel: "Home", modal: null, popout: null });

... } `

To handle prev button you can use middlewares:

`import { useInitRouter, createDisableBackBrowserRouteMiddleware, createRouteMiddleware, historyPush } from '@blumjs/router';

const App = () => { useInitRouter({ view: "Main", panel: "Home", modal: null, popout: null }, //first arg is the name of route; second callback, that fired when pushed back in browser createDisableBackBrowserRouteMiddleware('Loading', (storeRoutes, prevRoutes) => console.log('loading, please wait...')), createRouteMiddleware((storeRoutes, prevRoutes) => { if(navigator.onLine){ //middleware passed return true; } historyPush({view: 'ConnectionError', panel: 'Offline', modal: null, popout: null}); return false; }) );

... } `

Routes: get

To get routes and check initialization routes:

`import { useRouter } from '@blumjs/router';

const App = () => { const { activeView, activePanel, activeModal, activePopout, isRouteInit } = useRouter();

... } `

Routes: set

To set routes you can use functions: setRoutes(set all routes), setActiveView, setActivePanel, setActiveModal, setActivePopout.

`import { setRoutes, setActiveView, setActivePanel, setActiveModal, setActivePopout } from '@blumjs/router';

//setRoutes accept partial routes setRoutes({view: 'Main', panel: 'Home'}); setRoutes({modal: 'Onboarding'}); setRoutes({panel: 'Game', popout: 'Loading'});

setActiveView('Main'); setActivePanel('Home'); setActiveModal('Notifications'); setActivePopout('Loading'); `

To get previous page use back:

`import { back } from '@blumjs/router';

back(); `

If you need turn off modal and popout in new page (for example, offline page, where user shouldn't see modal and popout) you can use _setActiveModal, _setActivePopout. In other case use back.

`import { _setActiveModal, _setActivePopout } from '@blumjs/router';

_setActiveModal(null); _setActivePopout(null); `

FAQs

Package last updated on 23 Feb 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc