How vladislavkovaliov/simple-react-router works
Project type and purpose
• This is an open-source React component library (“Simple React Router”) that provides a minimal navigation solution via React Context and Hooks.
• Its purpose is to let downstream React applications declare screens, wrap them in a NavigatorProvider, and navigate between them using simple hook calls.
File structure
• Top-level files:
– package.json, tsconfig.json, vite.config.ts – TypeScript project, built with Vite, published to npm.
– src/ – your library’s source modules.
– dist/ – compiled JS output by Vite for distribution.
– types/ – handwritten or generated .d.ts definitions.
– .github/, .husky/ – CI checks and git hooks.
• src/ hierarchy:
– src/App.tsx, Home.tsx, Main.tsx – example/demo code.
– src/index.ts(x) – library entry point, re-exports hooks/providers.
– src/hooks/usePrevious.ts – internal hook to retain previous state.
– src/providers/navigator/ – core NavigatorContext, NavigatorProvider, NavigatorScreen, type definitions.
• dist/ mirrors src/ but in compiled form.
Key insights from the README
• The consumer wraps their app in <NavigatorProvider onScreenChange=… fallbackRouteName=…>
• They declare <NavigatorScreen name="…" component={…} props={…}/> for each route.
• Within components, they call goNextTo, goBack, reset from NavigatorContext via a custom hook.
Main components
a. Consumer React Application
b. NavigatorProvider
c. NavigatorContext (React.createContext)
d. NavigatorScreen registrations
e. Navigation State (screen stack)
f. Navigation Hooks: usePrevious, useContext(NavigatorContext) → goNextTo/goBack/reset
g. Build & Distribution Pipeline: Vite → dist → npm package
h. TypeScript Definitions (types/)
Relationships and interactions
• The Consumer App imports the library’s entry point (index.js) from npm.
• App renders <NavigatorProvider> which initializes Navigation State and exposes the context.
• App nests <NavigatorScreen> elements as children; Provider reads these to build the route registry.
• Provider uses usePrevious internally to track the previous screen for onScreenChange.
• When a component calls goNextTo/goBack/reset (via useContext), the Provider updates its state and re-renders the active screen component.
• onScreenChange callback is invoked with { currScreenName, prevScreenName } on each navigation event.
Architectural patterns and design principles
• Dependency Injection & Inversion of Control via React Context (Provider/Consumer)
• Hook-based encapsulation of navigation logic
• Stateless screen declarations; state managed centrally in Provider
• Single Responsibility: NavigatorProvider for state, NavigatorScreen for registration, hooks for side-effects/state tracking
Step-by-step diagramming guide
– NavigatorProvider
– NavigatorContext
– NavigatorScreen registry
– usePrevious hook
– navigation hooks (goNextTo/goBack/reset)
4. Provider supplying context to Screens.
5. Screens being rendered based on the Provider’s internal state (screen stack).
– import/consume (App → Library)
– register screens (App → NavigatorProvider)
– navigate (Screen Component → Provider via hook)
– build output (Vite → dist)