Documentation
Package map
Choose the right package before reading detailed guides.
| Package | Status | Use it for |
|---|---|---|
@plumile/router | Recommended for external use | Typed React routing, route resources, navigation, query/filter integration, instrumentation. |
@plumile/filter-query | Recommended for external use | Schema-driven parsing and serialization of URL filters and query state. |
@plumile/eslint-config-typescript | Recommended for external use | Reusing Plumile’s TypeScript, React, and Relay lint presets. |
@plumile/ui | Specialized public package | Plumile visual primitives, theme foundations, layouts, and admin-oriented components. |
@plumile/backoffice-core | Specialized public package | Backoffice manifests, builders, detail-page normalization, resolvers, and URL state helpers. |
@plumile/backoffice-react | Specialized public package | React provider, auth flows, Relay helpers, and backoffice routing/page scaffolds. |
@plumile/ui-devtools | Specialized public package | Shared visual primitives for DevTools panels and extensions. |
@plumile/router-devtools-extension | Private / work in progress | Chrome DevTools extension for inspecting router events during local development. |
Use package entry points and documented subpaths only. Do not import from another package’s private src/ internals unless that subpath is part of the package contract.