@partnerplatform/prism
v0.0.10
Published
A React UI component library based on Shadcn UI, tailored for the Partner Platform.
Readme
@partnerplatform/prism
A React UI component library based on Shadcn UI, tailored for the Partner Platform.
Installation
npm install @partnerplatform/prismYou also need to install the peer dependencies if you haven't already:
npm install react react-dom next next-themesUsage
1. Import Styles
Import the CSS file in your root layout (e.g., app/layout.tsx or pages/_app.tsx):
import "@partnerplatform/prism/build/theme/styles.css";2. Use Components
Import components directly from the package:
import { Button, Card } from "@partnerplatform/prism";
export default function MyPage() {
return (
<Card>
<Button>Click me</Button>
</Card>
);
}Dependencies & Versioning
Required Dependencies
The following dependencies are Peer Dependencies, meaning the consuming application is responsible for providing them. This prevents version conflicts (e.g., multiple React instances).
reactreact-domnextnext-themes
All other internal UI dependencies (like @radix-ui/*, date-fns, etc.) are bundled with the library or automatically installed, so you don't need to worry about them.
Staying Updated
To ensure you are always on the latest version, you can define your dependency version with a ^ caret in your package.json:
"@partnerplatform/prism": "^0.0.1"Then run npm update @partnerplatform/prism regularly to pull the latest non-breaking changes.
