Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md

@simple-module-py/ui

shadcn-derived React UI components and layouts for simple_module apps. Buttons, Cards, Forms, Dialogs, sidebar Layouts — the toolbox every module page pulls from.

Install

npm install @simple-module-py/ui

Peer-depends on React 19, React DOM 19, and @inertiajs/react 2. Assumes Tailwind CSS 4 is configured in the consuming app.

What it provides

  • shadcn primitives under @simple-module-py/ui/components/ui/*: Button, Input, Label, Textarea, Select, Switch, Checkbox, Card, Dialog, Sheet, Popover, Tooltip, Form (react-hook-form bindings), and many more.
  • Framework components under @simple-module-py/ui/components/* (also re-exported from the package root): PageShell, SectionTitle, StatCard, FilterPills, NavIcon, ErrorBoundary, ErrorScreen.
  • Layouts under @simple-module-py/ui/layouts/* (also re-exported from the root): AppLayout, SidebarLayout, AuthenticatedLayout, AdminLayout, PublicLayout, AuthCardShell (centred form).

All components ship as .ts / .tsx source (no bundling step) — any modern bundler (Vite, Next, etc.) handles them transparently.

Usage

import { Button } from "@simple-module-py/ui/components/ui/button";
import { Card, CardHeader, CardContent, CardTitle } from "@simple-module-py/ui/components/ui/card";

export default function ProductCard({ product }) {
  return (
    <Card>
      <CardHeader>
        <CardTitle>{product.name}</CardTitle>
      </CardHeader>
      <CardContent>
        <Button onClick={...}>Add to cart</Button>
      </CardContent>
    </Card>
  );
}

Owning the source (shadcn-style)

If you want to edit a component's source directly:

cp -r node_modules/@simple-module-py/ui/src packages/ui-local
# add to your tsconfig paths and package.json, then import from @/ui-local

At that point you've forked the library — npm update will no longer bring changes in.

Depends on

  • @simple-module-py/i18n, plus Radix/radix-ui, lucide-react, recharts, sonner, class-variance-authority, clsx, tailwind-merge, and other shadcn runtime deps.
  • Peer: react ^19.0.0, react-dom ^19.0.0, @inertiajs/react ^2.0.0

License

MIT — see LICENSE.