0.1.1 • Published 2 years ago

remix-inspector v0.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Remix Inspector

This is a tool to help you inspect a Remix (Remix.run) routes data.

Installation

npm install remix-inspector

Usage

The Remix Inspector should be used in the root route and placed just below the Outlet tag and is to be used only in development:

import { RemixInspector } from "remix-inspector";

// ...root.{tsx|jsx} file
<body>
  {/* ...other tags */}
  <Outlet />
  {process.env.NODE_ENV == "development" && <RemixInspector />}
  {/* ...remaining body tags */}
</body>
//  ...end of root.{tsx|jsx} file

API Reference

Remix Inspector prop (options) descriptions:

NameDefaultDescription
draggabletrueWether the Remix Inspector toggle button should be draggable around the page.
positiontop-rightThe position of the Remix Inspector toggle button. Possible options are: top-left, top-right, bottom-right, bottom-left
defaultOpenfalseWether the Remix Inspector console should be open by default.

Example:

<RemixInspector draggable={false} position={"bottom-left"} defaultOpen={false}/>

More options coming along...

Author

This project was concieved and originally created by @sergiodxa.