Help and known limitations
Resolve setup issues and understand the kit's current boundaries.
Unstyled components
Confirm that the global kit CSS is imported once, Tailwind CSS 4 is configured, and Tailwind scans both the installed source and your application files. Preserve component-specific CSS imports. Load Inter, the kit’s typeface, unless you set another one as Typeface describes.
Imports or installation fail
Verify that @/* resolves to src/* in both TypeScript and the bundler. Check that the @siteplane registry URL in components.json is reachable and open the failing item URL in a browser. Install the component plus the modules imported by the example; Field is installed through Input. Import Siteplane UI parts from the installed @/siteplane/… modules, not from a package.
A control behaves unexpectedly
Read the page’s controlled-state, form, and value-type notes. Check that the required parent/child parts are present. Do not mix controlled and uncontrolled values, infer serialization from visual labels, or assume similarly named controls have identical callbacks.
For overlays, verify an accessible title, focus return, CSS scope, and provider placement. Sidebar’s desktop cookie persistence uses Cookie Store where available and document.cookie otherwise; its provider does not automatically read the cookie back. Rename the cookie or turn it off with SidebarProvider’s stateCookie.
Known limitations
- The catalog contains the 88 components and required support source.
- The stable API is what these docs describe. Other exports of the installed files are internal; see Stability and deprecations.
- Patterns are part of Siteplane UI Pro. Their pages show live previews; their source is not part of the public catalog or registry.
- Examples use local data and state. They do not provide authentication, authorization, backend persistence, or production error handling for your service.
- In right-to-left layouts, Bar List mirrors its rows, while the other charts and the toasts keep their left-to-right layout: chart axes run from left to right, and toasts stay in the corner that ToastProvider’s
positionnames. - Built-in texts are English by default, and most take a prop for another language, such as
incompleteLabelon the date and time fields,labelson Code Block, Color Picker and the charts, anddismissLabelon ToastProvider. The Calendar’s “Choose month and year” button and its group of shortcuts have no prop yet. The source is in your project, so you can change these texts there. - Agent guidance is not tested against specific agent hosts or models. Review agent output like any other code change.
Reporting an issue
Contact ui@siteplane.io for support or to report an issue.
Include the component name, exact example/file, registry origin, browser, viewport, theme, reproduction steps, and expected versus actual result. Remove secrets and private data from code and screenshots. Reduce the issue to a standalone example before sharing it with the maintainer.