@tmptech/ui
v1.1.9
Published
TmpTech UI Component Library for React on Frappe Framework
Maintainers
Readme
TmpTech UI
A modern React UI component library built for the Frappe Framework, inspired by frappe-ui and based on frappe-ui-react.
Features
- 📦 50+ React Components - Comprehensive UI component library
- 🎨 TailwindCSS Powered - Utility-first CSS styling
- 📖 Storybook Documentation - Interactive component documentation
- 🔧 TypeScript Support - Full type safety and IDE support
- 🚀 Vite Build System - Fast and optimized builds
- 🎯 Frappe Framework Ready - Built specifically for Frappe integration
Installation
npm install @tmptech/ui
# or
yarn add @tmptech/ui
# or
pnpm add @tmptech/uiQuick Start
import { Button, Card, Input } from '@tmptech/ui';
import '@tmptech/ui/css';
export default function App() {
return (
<Card>
<Input label="Name" placeholder="Enter your name" />
<Button variant="primary">Submit</Button>
</Card>
);
}Available Components
Form Components
Input- Text input fieldSelect- Dropdown selectTextarea- Multi-line text inputCheckbox- Checkbox controlSwitch- Toggle switchDatePicker- Date selectionFileUploader- File upload
Display Components
Button- Action buttonCard- Container componentBadge- Status badgeAlert- Alert messageAvatar- User avatarBreadcrumbs- Navigation breadcrumbsDivider- Divider lineTypography- Text components
Interactive Components
Dropdown- Dropdown menuModal- Modal dialogDialog- Dialog boxTooltip- Tooltip popoverPopover- Popover componentTabs- Tab navigationToast- Toast notification
Feedback Components
Spinner- Loading spinnerProgress- Progress barToast- Toast notifications
Development
Setup
npm installDevelopment Server
npm run devStorybook
npm run storybookBuild
npm run buildType Check
npm run type-checkLint
npm run lintProject Structure
tmptech-ui/
├── src/
│ ├── components/ # React components
│ ├── icons/ # Icon components
│ ├── utils/ # Utility functions
│ ├── @types/ # TypeScript type definitions
│ ├── style.css # Global styles
│ └── index.ts # Main export file
├── .storybook/ # Storybook configuration
├── public/ # Static assets
├── vite.config.ts # Vite configuration
├── tailwind.config.js # TailwindCSS configuration
└── package.jsonIntegration with Frappe
To use tmptech-ui in your Frappe application:
- Install the package in your Frappe app:
npm install @tmptech/ui- Import the library and styles in your main React component:
import { Button, Card } from '@tmptech/ui';
import '@tmptech/ui/css';- Use components in your Frappe DocType forms or pages.
Contributing
See CONTRIBUTING.md for guidelines on how to contribute.
License
MIT
Support
For issues and feature requests, please open an issue on GitHub.
