@twinmatrix/ui-sdk

TwinMatrix UI SDK - Dashboard components, widgets, and UI primitives for React applications.

Installation

This SDK is used as a git dependency in TwinMatrix applications. It will be cloned during the build process.

Usage

Import Styles (Required)

The SDK includes precompiled Tailwind CSS styles. You must import the stylesheet in your app entry point:

// In your main.tsx or App.tsx (app entry point)
import '@twinmatrix/ui-sdk/styles.css';

This is the only styling requirement - no Tailwind configuration needed in your app!

Use Components

import { 
  DashboardShell, 
  DashboardSidePanel, 
  AlertsPanel,
  useAppTheme,
  setCustomTheme 
} from '@twinmatrix/ui-sdk';

function MyDashboard() {
  const theme = useAppTheme();
  
  return (
    <DashboardShell>
      <DashboardSidePanel side="right" isOpen={true} title="Alerts">
        <AlertsPanel items={alertItems} />
      </DashboardSidePanel>
    </DashboardShell>
  );
}

Development

# Install dependencies
npm install

# Build the SDK
npm run build

Documentation

See THEME_CUSTOMIZATION.md for theme customization guide.

License

MIT