Pathfinderby Commenda
Getting started

Installation

Install Pathfinder and import its finished stylesheet once.

Workspace installation

The package is currently available in the Commenda workspace and has not been published to a registry. Add @commenda/pathfinder with the workspace:* version to a consumer's dependencies, then run pnpm install.

For another repository, build and pack it first:

SH
pnpm --dir packages/pathfinder pack --pack-destination /tmp

Install the resulting .tgz file with that repository's package manager. Once registry publishing is configured, a normal versioned dependency can replace it.

Styles

Import the stylesheet once, after your app's base styles. For Next.js Pages Router, use pages/_app.tsx; for App Router, use app/layout.tsx.

Example.tsx
import '@commenda/pathfinder/styles.css';

Consumers do not need Tailwind, Pathfinder source scanning, a PostCSS plugin, or a transpilePackages entry. Next.js still bundles the finished CSS.

Components

Example.tsx
import { Button } from '@commenda/pathfinder';

export const SaveButton = () => <Button>Save changes</Button>;

The direct @commenda/pathfinder/button import is also supported. Private source and output paths are not public APIs.

React and Next.js

React and React DOM are peer dependencies. Supported versions are React 18.3.1 and React 19. Interactive components preserve their client boundary. In App Router, place event handlers and state in a component marked 'use client'.

Use the same React version for React and React DOM. Components should not depend on application auth providers, a router, or Commenda APIs.

On this page