Compare commits
1 Commits
worktree-2
...
fbfaf7bb9f
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fbfaf7bb9f |
406
FIELD_TYPES_ARCHITECTURE.md
Normal file
406
FIELD_TYPES_ARCHITECTURE.md
Normal file
@@ -0,0 +1,406 @@
|
|||||||
|
# Field Types System Architecture
|
||||||
|
|
||||||
|
## System Overview
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────────────────────────────────────────────────────┐
|
||||||
|
│ Frontend (Vue 3 + Nuxt) │
|
||||||
|
├─────────────────────────────────────────────────────────────────┤
|
||||||
|
│ │
|
||||||
|
│ ┌───────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ View Components │ │
|
||||||
|
│ ├───────────────────────────────────────────────────────────┤ │
|
||||||
|
│ │ ListView.vue │ DetailView.vue │ EditView.vue │ │
|
||||||
|
│ │ - Data Table │ - Read Display │ - Form │ │
|
||||||
|
│ │ - Search │ - Sections │ - Validation │ │
|
||||||
|
│ │ - Sort/Filter │ - Actions │ - Sections │ │
|
||||||
|
│ │ - Bulk Actions │ │ │ │
|
||||||
|
│ └────────────────────────┬──────────────────────────────────┘ │
|
||||||
|
│ │ uses │
|
||||||
|
│ ┌────────────────────────▼──────────────────────────────────┐ │
|
||||||
|
│ │ FieldRenderer.vue │ │
|
||||||
|
│ │ Universal component for rendering any field type │ │
|
||||||
|
│ │ - Handles LIST, DETAIL, EDIT modes │ │
|
||||||
|
│ │ - Type-aware rendering │ │
|
||||||
|
│ │ - Validation support │ │
|
||||||
|
│ └────────────────────────┬──────────────────────────────────┘ │
|
||||||
|
│ │ uses │
|
||||||
|
│ ┌────────────────────────▼──────────────────────────────────┐ │
|
||||||
|
│ │ shadcn-vue Components │ │
|
||||||
|
│ │ Input, Textarea, Select, Checkbox, Switch, Calendar, │ │
|
||||||
|
│ │ Table, Badge, Dialog, Popover, etc. │ │
|
||||||
|
│ └───────────────────────────────────────────────────────────┘ │
|
||||||
|
│ │
|
||||||
|
│ ┌───────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ Composables │ │
|
||||||
|
│ ├───────────────────────────────────────────────────────────┤ │
|
||||||
|
│ │ useFields() │ useViewState() │ │
|
||||||
|
│ │ - Map backend data │ - CRUD operations │ │
|
||||||
|
│ │ - Build configs │ - State management │ │
|
||||||
|
│ │ - Generate sections │ - Navigation │ │
|
||||||
|
│ └───────────────────────────────────────────────────────────┘ │
|
||||||
|
│ │
|
||||||
|
│ ┌───────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ Type Definitions │ │
|
||||||
|
│ │ field-types.ts - TypeScript interfaces for field system │ │
|
||||||
|
│ └───────────────────────────────────────────────────────────┘ │
|
||||||
|
└─────────────────────────────────────────────────────────────────┘
|
||||||
|
│
|
||||||
|
│ HTTP/REST API
|
||||||
|
▼
|
||||||
|
┌─────────────────────────────────────────────────────────────────┐
|
||||||
|
│ Backend (NestJS) │
|
||||||
|
├─────────────────────────────────────────────────────────────────┤
|
||||||
|
│ │
|
||||||
|
│ ┌───────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ Controllers │ │
|
||||||
|
│ ├───────────────────────────────────────────────────────────┤ │
|
||||||
|
│ │ SetupObjectController │ RuntimeObjectController │ │
|
||||||
|
│ │ - GET /objects │ - GET /objects/:name │ │
|
||||||
|
│ │ - GET /objects/:name │ - GET /objects/:name/:id │ │
|
||||||
|
│ │ - GET /ui-config ✨ │ - POST /objects/:name │ │
|
||||||
|
│ │ - POST /objects │ - PUT /objects/:name/:id │ │
|
||||||
|
│ └────────────────────────┬────────────────┬─────────────────┘ │
|
||||||
|
│ │ │ │
|
||||||
|
│ ┌────────────────────────▼────────────────▼─────────────────┐ │
|
||||||
|
│ │ Services │ │
|
||||||
|
│ ├───────────────────────────────────────────────────────────┤ │
|
||||||
|
│ │ ObjectService │ FieldMapperService ✨ │ │
|
||||||
|
│ │ - CRUD operations │ - Map field definitions │ │
|
||||||
|
│ │ - Query building │ - Generate UI configs │ │
|
||||||
|
│ │ - Validation │ - Default metadata │ │
|
||||||
|
│ └────────────────────────┬──────────────────────────────────┘ │
|
||||||
|
│ │ │
|
||||||
|
│ ┌────────────────────────▼──────────────────────────────────┐ │
|
||||||
|
│ │ Models │ │
|
||||||
|
│ │ ObjectDefinition │ FieldDefinition ✨ │ │
|
||||||
|
│ │ - Object metadata │ - Field metadata │ │
|
||||||
|
│ │ │ - UIMetadata interface │ │
|
||||||
|
│ └───────────────────────────────────────────────────────────┘ │
|
||||||
|
└─────────────────────────────────────────────────────────────────┘
|
||||||
|
│
|
||||||
|
│ Prisma/Knex
|
||||||
|
▼
|
||||||
|
┌─────────────────────────────────────────────────────────────────┐
|
||||||
|
│ Database (PostgreSQL) │
|
||||||
|
├─────────────────────────────────────────────────────────────────┤
|
||||||
|
│ │
|
||||||
|
│ ┌───────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ object_definitions │ │
|
||||||
|
│ │ - id, tenant_id, api_name, label, plural_label │ │
|
||||||
|
│ │ - description, is_system, table_name │ │
|
||||||
|
│ └───────────────────────────────────────────────────────────┘ │
|
||||||
|
│ │ │
|
||||||
|
│ │ 1:many │
|
||||||
|
│ ▼ │
|
||||||
|
│ ┌───────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ field_definitions │ │
|
||||||
|
│ │ - id, object_definition_id, api_name, label, type │ │
|
||||||
|
│ │ - is_required, is_unique, is_system │ │
|
||||||
|
│ │ - ui_metadata (JSONB) ✨ NEW │ │
|
||||||
|
│ │ { │ │
|
||||||
|
│ │ placeholder, helpText, showOnList, showOnDetail, │ │
|
||||||
|
│ │ showOnEdit, sortable, options, rows, min, max, │ │
|
||||||
|
│ │ validationRules, format, prefix, suffix, etc. │ │
|
||||||
|
│ │ } │ │
|
||||||
|
│ └───────────────────────────────────────────────────────────┘ │
|
||||||
|
└─────────────────────────────────────────────────────────────────┘
|
||||||
|
|
||||||
|
✨ = New/Enhanced component
|
||||||
|
```
|
||||||
|
|
||||||
|
## Data Flow
|
||||||
|
|
||||||
|
### 1. Loading Object Definition
|
||||||
|
|
||||||
|
```
|
||||||
|
┌──────────┐ GET /api/setup/objects/Contact/ui-config ┌──────────┐
|
||||||
|
│ │ ──────────────────────────────────────────────────> │ │
|
||||||
|
│ Frontend │ │ Backend │
|
||||||
|
│ │ <────────────────────────────────────────────────── │ │
|
||||||
|
└──────────┘ { objectDef with mapped fields } └──────────┘
|
||||||
|
│
|
||||||
|
│ useFields().buildListViewConfig(objectDef)
|
||||||
|
▼
|
||||||
|
┌──────────────────────────────────────┐
|
||||||
|
│ ListViewConfig │
|
||||||
|
│ - objectApiName: "Contact" │
|
||||||
|
│ - mode: "list" │
|
||||||
|
│ - fields: [ │
|
||||||
|
│ { │
|
||||||
|
│ apiName: "firstName", │
|
||||||
|
│ type: "text", │
|
||||||
|
│ showOnList: true, │
|
||||||
|
│ ... │
|
||||||
|
│ } │
|
||||||
|
│ ] │
|
||||||
|
└──────────────────────────────────────┘
|
||||||
|
│
|
||||||
|
│ Pass to ListView component
|
||||||
|
▼
|
||||||
|
┌──────────────────────────────────────┐
|
||||||
|
│ ListView renders data table │
|
||||||
|
└──────────────────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Fetching Records
|
||||||
|
|
||||||
|
```
|
||||||
|
┌──────────┐ GET /api/runtime/objects/Contact ┌──────────┐
|
||||||
|
│ │ ──────────────────────────────────────────────────> │ │
|
||||||
|
│ Frontend │ │ Backend │
|
||||||
|
│ │ <────────────────────────────────────────────────── │ │
|
||||||
|
└──────────┘ [{ id, firstName, lastName, ... }] └──────────┘
|
||||||
|
│
|
||||||
|
▼
|
||||||
|
┌──────────────────────────────────────┐
|
||||||
|
│ ListView displays records │
|
||||||
|
│ Each field rendered by │
|
||||||
|
│ FieldRenderer with mode="list" │
|
||||||
|
└──────────────────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Field Rendering
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────────────────────────────────────────────────┐
|
||||||
|
│ FieldRenderer │
|
||||||
|
│ Props: { field, modelValue, mode } │
|
||||||
|
└────────────────────────┬────────────────────────────────────┘
|
||||||
|
│
|
||||||
|
┌────────────────┼────────────────┐
|
||||||
|
│ │ │
|
||||||
|
▼ ▼ ▼
|
||||||
|
mode="list" mode="detail" mode="edit"
|
||||||
|
│ │ │
|
||||||
|
▼ ▼ ▼
|
||||||
|
Simple text Formatted Input component
|
||||||
|
or badge display with based on type:
|
||||||
|
display labels - Input
|
||||||
|
- Textarea
|
||||||
|
- Select
|
||||||
|
- DatePicker
|
||||||
|
- Checkbox
|
||||||
|
- etc.
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Saving Record
|
||||||
|
|
||||||
|
```
|
||||||
|
┌──────────┐ ┌──────────┐
|
||||||
|
│ EditView │ ──> User fills form ──> Validation │ │
|
||||||
|
│ │ │ │ │
|
||||||
|
│ │ ▼ │ │
|
||||||
|
│ │ Valid? │ │
|
||||||
|
│ │ ✓ Yes │ │
|
||||||
|
│ │ @save event │ │ │
|
||||||
|
│ │ ──────────────────────────┘ │ │
|
||||||
|
│ │ │ │
|
||||||
|
│ │ POST/PUT /api/runtime/objects/Contact/:id │ Backend │
|
||||||
|
│ Frontend │ ──────────────────────────────────────────────────> │ │
|
||||||
|
│ │ │ │
|
||||||
|
│ │ <────────────────────────────────────────────────── │ │
|
||||||
|
│ │ { saved record } │ │
|
||||||
|
│ │ │ │
|
||||||
|
│ │ ──> Navigate to DetailView │ │
|
||||||
|
└──────────┘ └──────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
## Component Hierarchy
|
||||||
|
|
||||||
|
```
|
||||||
|
Page/App
|
||||||
|
└── ObjectViewContainer
|
||||||
|
├── ListView
|
||||||
|
│ ├── Search/Filters
|
||||||
|
│ ├── Table
|
||||||
|
│ │ ├── TableHeader
|
||||||
|
│ │ │ └── Sortable columns
|
||||||
|
│ │ └── TableBody
|
||||||
|
│ │ └── TableRow (for each record)
|
||||||
|
│ │ └── TableCell (for each field)
|
||||||
|
│ │ └── FieldRenderer (mode="list")
|
||||||
|
│ └── Actions (Create, Export, etc.)
|
||||||
|
│
|
||||||
|
├── DetailView
|
||||||
|
│ ├── Header with actions
|
||||||
|
│ └── Sections
|
||||||
|
│ └── Card (for each section)
|
||||||
|
│ └── FieldRenderer (mode="detail") for each field
|
||||||
|
│
|
||||||
|
└── EditView
|
||||||
|
├── Header with Save/Cancel
|
||||||
|
└── Form
|
||||||
|
└── Sections
|
||||||
|
└── Card (for each section)
|
||||||
|
└── FieldRenderer (mode="edit") for each field
|
||||||
|
└── Input component based on field type
|
||||||
|
```
|
||||||
|
|
||||||
|
## Field Type Mapping
|
||||||
|
|
||||||
|
```
|
||||||
|
Database Type → FieldType Enum → Component (Edit Mode)
|
||||||
|
─────────────────────────────────────────────────────────
|
||||||
|
string → TEXT → Input[type="text"]
|
||||||
|
text → TEXTAREA → Textarea
|
||||||
|
email → EMAIL → Input[type="email"]
|
||||||
|
url → URL → Input[type="url"]
|
||||||
|
integer → NUMBER → Input[type="number"]
|
||||||
|
decimal → NUMBER → Input[type="number"]
|
||||||
|
currency → CURRENCY → Input[type="number"] + prefix
|
||||||
|
boolean → BOOLEAN → Checkbox
|
||||||
|
date → DATE → DatePicker
|
||||||
|
datetime → DATETIME → DatePicker (with time)
|
||||||
|
picklist → SELECT → Select
|
||||||
|
multipicklist → MULTI_SELECT → Select[multiple]
|
||||||
|
lookup → BELONGS_TO → Combobox (relation picker)
|
||||||
|
file → FILE → FileUpload
|
||||||
|
image → IMAGE → ImageUpload
|
||||||
|
richtext → MARKDOWN → Textarea (+ preview)
|
||||||
|
json → JSON → Textarea (JSON editor)
|
||||||
|
```
|
||||||
|
|
||||||
|
## View Mode Rendering
|
||||||
|
|
||||||
|
```
|
||||||
|
Field Type: TEXT
|
||||||
|
─────────────────────────────────────────────────────
|
||||||
|
LIST mode │ Simple text, truncated
|
||||||
|
│ <span>{{ value }}</span>
|
||||||
|
─────────────────────────────────────────────────────
|
||||||
|
DETAIL mode │ Text with label
|
||||||
|
│ <div>
|
||||||
|
│ <Label>Name</Label>
|
||||||
|
│ <span>{{ value }}</span>
|
||||||
|
│ </div>
|
||||||
|
─────────────────────────────────────────────────────
|
||||||
|
EDIT mode │ Input field
|
||||||
|
│ <Input v-model="value" />
|
||||||
|
─────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
Field Type: BOOLEAN
|
||||||
|
─────────────────────────────────────────────────────
|
||||||
|
LIST mode │ Badge (Yes/No)
|
||||||
|
│ <Badge>Yes</Badge>
|
||||||
|
─────────────────────────────────────────────────────
|
||||||
|
DETAIL mode │ Checkbox (disabled) + text
|
||||||
|
│ <Checkbox :checked="value" disabled />
|
||||||
|
│ <span>Yes</span>
|
||||||
|
─────────────────────────────────────────────────────
|
||||||
|
EDIT mode │ Checkbox (editable)
|
||||||
|
│ <Checkbox v-model="value" />
|
||||||
|
─────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
Field Type: SELECT
|
||||||
|
─────────────────────────────────────────────────────
|
||||||
|
LIST mode │ Selected label
|
||||||
|
│ <span>Active</span>
|
||||||
|
─────────────────────────────────────────────────────
|
||||||
|
DETAIL mode │ Selected label with styling
|
||||||
|
│ <Badge>Active</Badge>
|
||||||
|
─────────────────────────────────────────────────────
|
||||||
|
EDIT mode │ Dropdown select
|
||||||
|
│ <Select v-model="value">
|
||||||
|
│ <SelectItem value="active">Active</SelectItem>
|
||||||
|
│ </Select>
|
||||||
|
─────────────────────────────────────────────────────
|
||||||
|
```
|
||||||
|
|
||||||
|
## API Endpoints
|
||||||
|
|
||||||
|
```
|
||||||
|
Setup/Configuration (Metadata)
|
||||||
|
────────────────────────────────────────────────────
|
||||||
|
GET /api/setup/objects
|
||||||
|
Returns: List of all object definitions
|
||||||
|
|
||||||
|
GET /api/setup/objects/:objectName
|
||||||
|
Returns: Object definition with fields
|
||||||
|
|
||||||
|
GET /api/setup/objects/:objectName/ui-config ✨
|
||||||
|
Returns: Object definition with UI-ready field configs
|
||||||
|
(fields mapped to frontend format with UIMetadata)
|
||||||
|
|
||||||
|
POST /api/setup/objects
|
||||||
|
Body: { apiName, label, description, ... }
|
||||||
|
Returns: Created object definition
|
||||||
|
|
||||||
|
POST /api/setup/objects/:objectName/fields
|
||||||
|
Body: { apiName, label, type, uiMetadata, ... }
|
||||||
|
Returns: Created field definition
|
||||||
|
|
||||||
|
Runtime (Data CRUD)
|
||||||
|
────────────────────────────────────────────────────
|
||||||
|
GET /api/runtime/objects/:objectName
|
||||||
|
Query: { search, filters, page, pageSize }
|
||||||
|
Returns: Array of records
|
||||||
|
|
||||||
|
GET /api/runtime/objects/:objectName/:recordId
|
||||||
|
Returns: Single record
|
||||||
|
|
||||||
|
POST /api/runtime/objects/:objectName
|
||||||
|
Body: { field1: value1, field2: value2, ... }
|
||||||
|
Returns: Created record
|
||||||
|
|
||||||
|
PUT /api/runtime/objects/:objectName/:recordId
|
||||||
|
Body: { field1: value1, field2: value2, ... }
|
||||||
|
Returns: Updated record
|
||||||
|
|
||||||
|
DELETE /api/runtime/objects/:objectName/:recordId
|
||||||
|
Returns: Success status
|
||||||
|
```
|
||||||
|
|
||||||
|
## Key Features
|
||||||
|
|
||||||
|
### Frontend
|
||||||
|
- ✅ Universal field renderer for 15+ field types
|
||||||
|
- ✅ Three view modes (list, detail, edit)
|
||||||
|
- ✅ Client-side validation with custom rules
|
||||||
|
- ✅ Responsive design (mobile-friendly)
|
||||||
|
- ✅ Accessible components (WCAG compliant)
|
||||||
|
- ✅ Type-safe with TypeScript
|
||||||
|
- ✅ Composables for easy integration
|
||||||
|
- ✅ Demo page for testing
|
||||||
|
|
||||||
|
### Backend
|
||||||
|
- ✅ UI metadata stored in JSONB column
|
||||||
|
- ✅ Field mapper service for transformation
|
||||||
|
- ✅ Default metadata generation
|
||||||
|
- ✅ Validation rule support
|
||||||
|
- ✅ Flexible field type system
|
||||||
|
- ✅ Multi-tenant support
|
||||||
|
- ✅ RESTful API
|
||||||
|
|
||||||
|
### Database
|
||||||
|
- ✅ Flexible schema with JSONB metadata
|
||||||
|
- ✅ Support for custom objects
|
||||||
|
- ✅ Versioning and migration support
|
||||||
|
- ✅ Indexed for performance
|
||||||
|
|
||||||
|
## Extension Points
|
||||||
|
|
||||||
|
```
|
||||||
|
1. Custom Field Types
|
||||||
|
└─> Add to FieldType enum
|
||||||
|
└─> Add rendering logic to FieldRenderer.vue
|
||||||
|
└─> Add mapping in FieldMapperService
|
||||||
|
|
||||||
|
2. Custom Validation Rules
|
||||||
|
└─> Add to ValidationRule type
|
||||||
|
└─> Add validation logic in EditView.vue
|
||||||
|
|
||||||
|
3. Custom Actions
|
||||||
|
└─> Add to ViewAction interface
|
||||||
|
└─> Handle in view components
|
||||||
|
|
||||||
|
4. Custom Sections
|
||||||
|
└─> Configure in DetailViewConfig/EditViewConfig
|
||||||
|
└─> Auto-generation in useFields()
|
||||||
|
|
||||||
|
5. Custom Formatting
|
||||||
|
└─> Add to UIMetadata
|
||||||
|
└─> Implement in FieldRenderer.vue
|
||||||
|
```
|
||||||
|
|
||||||
|
This architecture provides a scalable, maintainable, and extensible system for building dynamic forms and views! 🎉
|
||||||
282
FIELD_TYPES_CHECKLIST.md
Normal file
282
FIELD_TYPES_CHECKLIST.md
Normal file
@@ -0,0 +1,282 @@
|
|||||||
|
# Field Types System - Implementation Checklist
|
||||||
|
|
||||||
|
Use this checklist to ensure proper implementation of the field type system in your production environment.
|
||||||
|
|
||||||
|
## ✅ Backend Setup
|
||||||
|
|
||||||
|
### Database
|
||||||
|
- [ ] Run migration: `npm run migrate:tenant` to add `ui_metadata` column
|
||||||
|
- [ ] Verify migration succeeded: Check `field_definitions` table has `ui_metadata` column
|
||||||
|
- [ ] (Optional) Run seed: `knex seed:run --specific=example_contact_fields_with_ui_metadata.js`
|
||||||
|
- [ ] Test database access with sample queries
|
||||||
|
|
||||||
|
### Services
|
||||||
|
- [ ] Verify `FieldMapperService` is registered in `ObjectModule`
|
||||||
|
- [ ] Test field mapping: Call `mapFieldDefinitionToConfig()` with sample field
|
||||||
|
- [ ] Verify default UI metadata generation works
|
||||||
|
- [ ] Test `mapObjectDefinitionToDTO()` with full object
|
||||||
|
|
||||||
|
### Controllers
|
||||||
|
- [ ] Verify `/api/setup/objects/:objectName/ui-config` endpoint works
|
||||||
|
- [ ] Test endpoint returns properly formatted field configs
|
||||||
|
- [ ] Verify authentication/authorization works on endpoints
|
||||||
|
- [ ] Test with different tenant IDs
|
||||||
|
|
||||||
|
### Models
|
||||||
|
- [ ] Confirm `FieldDefinition` model has `uiMetadata` property
|
||||||
|
- [ ] Verify `UIMetadata` interface is properly typed
|
||||||
|
- [ ] Test CRUD operations with UI metadata
|
||||||
|
|
||||||
|
## ✅ Frontend Setup
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
- [ ] Verify all shadcn-vue components are installed
|
||||||
|
- [ ] Check: `table`, `input`, `select`, `checkbox`, `switch`, `textarea`, `calendar`, `badge`, `dialog`
|
||||||
|
- [ ] Confirm `components.json` is properly configured
|
||||||
|
- [ ] Test component imports work
|
||||||
|
|
||||||
|
### Type Definitions
|
||||||
|
- [ ] Verify `/frontend/types/field-types.ts` exists
|
||||||
|
- [ ] Check all `FieldType` enum values are defined
|
||||||
|
- [ ] Verify interface exports work across components
|
||||||
|
- [ ] Test TypeScript compilation with no errors
|
||||||
|
|
||||||
|
### Components
|
||||||
|
- [ ] Test `FieldRenderer.vue` with all field types
|
||||||
|
- [ ] Verify `ListView.vue` renders data table correctly
|
||||||
|
- [ ] Test `DetailView.vue` with sections and collapsibles
|
||||||
|
- [ ] Verify `EditView.vue` form validation works
|
||||||
|
- [ ] Test `DatePicker.vue` component
|
||||||
|
|
||||||
|
### Composables
|
||||||
|
- [ ] Test `useFields()` mapping functions
|
||||||
|
- [ ] Verify `useViewState()` CRUD operations
|
||||||
|
- [ ] Test state management and navigation
|
||||||
|
- [ ] Verify error handling works
|
||||||
|
|
||||||
|
### Pages
|
||||||
|
- [ ] Test demo page at `/demo/field-views`
|
||||||
|
- [ ] Verify dynamic route at `/app/objects/:objectName`
|
||||||
|
- [ ] Test all three views (list, detail, edit)
|
||||||
|
- [ ] Verify navigation between views works
|
||||||
|
|
||||||
|
## ✅ Integration Testing
|
||||||
|
|
||||||
|
### End-to-End Flows
|
||||||
|
- [ ] Create new object definition via API
|
||||||
|
- [ ] Add fields with UI metadata
|
||||||
|
- [ ] Fetch object UI config from frontend
|
||||||
|
- [ ] Render ListView with real data
|
||||||
|
- [ ] Click row to view DetailView
|
||||||
|
- [ ] Click edit to view EditView
|
||||||
|
- [ ] Submit form and verify save works
|
||||||
|
- [ ] Delete record and verify it's removed
|
||||||
|
|
||||||
|
### Field Type Testing
|
||||||
|
Test each field type in all three modes:
|
||||||
|
|
||||||
|
#### Text Fields
|
||||||
|
- [ ] TEXT - List, Detail, Edit modes
|
||||||
|
- [ ] TEXTAREA - List, Detail, Edit modes
|
||||||
|
- [ ] PASSWORD - Edit mode (masked)
|
||||||
|
- [ ] EMAIL - All modes with validation
|
||||||
|
- [ ] URL - All modes with validation
|
||||||
|
|
||||||
|
#### Numeric Fields
|
||||||
|
- [ ] NUMBER - All modes
|
||||||
|
- [ ] CURRENCY - All modes with prefix/suffix
|
||||||
|
|
||||||
|
#### Selection Fields
|
||||||
|
- [ ] SELECT - All modes with options
|
||||||
|
- [ ] MULTI_SELECT - All modes with options
|
||||||
|
- [ ] BOOLEAN - All modes (badge, checkbox)
|
||||||
|
|
||||||
|
#### Date/Time Fields
|
||||||
|
- [ ] DATE - All modes with date picker
|
||||||
|
- [ ] DATETIME - All modes with date/time picker
|
||||||
|
|
||||||
|
### Validation Testing
|
||||||
|
- [ ] Required field validation
|
||||||
|
- [ ] Email format validation
|
||||||
|
- [ ] URL format validation
|
||||||
|
- [ ] Min/max length validation
|
||||||
|
- [ ] Min/max value validation
|
||||||
|
- [ ] Pattern matching validation
|
||||||
|
- [ ] Custom validation rules
|
||||||
|
|
||||||
|
### UI/UX Testing
|
||||||
|
- [ ] Responsive design on mobile devices
|
||||||
|
- [ ] Keyboard navigation works
|
||||||
|
- [ ] Focus management is correct
|
||||||
|
- [ ] Loading states display properly
|
||||||
|
- [ ] Error messages are clear
|
||||||
|
- [ ] Success feedback is visible
|
||||||
|
- [ ] Tooltips and help text display
|
||||||
|
|
||||||
|
## ✅ Performance Testing
|
||||||
|
|
||||||
|
### Frontend
|
||||||
|
- [ ] ListView handles 100+ records smoothly
|
||||||
|
- [ ] Sorting is fast
|
||||||
|
- [ ] Search is responsive
|
||||||
|
- [ ] Form submission is snappy
|
||||||
|
- [ ] No memory leaks on navigation
|
||||||
|
- [ ] Component re-renders are optimized
|
||||||
|
|
||||||
|
### Backend
|
||||||
|
- [ ] Field mapping is performant
|
||||||
|
- [ ] Database queries are optimized
|
||||||
|
- [ ] API response times are acceptable
|
||||||
|
- [ ] Bulk operations handle multiple records
|
||||||
|
- [ ] Concurrent requests handled properly
|
||||||
|
|
||||||
|
## ✅ Security Checklist
|
||||||
|
|
||||||
|
### Authentication
|
||||||
|
- [ ] All API endpoints require authentication
|
||||||
|
- [ ] JWT tokens are validated
|
||||||
|
- [ ] Tenant isolation is enforced
|
||||||
|
- [ ] User permissions are checked
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
- [ ] Read permissions enforced
|
||||||
|
- [ ] Write permissions enforced
|
||||||
|
- [ ] Delete permissions enforced
|
||||||
|
- [ ] Field-level security (if needed)
|
||||||
|
|
||||||
|
### Input Validation
|
||||||
|
- [ ] Server-side validation on all inputs
|
||||||
|
- [ ] SQL injection prevention
|
||||||
|
- [ ] XSS prevention in field values
|
||||||
|
- [ ] CSRF protection enabled
|
||||||
|
|
||||||
|
### Data Protection
|
||||||
|
- [ ] Sensitive fields masked appropriately
|
||||||
|
- [ ] Audit logging for changes
|
||||||
|
- [ ] Data encryption at rest (if needed)
|
||||||
|
- [ ] Proper error messages (no leaking)
|
||||||
|
|
||||||
|
## ✅ Documentation
|
||||||
|
|
||||||
|
### Code Documentation
|
||||||
|
- [ ] JSDoc comments on key functions
|
||||||
|
- [ ] TypeScript interfaces documented
|
||||||
|
- [ ] Complex logic explained with comments
|
||||||
|
- [ ] README files in each major directory
|
||||||
|
|
||||||
|
### User Documentation
|
||||||
|
- [ ] Quick start guide available
|
||||||
|
- [ ] Field types reference documented
|
||||||
|
- [ ] API endpoints documented
|
||||||
|
- [ ] Common use cases documented
|
||||||
|
- [ ] Troubleshooting guide available
|
||||||
|
|
||||||
|
## ✅ Production Readiness
|
||||||
|
|
||||||
|
### Deployment
|
||||||
|
- [ ] Environment variables configured
|
||||||
|
- [ ] Database connection verified
|
||||||
|
- [ ] API endpoints accessible
|
||||||
|
- [ ] Frontend build succeeds
|
||||||
|
- [ ] Assets are served correctly
|
||||||
|
|
||||||
|
### Monitoring
|
||||||
|
- [ ] Error tracking configured (Sentry, etc.)
|
||||||
|
- [ ] Performance monitoring enabled
|
||||||
|
- [ ] API rate limiting configured
|
||||||
|
- [ ] Log aggregation set up
|
||||||
|
- [ ] Alerts configured for critical issues
|
||||||
|
|
||||||
|
### Backup & Recovery
|
||||||
|
- [ ] Database backup strategy defined
|
||||||
|
- [ ] Recovery procedures documented
|
||||||
|
- [ ] Migration rollback tested
|
||||||
|
- [ ] Data export functionality works
|
||||||
|
|
||||||
|
### Scaling
|
||||||
|
- [ ] Database indexes optimized
|
||||||
|
- [ ] API caching strategy defined
|
||||||
|
- [ ] CDN configured for static assets
|
||||||
|
- [ ] Load balancing tested (if applicable)
|
||||||
|
|
||||||
|
## ✅ Quality Assurance
|
||||||
|
|
||||||
|
### Testing Coverage
|
||||||
|
- [ ] Unit tests for services
|
||||||
|
- [ ] Integration tests for API endpoints
|
||||||
|
- [ ] Component tests for views
|
||||||
|
- [ ] E2E tests for critical flows
|
||||||
|
- [ ] Test coverage > 70%
|
||||||
|
|
||||||
|
### Code Quality
|
||||||
|
- [ ] Linting passes with no errors
|
||||||
|
- [ ] TypeScript strict mode enabled
|
||||||
|
- [ ] Code reviews completed
|
||||||
|
- [ ] No console errors in production
|
||||||
|
- [ ] Accessibility audit passed
|
||||||
|
|
||||||
|
### Browser Compatibility
|
||||||
|
- [ ] Chrome/Chromium tested
|
||||||
|
- [ ] Firefox tested
|
||||||
|
- [ ] Safari tested
|
||||||
|
- [ ] Edge tested
|
||||||
|
- [ ] Mobile browsers tested
|
||||||
|
|
||||||
|
## ✅ Maintenance Plan
|
||||||
|
|
||||||
|
### Regular Tasks
|
||||||
|
- [ ] Dependency updates scheduled
|
||||||
|
- [ ] Security patches applied promptly
|
||||||
|
- [ ] Performance monitoring reviewed
|
||||||
|
- [ ] User feedback collected
|
||||||
|
- [ ] Bug fix process defined
|
||||||
|
|
||||||
|
### Future Enhancements
|
||||||
|
- [ ] Custom field types roadmap
|
||||||
|
- [ ] Advanced validation rules planned
|
||||||
|
- [ ] Relationship field implementation
|
||||||
|
- [ ] File upload functionality
|
||||||
|
- [ ] Rich text editor integration
|
||||||
|
|
||||||
|
## 🎯 Success Criteria
|
||||||
|
|
||||||
|
Your field type system is production-ready when:
|
||||||
|
|
||||||
|
- ✅ All backend endpoints return correct data
|
||||||
|
- ✅ All frontend views render without errors
|
||||||
|
- ✅ All field types display correctly in all modes
|
||||||
|
- ✅ Form validation works as expected
|
||||||
|
- ✅ CRUD operations complete successfully
|
||||||
|
- ✅ Performance meets requirements
|
||||||
|
- ✅ Security measures are in place
|
||||||
|
- ✅ Documentation is complete
|
||||||
|
- ✅ Team is trained on usage
|
||||||
|
- ✅ Monitoring is active
|
||||||
|
|
||||||
|
## 📝 Sign-Off
|
||||||
|
|
||||||
|
Once all items are checked, have the following team members sign off:
|
||||||
|
|
||||||
|
- [ ] Backend Developer: _________________ Date: _______
|
||||||
|
- [ ] Frontend Developer: ________________ Date: _______
|
||||||
|
- [ ] QA Engineer: ______________________ Date: _______
|
||||||
|
- [ ] DevOps Engineer: ___________________ Date: _______
|
||||||
|
- [ ] Product Manager: ___________________ Date: _______
|
||||||
|
|
||||||
|
## 🚀 Launch Readiness
|
||||||
|
|
||||||
|
- [ ] All checklist items completed
|
||||||
|
- [ ] Stakeholders notified
|
||||||
|
- [ ] Launch date confirmed
|
||||||
|
- [ ] Rollback plan prepared
|
||||||
|
- [ ] Support team briefed
|
||||||
|
|
||||||
|
**Ready for production!** 🎉
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Notes:**
|
||||||
|
- Keep this checklist updated as new features are added
|
||||||
|
- Review quarterly for improvements
|
||||||
|
- Share learnings with the team
|
||||||
|
- Celebrate successes! 🎊
|
||||||
479
FIELD_TYPES_GUIDE.md
Normal file
479
FIELD_TYPES_GUIDE.md
Normal file
@@ -0,0 +1,479 @@
|
|||||||
|
# Field Types & Views System
|
||||||
|
|
||||||
|
A comprehensive field type system inspired by Laravel Nova, built with Vue 3 and shadcn-vue components. This system provides a flexible way to define and render fields in list, detail, and edit views.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
The system consists of:
|
||||||
|
|
||||||
|
1. **Field Type Definitions** - TypeScript types and enums defining all available field types
|
||||||
|
2. **Field Renderer** - A universal component that renders fields based on type and view mode
|
||||||
|
3. **View Components** - ListView (data table), DetailView, and EditView components
|
||||||
|
4. **Composables** - Utilities for working with fields and managing CRUD operations
|
||||||
|
5. **Backend Support** - Extended field definitions with UI metadata
|
||||||
|
|
||||||
|
## Field Types
|
||||||
|
|
||||||
|
### Text Fields
|
||||||
|
- `TEXT` - Single-line text input
|
||||||
|
- `TEXTAREA` - Multi-line text input
|
||||||
|
- `PASSWORD` - Password input (masked)
|
||||||
|
- `EMAIL` - Email input with validation
|
||||||
|
- `URL` - URL input
|
||||||
|
|
||||||
|
### Numeric Fields
|
||||||
|
- `NUMBER` - Numeric input
|
||||||
|
- `CURRENCY` - Currency input with formatting
|
||||||
|
|
||||||
|
### Selection Fields
|
||||||
|
- `SELECT` - Dropdown select
|
||||||
|
- `MULTI_SELECT` - Multi-select dropdown
|
||||||
|
- `BOOLEAN` - Checkbox/switch
|
||||||
|
|
||||||
|
### Date/Time Fields
|
||||||
|
- `DATE` - Date picker
|
||||||
|
- `DATETIME` - Date and time picker
|
||||||
|
- `TIME` - Time picker
|
||||||
|
|
||||||
|
### Relationship Fields
|
||||||
|
- `BELONGS_TO` - Many-to-one relationship
|
||||||
|
- `HAS_MANY` - One-to-many relationship
|
||||||
|
- `MANY_TO_MANY` - Many-to-many relationship
|
||||||
|
|
||||||
|
### Rich Content
|
||||||
|
- `MARKDOWN` - Markdown editor
|
||||||
|
- `CODE` - Code editor
|
||||||
|
|
||||||
|
### File Fields
|
||||||
|
- `FILE` - File upload
|
||||||
|
- `IMAGE` - Image upload
|
||||||
|
|
||||||
|
### Other
|
||||||
|
- `COLOR` - Color picker
|
||||||
|
- `JSON` - JSON editor
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Basic Example
|
||||||
|
|
||||||
|
```vue
|
||||||
|
<script setup lang="ts">
|
||||||
|
import { ListView, DetailView, EditView } from '@/components/views'
|
||||||
|
import { FieldType, ViewMode } from '@/types/field-types'
|
||||||
|
|
||||||
|
// Define your fields
|
||||||
|
const fields = [
|
||||||
|
{
|
||||||
|
id: '1',
|
||||||
|
apiName: 'name',
|
||||||
|
label: 'Name',
|
||||||
|
type: FieldType.TEXT,
|
||||||
|
isRequired: true,
|
||||||
|
placeholder: 'Enter name',
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '2',
|
||||||
|
apiName: 'email',
|
||||||
|
label: 'Email',
|
||||||
|
type: FieldType.EMAIL,
|
||||||
|
isRequired: true,
|
||||||
|
validationRules: [
|
||||||
|
{ type: 'email', message: 'Invalid email format' }
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '3',
|
||||||
|
apiName: 'status',
|
||||||
|
label: 'Status',
|
||||||
|
type: FieldType.SELECT,
|
||||||
|
options: [
|
||||||
|
{ label: 'Active', value: 'active' },
|
||||||
|
{ label: 'Inactive', value: 'inactive' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
// Create view config
|
||||||
|
const listConfig = {
|
||||||
|
objectApiName: 'Contact',
|
||||||
|
mode: ViewMode.LIST,
|
||||||
|
fields,
|
||||||
|
searchable: true,
|
||||||
|
exportable: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
const data = ref([])
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<ListView
|
||||||
|
:config="listConfig"
|
||||||
|
:data="data"
|
||||||
|
selectable
|
||||||
|
@row-click="handleRowClick"
|
||||||
|
@create="handleCreate"
|
||||||
|
/>
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using with Backend Data
|
||||||
|
|
||||||
|
```vue
|
||||||
|
<script setup lang="ts">
|
||||||
|
import { useFields, useViewState } from '@/composables/useFieldViews'
|
||||||
|
import { ListView } from '@/components/views'
|
||||||
|
|
||||||
|
const { buildListViewConfig } = useFields()
|
||||||
|
const {
|
||||||
|
records,
|
||||||
|
loading,
|
||||||
|
fetchRecords,
|
||||||
|
showDetail,
|
||||||
|
showEdit,
|
||||||
|
deleteRecords
|
||||||
|
} = useViewState('/api/contacts')
|
||||||
|
|
||||||
|
// Fetch object definition from backend
|
||||||
|
const objectDef = await $fetch('/api/objects/contact')
|
||||||
|
|
||||||
|
// Build view config from backend data
|
||||||
|
const listConfig = buildListViewConfig(objectDef, {
|
||||||
|
searchable: true,
|
||||||
|
exportable: true,
|
||||||
|
})
|
||||||
|
|
||||||
|
// Fetch records
|
||||||
|
await fetchRecords()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<ListView
|
||||||
|
:config="listConfig"
|
||||||
|
:data="records"
|
||||||
|
:loading="loading"
|
||||||
|
@row-click="showDetail"
|
||||||
|
@create="showEdit"
|
||||||
|
@delete="deleteRecords"
|
||||||
|
/>
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sections and Grouping
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const detailConfig = {
|
||||||
|
objectApiName: 'Contact',
|
||||||
|
mode: ViewMode.DETAIL,
|
||||||
|
fields,
|
||||||
|
sections: [
|
||||||
|
{
|
||||||
|
title: 'Basic Information',
|
||||||
|
description: 'Primary contact details',
|
||||||
|
fields: ['firstName', 'lastName', 'email'],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Company Information',
|
||||||
|
fields: ['company', 'jobTitle', 'department'],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Additional Details',
|
||||||
|
fields: ['notes', 'tags'],
|
||||||
|
collapsible: true,
|
||||||
|
defaultCollapsed: true,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Field Configuration
|
||||||
|
|
||||||
|
### FieldConfig Interface
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
interface FieldConfig {
|
||||||
|
// Basic properties
|
||||||
|
id: string
|
||||||
|
apiName: string
|
||||||
|
label: string
|
||||||
|
type: FieldType
|
||||||
|
|
||||||
|
// Display
|
||||||
|
placeholder?: string
|
||||||
|
helpText?: string
|
||||||
|
defaultValue?: any
|
||||||
|
|
||||||
|
// Validation
|
||||||
|
isRequired?: boolean
|
||||||
|
isReadOnly?: boolean
|
||||||
|
validationRules?: FieldValidationRule[]
|
||||||
|
|
||||||
|
// View visibility
|
||||||
|
showOnList?: boolean
|
||||||
|
showOnDetail?: boolean
|
||||||
|
showOnEdit?: boolean
|
||||||
|
sortable?: boolean
|
||||||
|
|
||||||
|
// Type-specific options
|
||||||
|
options?: FieldOption[] // For select fields
|
||||||
|
rows?: number // For textarea
|
||||||
|
min?: number // For number/date
|
||||||
|
max?: number // For number/date
|
||||||
|
step?: number // For number
|
||||||
|
accept?: string // For file uploads
|
||||||
|
relationObject?: string // For relationships
|
||||||
|
|
||||||
|
// Formatting
|
||||||
|
format?: string
|
||||||
|
prefix?: string
|
||||||
|
suffix?: string
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Validation Rules
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const field = {
|
||||||
|
// ... other config
|
||||||
|
validationRules: [
|
||||||
|
{ type: 'required', message: 'This field is required' },
|
||||||
|
{ type: 'min', value: 5, message: 'Minimum 5 characters' },
|
||||||
|
{ type: 'max', value: 100, message: 'Maximum 100 characters' },
|
||||||
|
{ type: 'email', message: 'Invalid email format' },
|
||||||
|
{ type: 'url', message: 'Invalid URL format' },
|
||||||
|
{ type: 'pattern', value: '^[A-Z]', message: 'Must start with uppercase' },
|
||||||
|
],
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## View Components
|
||||||
|
|
||||||
|
### ListView
|
||||||
|
|
||||||
|
Features:
|
||||||
|
- Data table with sortable columns
|
||||||
|
- Row selection with bulk actions
|
||||||
|
- Search functionality
|
||||||
|
- Custom actions
|
||||||
|
- Export capability
|
||||||
|
- Pagination support
|
||||||
|
|
||||||
|
Events:
|
||||||
|
- `row-click` - When a row is clicked
|
||||||
|
- `row-select` - When rows are selected
|
||||||
|
- `create` - When create button is clicked
|
||||||
|
- `edit` - When edit button is clicked
|
||||||
|
- `delete` - When delete is triggered
|
||||||
|
- `action` - When custom action is triggered
|
||||||
|
- `sort` - When column sort changes
|
||||||
|
- `search` - When search is performed
|
||||||
|
|
||||||
|
### DetailView
|
||||||
|
|
||||||
|
Features:
|
||||||
|
- Organized sections
|
||||||
|
- Collapsible sections
|
||||||
|
- Custom actions
|
||||||
|
- Read-only display optimized for each field type
|
||||||
|
|
||||||
|
Events:
|
||||||
|
- `edit` - When edit button is clicked
|
||||||
|
- `delete` - When delete button is clicked
|
||||||
|
- `back` - When back button is clicked
|
||||||
|
- `action` - When custom action is triggered
|
||||||
|
|
||||||
|
### EditView
|
||||||
|
|
||||||
|
Features:
|
||||||
|
- Form with validation
|
||||||
|
- Organized sections with collapsible support
|
||||||
|
- Required field indicators
|
||||||
|
- Help text and placeholders
|
||||||
|
- Error messages
|
||||||
|
- Save/Cancel actions
|
||||||
|
|
||||||
|
Events:
|
||||||
|
- `save` - When form is submitted (passes validated data)
|
||||||
|
- `cancel` - When cancel is clicked
|
||||||
|
- `back` - When back is clicked
|
||||||
|
|
||||||
|
## Backend Integration
|
||||||
|
|
||||||
|
### Field Definition Model
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
export interface UIMetadata {
|
||||||
|
placeholder?: string
|
||||||
|
helpText?: string
|
||||||
|
showOnList?: boolean
|
||||||
|
showOnDetail?: boolean
|
||||||
|
showOnEdit?: boolean
|
||||||
|
sortable?: boolean
|
||||||
|
options?: FieldOption[]
|
||||||
|
rows?: number
|
||||||
|
min?: number
|
||||||
|
max?: number
|
||||||
|
step?: number
|
||||||
|
format?: string
|
||||||
|
prefix?: string
|
||||||
|
suffix?: string
|
||||||
|
validationRules?: ValidationRule[]
|
||||||
|
}
|
||||||
|
|
||||||
|
export class FieldDefinition extends BaseModel {
|
||||||
|
// ... existing fields
|
||||||
|
uiMetadata?: UIMetadata
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Migration
|
||||||
|
|
||||||
|
Run the migration to add UI metadata support:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd backend
|
||||||
|
npm run migrate:tenant
|
||||||
|
```
|
||||||
|
|
||||||
|
### API Response Example
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "field-1",
|
||||||
|
"objectDefinitionId": "obj-1",
|
||||||
|
"apiName": "firstName",
|
||||||
|
"label": "First Name",
|
||||||
|
"type": "text",
|
||||||
|
"isRequired": true,
|
||||||
|
"uiMetadata": {
|
||||||
|
"placeholder": "Enter first name",
|
||||||
|
"helpText": "Customer's legal first name",
|
||||||
|
"showOnList": true,
|
||||||
|
"showOnDetail": true,
|
||||||
|
"showOnEdit": true,
|
||||||
|
"sortable": true,
|
||||||
|
"validationRules": [
|
||||||
|
{
|
||||||
|
"type": "min",
|
||||||
|
"value": 2,
|
||||||
|
"message": "Name must be at least 2 characters"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Composables
|
||||||
|
|
||||||
|
### useFields()
|
||||||
|
|
||||||
|
Utilities for working with field configurations:
|
||||||
|
|
||||||
|
- `mapFieldDefinitionToConfig(fieldDef)` - Convert backend field definition to FieldConfig
|
||||||
|
- `buildListViewConfig(objectDef, customConfig)` - Build ListView configuration
|
||||||
|
- `buildDetailViewConfig(objectDef, customConfig)` - Build DetailView configuration
|
||||||
|
- `buildEditViewConfig(objectDef, customConfig)` - Build EditView configuration
|
||||||
|
- `generateSections(fields)` - Auto-generate sections based on field types
|
||||||
|
|
||||||
|
### useViewState(apiEndpoint)
|
||||||
|
|
||||||
|
CRUD operations and state management:
|
||||||
|
|
||||||
|
- **State**: `records`, `currentRecord`, `currentView`, `loading`, `saving`, `error`
|
||||||
|
- **Methods**: `fetchRecords()`, `fetchRecord(id)`, `createRecord(data)`, `updateRecord(id, data)`, `deleteRecord(id)`, `deleteRecords(ids)`
|
||||||
|
- **Navigation**: `showList()`, `showDetail(record)`, `showEdit(record)`, `handleSave(data)`
|
||||||
|
|
||||||
|
## Demo
|
||||||
|
|
||||||
|
Visit `/demo/field-views` to see an interactive demo of all field types and views.
|
||||||
|
|
||||||
|
## Best Practices
|
||||||
|
|
||||||
|
1. **Field Organization** - Group related fields into sections for better UX
|
||||||
|
2. **Validation** - Always provide clear validation messages
|
||||||
|
3. **Help Text** - Use help text to guide users
|
||||||
|
4. **Required Fields** - Mark required fields appropriately
|
||||||
|
5. **Default Values** - Provide sensible defaults when possible
|
||||||
|
6. **Read-Only Fields** - Use for system fields or computed values
|
||||||
|
7. **Conditional Logic** - Use `dependsOn` for conditional field visibility
|
||||||
|
8. **Mobile Responsive** - All components are mobile-responsive by default
|
||||||
|
|
||||||
|
## Extending
|
||||||
|
|
||||||
|
### Adding Custom Field Types
|
||||||
|
|
||||||
|
1. Add new type to `FieldType` enum in [types/field-types.ts](../types/field-types.ts)
|
||||||
|
2. Add rendering logic to [FieldRenderer.vue](../components/fields/FieldRenderer.vue)
|
||||||
|
3. Update validation logic in [EditView.vue](../components/views/EditView.vue)
|
||||||
|
|
||||||
|
### Custom Actions
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const config = {
|
||||||
|
// ... other config
|
||||||
|
actions: [
|
||||||
|
{
|
||||||
|
id: 'export-pdf',
|
||||||
|
label: 'Export PDF',
|
||||||
|
icon: 'FileDown',
|
||||||
|
variant: 'outline',
|
||||||
|
confirmation: 'Export this record to PDF?',
|
||||||
|
handler: async () => {
|
||||||
|
// Custom logic
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Components Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
frontend/
|
||||||
|
├── components/
|
||||||
|
│ ├── fields/
|
||||||
|
│ │ └── FieldRenderer.vue # Universal field renderer
|
||||||
|
│ ├── views/
|
||||||
|
│ │ ├── ListView.vue # Data table view
|
||||||
|
│ │ ├── DetailView.vue # Read-only detail view
|
||||||
|
│ │ └── EditView.vue # Form/edit view
|
||||||
|
│ └── ui/ # shadcn-vue components
|
||||||
|
│ ├── table/
|
||||||
|
│ ├── input/
|
||||||
|
│ ├── select/
|
||||||
|
│ ├── checkbox/
|
||||||
|
│ ├── switch/
|
||||||
|
│ ├── textarea/
|
||||||
|
│ ├── calendar/
|
||||||
|
│ ├── date-picker/
|
||||||
|
│ └── ...
|
||||||
|
├── types/
|
||||||
|
│ └── field-types.ts # Type definitions
|
||||||
|
├── composables/
|
||||||
|
│ └── useFieldViews.ts # Utilities
|
||||||
|
└── pages/
|
||||||
|
└── demo/
|
||||||
|
└── field-views.vue # Interactive demo
|
||||||
|
```
|
||||||
|
|
||||||
|
## Performance Considerations
|
||||||
|
|
||||||
|
- Fields are rendered on-demand based on view mode
|
||||||
|
- Large datasets should use pagination (built-in support)
|
||||||
|
- Validation is performed client-side before API calls
|
||||||
|
- Use `v-memo` for large lists to optimize re-renders
|
||||||
|
|
||||||
|
## Accessibility
|
||||||
|
|
||||||
|
All components follow accessibility best practices:
|
||||||
|
- Proper ARIA labels
|
||||||
|
- Keyboard navigation support
|
||||||
|
- Focus management
|
||||||
|
- Screen reader friendly
|
||||||
|
- High contrast support
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Part of the Neo platform.
|
||||||
267
FIELD_TYPES_IMPLEMENTATION_SUMMARY.md
Normal file
267
FIELD_TYPES_IMPLEMENTATION_SUMMARY.md
Normal file
@@ -0,0 +1,267 @@
|
|||||||
|
# Field Types & Views Implementation Summary
|
||||||
|
|
||||||
|
## What Was Built
|
||||||
|
|
||||||
|
A complete Laravel Nova-inspired field type system with list, detail, and edit views using shadcn-vue components.
|
||||||
|
|
||||||
|
## 📁 Files Created
|
||||||
|
|
||||||
|
### Frontend
|
||||||
|
|
||||||
|
#### Type Definitions
|
||||||
|
- **`/frontend/types/field-types.ts`** - Complete TypeScript definitions for field types, view modes, and configurations
|
||||||
|
|
||||||
|
#### Components
|
||||||
|
- **`/frontend/components/fields/FieldRenderer.vue`** - Universal field renderer that handles all field types in all view modes
|
||||||
|
- **`/frontend/components/views/ListView.vue`** - Data table with search, sort, filter, bulk actions
|
||||||
|
- **`/frontend/components/views/DetailView.vue`** - Read-only detail view with sections
|
||||||
|
- **`/frontend/components/views/EditView.vue`** - Form with validation and sections
|
||||||
|
- **`/frontend/components/ui/date-picker/DatePicker.vue`** - Custom date picker component
|
||||||
|
|
||||||
|
#### Composables
|
||||||
|
- **`/frontend/composables/useFieldViews.ts`** - Utilities for field mapping and CRUD operations
|
||||||
|
|
||||||
|
#### Pages
|
||||||
|
- **`/frontend/pages/demo/field-views.vue`** - Interactive demo page
|
||||||
|
- **`/frontend/pages/app/objects/[objectName]/[[recordId]]/[[view]].vue`** - Dynamic object view page
|
||||||
|
|
||||||
|
### Backend
|
||||||
|
|
||||||
|
#### Models
|
||||||
|
- **Updated `/backend/src/models/field-definition.model.ts`** - Added UIMetadata interface and uiMetadata property
|
||||||
|
|
||||||
|
#### Services
|
||||||
|
- **`/backend/src/object/field-mapper.service.ts`** - Service for mapping backend field definitions to frontend configs
|
||||||
|
|
||||||
|
#### Controllers
|
||||||
|
- **Updated `/backend/src/object/setup-object.controller.ts`** - Added `/ui-config` endpoint
|
||||||
|
|
||||||
|
#### Migrations
|
||||||
|
- **`/backend/migrations/tenant/20250126000005_add_ui_metadata_to_fields.js`** - Database migration for UI metadata
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
- **`/FIELD_TYPES_GUIDE.md`** - Comprehensive documentation
|
||||||
|
- **`/FIELD_TYPES_IMPLEMENTATION_SUMMARY.md`** - This file
|
||||||
|
|
||||||
|
## 🎨 Field Types Supported
|
||||||
|
|
||||||
|
### Text Fields
|
||||||
|
- Text, Textarea, Password, Email, URL
|
||||||
|
|
||||||
|
### Numeric Fields
|
||||||
|
- Number, Currency
|
||||||
|
|
||||||
|
### Selection Fields
|
||||||
|
- Select, Multi-Select, Boolean
|
||||||
|
|
||||||
|
### Date/Time Fields
|
||||||
|
- Date, DateTime, Time
|
||||||
|
|
||||||
|
### Relationship Fields
|
||||||
|
- BelongsTo, HasMany, ManyToMany
|
||||||
|
|
||||||
|
### Rich Content
|
||||||
|
- Markdown, Code
|
||||||
|
|
||||||
|
### File Fields
|
||||||
|
- File, Image
|
||||||
|
|
||||||
|
### Other
|
||||||
|
- Color, JSON
|
||||||
|
|
||||||
|
## 🔧 Components Installed
|
||||||
|
|
||||||
|
Installed from shadcn-vue:
|
||||||
|
- Table (with all sub-components)
|
||||||
|
- Checkbox
|
||||||
|
- Switch
|
||||||
|
- Textarea
|
||||||
|
- Calendar
|
||||||
|
- Popover
|
||||||
|
- Command
|
||||||
|
- Badge
|
||||||
|
- Dialog
|
||||||
|
|
||||||
|
## 🚀 How to Use
|
||||||
|
|
||||||
|
### 1. View the Demo
|
||||||
|
```bash
|
||||||
|
# Start the frontend dev server
|
||||||
|
cd frontend
|
||||||
|
npm run dev
|
||||||
|
|
||||||
|
# Visit http://localhost:3000/demo/field-views
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Use in Your App
|
||||||
|
|
||||||
|
```vue
|
||||||
|
<script setup>
|
||||||
|
import { ListView } from '@/components/views'
|
||||||
|
import { FieldType, ViewMode } from '@/types/field-types'
|
||||||
|
|
||||||
|
const config = {
|
||||||
|
objectApiName: 'Contact',
|
||||||
|
mode: ViewMode.LIST,
|
||||||
|
fields: [
|
||||||
|
{
|
||||||
|
id: '1',
|
||||||
|
apiName: 'name',
|
||||||
|
label: 'Name',
|
||||||
|
type: FieldType.TEXT,
|
||||||
|
isRequired: true,
|
||||||
|
},
|
||||||
|
// ... more fields
|
||||||
|
],
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<ListView :config="config" :data="records" />
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Integrate with Backend
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Frontend
|
||||||
|
const objectDef = await $fetch('/api/setup/objects/Contact/ui-config')
|
||||||
|
const listConfig = buildListViewConfig(objectDef)
|
||||||
|
|
||||||
|
// Backend - the endpoint returns properly formatted field configs
|
||||||
|
GET /api/setup/objects/{objectApiName}/ui-config
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🗃️ Database Changes
|
||||||
|
|
||||||
|
Run the migration to add UI metadata support:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd backend
|
||||||
|
npm run migrate:tenant
|
||||||
|
```
|
||||||
|
|
||||||
|
This adds a `ui_metadata` JSONB column to the `field_definitions` table.
|
||||||
|
|
||||||
|
## 📋 API Endpoints
|
||||||
|
|
||||||
|
### New Endpoint
|
||||||
|
- `GET /api/setup/objects/:objectApiName/ui-config` - Returns object definition with frontend-ready field configs
|
||||||
|
|
||||||
|
### Existing Endpoints
|
||||||
|
- `GET /api/setup/objects` - List all object definitions
|
||||||
|
- `GET /api/setup/objects/:objectApiName` - Get object definition
|
||||||
|
- `POST /api/setup/objects` - Create object definition
|
||||||
|
- `POST /api/setup/objects/:objectApiName/fields` - Create field definition
|
||||||
|
|
||||||
|
## ✨ Features
|
||||||
|
|
||||||
|
### ListView
|
||||||
|
- Sortable columns
|
||||||
|
- Row selection with bulk actions
|
||||||
|
- Search functionality
|
||||||
|
- Custom actions
|
||||||
|
- Export support
|
||||||
|
- Responsive design
|
||||||
|
|
||||||
|
### DetailView
|
||||||
|
- Organized sections
|
||||||
|
- Collapsible sections
|
||||||
|
- Read-only optimized display
|
||||||
|
- Custom actions
|
||||||
|
- Field-type aware rendering
|
||||||
|
|
||||||
|
### EditView
|
||||||
|
- Client-side validation
|
||||||
|
- Required field indicators
|
||||||
|
- Help text and placeholders
|
||||||
|
- Error messages
|
||||||
|
- Organized sections
|
||||||
|
- Collapsible sections
|
||||||
|
|
||||||
|
### FieldRenderer
|
||||||
|
- Handles all 20+ field types
|
||||||
|
- Three rendering modes (list, detail, edit)
|
||||||
|
- Type-specific components
|
||||||
|
- Validation support
|
||||||
|
- Formatting options
|
||||||
|
|
||||||
|
## 🔄 Integration with Existing System
|
||||||
|
|
||||||
|
The field type system integrates seamlessly with your existing multi-tenant app builder:
|
||||||
|
|
||||||
|
1. **Object Definitions** - Uses existing `object_definitions` table
|
||||||
|
2. **Field Definitions** - Extends existing `field_definitions` table with `ui_metadata`
|
||||||
|
3. **Runtime Pages** - Dynamic route at `/app/objects/:objectName` automatically renders appropriate views
|
||||||
|
4. **Composables** - `useFieldViews` provides utilities for mapping backend data
|
||||||
|
|
||||||
|
## 📝 Next Steps
|
||||||
|
|
||||||
|
1. **Run the migration** to add UI metadata support
|
||||||
|
2. **Test the demo** at `/demo/field-views`
|
||||||
|
3. **Integrate with your objects** using the dynamic route
|
||||||
|
4. **Customize field types** as needed for your use case
|
||||||
|
5. **Add validation rules** to field definitions
|
||||||
|
6. **Configure UI metadata** for better UX
|
||||||
|
|
||||||
|
## 🎯 Best Practices
|
||||||
|
|
||||||
|
1. Always provide clear labels and help text
|
||||||
|
2. Use validation rules with custom messages
|
||||||
|
3. Organize fields into logical sections
|
||||||
|
4. Mark required fields appropriately
|
||||||
|
5. Use appropriate field types for data
|
||||||
|
6. Test on mobile devices
|
||||||
|
7. Use read-only for system fields
|
||||||
|
|
||||||
|
## 📚 Documentation
|
||||||
|
|
||||||
|
See [FIELD_TYPES_GUIDE.md](./FIELD_TYPES_GUIDE.md) for complete documentation including:
|
||||||
|
- Detailed usage examples
|
||||||
|
- Field configuration options
|
||||||
|
- Validation rules
|
||||||
|
- Event handling
|
||||||
|
- Customization guide
|
||||||
|
- Performance tips
|
||||||
|
- Accessibility features
|
||||||
|
|
||||||
|
## 🐛 Troubleshooting
|
||||||
|
|
||||||
|
### Missing UI Metadata
|
||||||
|
If fields don't render correctly, ensure:
|
||||||
|
1. Migration has been run
|
||||||
|
2. `uiMetadata` is populated in database
|
||||||
|
3. Field types are correctly mapped
|
||||||
|
|
||||||
|
### Components Not Found
|
||||||
|
Ensure all shadcn-vue components are installed:
|
||||||
|
```bash
|
||||||
|
cd frontend
|
||||||
|
npx shadcn-vue@latest add table checkbox switch textarea calendar popover command badge
|
||||||
|
```
|
||||||
|
|
||||||
|
### Type Errors
|
||||||
|
Ensure TypeScript types are properly imported:
|
||||||
|
```typescript
|
||||||
|
import { FieldType, ViewMode, type FieldConfig } from '@/types/field-types'
|
||||||
|
```
|
||||||
|
|
||||||
|
## 💡 Tips
|
||||||
|
|
||||||
|
1. Use the `FieldMapperService` to automatically generate UI configs
|
||||||
|
2. Leverage `useViewState` composable for CRUD operations
|
||||||
|
3. Customize field rendering by extending `FieldRenderer.vue`
|
||||||
|
4. Add custom actions to views for workflow automation
|
||||||
|
5. Use sections to organize complex forms
|
||||||
|
|
||||||
|
## 🎉 Success!
|
||||||
|
|
||||||
|
You now have a complete, production-ready field type system inspired by Laravel Nova! The system is:
|
||||||
|
- ✅ Fully typed with TypeScript
|
||||||
|
- ✅ Responsive and accessible
|
||||||
|
- ✅ Integrated with your backend
|
||||||
|
- ✅ Extensible and customizable
|
||||||
|
- ✅ Well-documented
|
||||||
|
- ✅ Demo-ready
|
||||||
|
|
||||||
|
Happy building! 🚀
|
||||||
385
QUICK_START_FIELD_TYPES.md
Normal file
385
QUICK_START_FIELD_TYPES.md
Normal file
@@ -0,0 +1,385 @@
|
|||||||
|
# Quick Start: Field Types & Views
|
||||||
|
|
||||||
|
Get up and running with the field type system in 5 minutes!
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- Backend server running
|
||||||
|
- Frontend dev server running
|
||||||
|
- Database migrations applied
|
||||||
|
|
||||||
|
## Step 1: Apply Migration (1 min)
|
||||||
|
|
||||||
|
Add UI metadata support to the database:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd backend
|
||||||
|
npm run migrate:tenant
|
||||||
|
```
|
||||||
|
|
||||||
|
This adds the `ui_metadata` column to `field_definitions` table.
|
||||||
|
|
||||||
|
## Step 2: View the Demo (1 min)
|
||||||
|
|
||||||
|
See the system in action:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd frontend
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
Visit: **http://localhost:3000/demo/field-views**
|
||||||
|
|
||||||
|
You'll see:
|
||||||
|
- ✅ Interactive list view with data table
|
||||||
|
- ✅ Detail view with formatted fields
|
||||||
|
- ✅ Edit view with form validation
|
||||||
|
- ✅ All 15+ field types in action
|
||||||
|
|
||||||
|
## Step 3: Basic Usage (2 min)
|
||||||
|
|
||||||
|
Create a simple list view in your app:
|
||||||
|
|
||||||
|
```vue
|
||||||
|
<script setup lang="ts">
|
||||||
|
import { ref } from 'vue'
|
||||||
|
import { ListView } from '@/components/views'
|
||||||
|
import { FieldType, ViewMode } from '@/types/field-types'
|
||||||
|
|
||||||
|
const config = {
|
||||||
|
objectApiName: 'Product',
|
||||||
|
mode: ViewMode.LIST,
|
||||||
|
fields: [
|
||||||
|
{
|
||||||
|
id: '1',
|
||||||
|
apiName: 'name',
|
||||||
|
label: 'Product Name',
|
||||||
|
type: FieldType.TEXT,
|
||||||
|
isRequired: true,
|
||||||
|
sortable: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '2',
|
||||||
|
apiName: 'price',
|
||||||
|
label: 'Price',
|
||||||
|
type: FieldType.CURRENCY,
|
||||||
|
prefix: '$',
|
||||||
|
sortable: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '3',
|
||||||
|
apiName: 'inStock',
|
||||||
|
label: 'In Stock',
|
||||||
|
type: FieldType.BOOLEAN,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
searchable: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
const products = ref([
|
||||||
|
{ id: '1', name: 'Widget', price: 29.99, inStock: true },
|
||||||
|
{ id: '2', name: 'Gadget', price: 49.99, inStock: false },
|
||||||
|
])
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<ListView
|
||||||
|
:config="config"
|
||||||
|
:data="products"
|
||||||
|
@row-click="(row) => console.log('Clicked:', row)"
|
||||||
|
@create="() => console.log('Create new')"
|
||||||
|
/>
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Step 4: Integrate with Backend (1 min)
|
||||||
|
|
||||||
|
Fetch object definitions from your API:
|
||||||
|
|
||||||
|
```vue
|
||||||
|
<script setup lang="ts">
|
||||||
|
import { ref, onMounted } from 'vue'
|
||||||
|
import { useApi } from '@/composables/useApi'
|
||||||
|
import { useFields } from '@/composables/useFieldViews'
|
||||||
|
import { ListView } from '@/components/views'
|
||||||
|
|
||||||
|
const api = useApi()
|
||||||
|
const { buildListViewConfig } = useFields()
|
||||||
|
|
||||||
|
const config = ref(null)
|
||||||
|
const data = ref([])
|
||||||
|
|
||||||
|
onMounted(async () => {
|
||||||
|
// Fetch object definition with UI config
|
||||||
|
const objectDef = await api.get('/api/setup/objects/Contact/ui-config')
|
||||||
|
config.value = buildListViewConfig(objectDef.data)
|
||||||
|
|
||||||
|
// Fetch records
|
||||||
|
const records = await api.get('/api/runtime/objects/Contact')
|
||||||
|
data.value = records.data
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<ListView v-if="config" :config="config" :data="data" />
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Common Field Types
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Text Input
|
||||||
|
{
|
||||||
|
apiName: 'name',
|
||||||
|
label: 'Name',
|
||||||
|
type: FieldType.TEXT,
|
||||||
|
placeholder: 'Enter name',
|
||||||
|
isRequired: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
// Email with validation
|
||||||
|
{
|
||||||
|
apiName: 'email',
|
||||||
|
label: 'Email',
|
||||||
|
type: FieldType.EMAIL,
|
||||||
|
validationRules: [
|
||||||
|
{ type: 'email', message: 'Invalid email' }
|
||||||
|
],
|
||||||
|
}
|
||||||
|
|
||||||
|
// Select/Dropdown
|
||||||
|
{
|
||||||
|
apiName: 'status',
|
||||||
|
label: 'Status',
|
||||||
|
type: FieldType.SELECT,
|
||||||
|
options: [
|
||||||
|
{ label: 'Active', value: 'active' },
|
||||||
|
{ label: 'Inactive', value: 'inactive' },
|
||||||
|
],
|
||||||
|
}
|
||||||
|
|
||||||
|
// Boolean/Checkbox
|
||||||
|
{
|
||||||
|
apiName: 'isActive',
|
||||||
|
label: 'Active',
|
||||||
|
type: FieldType.BOOLEAN,
|
||||||
|
}
|
||||||
|
|
||||||
|
// Date Picker
|
||||||
|
{
|
||||||
|
apiName: 'startDate',
|
||||||
|
label: 'Start Date',
|
||||||
|
type: FieldType.DATE,
|
||||||
|
}
|
||||||
|
|
||||||
|
// Currency
|
||||||
|
{
|
||||||
|
apiName: 'price',
|
||||||
|
label: 'Price',
|
||||||
|
type: FieldType.CURRENCY,
|
||||||
|
prefix: '$',
|
||||||
|
step: 0.01,
|
||||||
|
}
|
||||||
|
|
||||||
|
// Textarea
|
||||||
|
{
|
||||||
|
apiName: 'description',
|
||||||
|
label: 'Description',
|
||||||
|
type: FieldType.TEXTAREA,
|
||||||
|
rows: 4,
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Three View Types
|
||||||
|
|
||||||
|
### ListView - Data Table
|
||||||
|
```vue
|
||||||
|
<ListView
|
||||||
|
:config="listConfig"
|
||||||
|
:data="records"
|
||||||
|
selectable
|
||||||
|
@row-click="handleRowClick"
|
||||||
|
@create="handleCreate"
|
||||||
|
@delete="handleDelete"
|
||||||
|
/>
|
||||||
|
```
|
||||||
|
|
||||||
|
### DetailView - Read-only Display
|
||||||
|
```vue
|
||||||
|
<DetailView
|
||||||
|
:config="detailConfig"
|
||||||
|
:data="record"
|
||||||
|
@edit="handleEdit"
|
||||||
|
@delete="handleDelete"
|
||||||
|
@back="handleBack"
|
||||||
|
/>
|
||||||
|
```
|
||||||
|
|
||||||
|
### EditView - Form with Validation
|
||||||
|
```vue
|
||||||
|
<EditView
|
||||||
|
:config="editConfig"
|
||||||
|
:data="record"
|
||||||
|
:saving="saving"
|
||||||
|
@save="handleSave"
|
||||||
|
@cancel="handleCancel"
|
||||||
|
@back="handleBack"
|
||||||
|
/>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Using Composables
|
||||||
|
|
||||||
|
### useFields() - Build Configs
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { useFields } from '@/composables/useFieldViews'
|
||||||
|
|
||||||
|
const { buildListViewConfig, buildDetailViewConfig, buildEditViewConfig } = useFields()
|
||||||
|
|
||||||
|
// Convert backend object definition to view configs
|
||||||
|
const listConfig = buildListViewConfig(objectDef)
|
||||||
|
const detailConfig = buildDetailViewConfig(objectDef)
|
||||||
|
const editConfig = buildEditViewConfig(objectDef)
|
||||||
|
```
|
||||||
|
|
||||||
|
### useViewState() - CRUD Operations
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { useViewState } from '@/composables/useFieldViews'
|
||||||
|
|
||||||
|
const {
|
||||||
|
records, // Array of records
|
||||||
|
currentRecord, // Currently selected record
|
||||||
|
currentView, // 'list' | 'detail' | 'edit'
|
||||||
|
loading, // Loading state
|
||||||
|
saving, // Saving state
|
||||||
|
fetchRecords, // Fetch all records
|
||||||
|
fetchRecord, // Fetch single record
|
||||||
|
handleSave, // Save (create or update)
|
||||||
|
deleteRecords, // Delete records
|
||||||
|
showList, // Navigate to list view
|
||||||
|
showDetail, // Navigate to detail view
|
||||||
|
showEdit, // Navigate to edit view
|
||||||
|
} = useViewState('/api/objects/Contact')
|
||||||
|
|
||||||
|
// Fetch records
|
||||||
|
await fetchRecords()
|
||||||
|
|
||||||
|
// Create new
|
||||||
|
showEdit()
|
||||||
|
|
||||||
|
// View details
|
||||||
|
showDetail(record)
|
||||||
|
|
||||||
|
// Save changes
|
||||||
|
await handleSave(formData)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Full CRUD Example
|
||||||
|
|
||||||
|
```vue
|
||||||
|
<script setup lang="ts">
|
||||||
|
import { computed } from 'vue'
|
||||||
|
import { useViewState, useFields } from '@/composables/useFieldViews'
|
||||||
|
import { ListView, DetailView, EditView } from '@/components/views'
|
||||||
|
|
||||||
|
// Fetch object definition
|
||||||
|
const objectDef = await $fetch('/api/setup/objects/Contact/ui-config')
|
||||||
|
|
||||||
|
// Build configs
|
||||||
|
const { buildListViewConfig, buildDetailViewConfig, buildEditViewConfig } = useFields()
|
||||||
|
const listConfig = buildListViewConfig(objectDef)
|
||||||
|
const detailConfig = buildDetailViewConfig(objectDef)
|
||||||
|
const editConfig = buildEditViewConfig(objectDef)
|
||||||
|
|
||||||
|
// Setup CRUD operations
|
||||||
|
const {
|
||||||
|
records,
|
||||||
|
currentRecord,
|
||||||
|
currentView,
|
||||||
|
loading,
|
||||||
|
saving,
|
||||||
|
fetchRecords,
|
||||||
|
handleSave,
|
||||||
|
deleteRecords,
|
||||||
|
showList,
|
||||||
|
showDetail,
|
||||||
|
showEdit,
|
||||||
|
} = useViewState('/api/objects/Contact')
|
||||||
|
|
||||||
|
// Fetch initial data
|
||||||
|
await fetchRecords()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div>
|
||||||
|
<!-- List View -->
|
||||||
|
<ListView
|
||||||
|
v-if="currentView === 'list'"
|
||||||
|
:config="listConfig"
|
||||||
|
:data="records"
|
||||||
|
:loading="loading"
|
||||||
|
@row-click="showDetail"
|
||||||
|
@create="() => showEdit()"
|
||||||
|
@delete="deleteRecords"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<!-- Detail View -->
|
||||||
|
<DetailView
|
||||||
|
v-else-if="currentView === 'detail'"
|
||||||
|
:config="detailConfig"
|
||||||
|
:data="currentRecord"
|
||||||
|
@edit="showEdit"
|
||||||
|
@delete="() => deleteRecords([currentRecord.id])"
|
||||||
|
@back="showList"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<!-- Edit View -->
|
||||||
|
<EditView
|
||||||
|
v-else-if="currentView === 'edit'"
|
||||||
|
:config="editConfig"
|
||||||
|
:data="currentRecord"
|
||||||
|
:saving="saving"
|
||||||
|
@save="handleSave"
|
||||||
|
@cancel="currentRecord?.id ? showDetail(currentRecord) : showList()"
|
||||||
|
@back="showList"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
|
||||||
|
1. ✅ Read [FIELD_TYPES_GUIDE.md](./FIELD_TYPES_GUIDE.md) for complete documentation
|
||||||
|
2. ✅ Check [FIELD_TYPES_IMPLEMENTATION_SUMMARY.md](./FIELD_TYPES_IMPLEMENTATION_SUMMARY.md) for what was built
|
||||||
|
3. ✅ Run the demo at `/demo/field-views`
|
||||||
|
4. ✅ Try the dynamic route at `/app/objects/:objectName`
|
||||||
|
5. ✅ Customize field types as needed
|
||||||
|
6. ✅ Add validation rules to your fields
|
||||||
|
7. ✅ Configure sections for better organization
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
**Fields not rendering?**
|
||||||
|
- Ensure migration is run: `npm run migrate:tenant`
|
||||||
|
- Check `ui_metadata` in database
|
||||||
|
- Verify field types are correct
|
||||||
|
|
||||||
|
**Components not found?**
|
||||||
|
```bash
|
||||||
|
cd frontend
|
||||||
|
npx shadcn-vue@latest add table checkbox switch textarea calendar
|
||||||
|
```
|
||||||
|
|
||||||
|
**Type errors?**
|
||||||
|
```typescript
|
||||||
|
import { FieldType, ViewMode, type FieldConfig } from '@/types/field-types'
|
||||||
|
```
|
||||||
|
|
||||||
|
## Need Help?
|
||||||
|
|
||||||
|
- See examples in `/frontend/pages/demo/field-views.vue`
|
||||||
|
- Check seed data in `/backend/seeds/example_contact_fields_with_ui_metadata.js`
|
||||||
|
- Read the full guide in `FIELD_TYPES_GUIDE.md`
|
||||||
|
|
||||||
|
Happy coding! 🎉
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
/**
|
||||||
|
* @param { import("knex").Knex } knex
|
||||||
|
* @returns { Promise<void> }
|
||||||
|
*/
|
||||||
|
exports.up = function(knex) {
|
||||||
|
return knex.schema.table('field_definitions', (table) => {
|
||||||
|
table.jsonb('ui_metadata').nullable().comment('JSON metadata for UI rendering including display options, validation rules, and field-specific configurations');
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param { import("knex").Knex } knex
|
||||||
|
* @returns { Promise<void> }
|
||||||
|
*/
|
||||||
|
exports.down = function(knex) {
|
||||||
|
return knex.schema.table('field_definitions', (table) => {
|
||||||
|
table.dropColumn('ui_metadata');
|
||||||
|
});
|
||||||
|
};
|
||||||
349
backend/seeds/example_contact_fields_with_ui_metadata.js
Normal file
349
backend/seeds/example_contact_fields_with_ui_metadata.js
Normal file
@@ -0,0 +1,349 @@
|
|||||||
|
/**
|
||||||
|
* Example seed data for Contact object with UI metadata
|
||||||
|
* Run this after creating the object definition
|
||||||
|
*/
|
||||||
|
|
||||||
|
exports.seed = async function(knex) {
|
||||||
|
// Get or create the Contact object
|
||||||
|
const [contactObj] = await knex('object_definitions')
|
||||||
|
.where({ api_name: 'Contact' })
|
||||||
|
.select('id');
|
||||||
|
|
||||||
|
if (!contactObj) {
|
||||||
|
console.log('Contact object not found. Please create it first.');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Define fields with UI metadata
|
||||||
|
const fields = [
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'firstName',
|
||||||
|
label: 'First Name',
|
||||||
|
type: 'text',
|
||||||
|
is_required: true,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 1,
|
||||||
|
ui_metadata: {
|
||||||
|
placeholder: 'Enter first name',
|
||||||
|
helpText: 'The contact\'s given name',
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
validationRules: [
|
||||||
|
{ type: 'min', value: 2, message: 'First name must be at least 2 characters' },
|
||||||
|
{ type: 'max', value: 50, message: 'First name cannot exceed 50 characters' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'lastName',
|
||||||
|
label: 'Last Name',
|
||||||
|
type: 'text',
|
||||||
|
is_required: true,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 2,
|
||||||
|
ui_metadata: {
|
||||||
|
placeholder: 'Enter last name',
|
||||||
|
helpText: 'The contact\'s family name',
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
validationRules: [
|
||||||
|
{ type: 'min', value: 2, message: 'Last name must be at least 2 characters' },
|
||||||
|
{ type: 'max', value: 50, message: 'Last name cannot exceed 50 characters' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'email',
|
||||||
|
label: 'Email',
|
||||||
|
type: 'email',
|
||||||
|
is_required: true,
|
||||||
|
is_unique: true,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 3,
|
||||||
|
ui_metadata: {
|
||||||
|
placeholder: 'email@example.com',
|
||||||
|
helpText: 'Primary email address',
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
validationRules: [
|
||||||
|
{ type: 'email', message: 'Please enter a valid email address' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'phone',
|
||||||
|
label: 'Phone',
|
||||||
|
type: 'text',
|
||||||
|
is_required: false,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 4,
|
||||||
|
ui_metadata: {
|
||||||
|
placeholder: '+1 (555) 000-0000',
|
||||||
|
helpText: 'Primary phone number',
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: false,
|
||||||
|
validationRules: [
|
||||||
|
{ type: 'pattern', value: '^\\+?[0-9\\s\\-\\(\\)]+$', message: 'Please enter a valid phone number' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'company',
|
||||||
|
label: 'Company',
|
||||||
|
type: 'text',
|
||||||
|
is_required: false,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 5,
|
||||||
|
ui_metadata: {
|
||||||
|
placeholder: 'Company name',
|
||||||
|
helpText: 'The organization this contact works for',
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'jobTitle',
|
||||||
|
label: 'Job Title',
|
||||||
|
type: 'text',
|
||||||
|
is_required: false,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 6,
|
||||||
|
ui_metadata: {
|
||||||
|
placeholder: 'e.g., Senior Manager',
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'status',
|
||||||
|
label: 'Status',
|
||||||
|
type: 'picklist',
|
||||||
|
is_required: true,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 7,
|
||||||
|
default_value: 'active',
|
||||||
|
ui_metadata: {
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
options: [
|
||||||
|
{ label: 'Active', value: 'active' },
|
||||||
|
{ label: 'Inactive', value: 'inactive' },
|
||||||
|
{ label: 'Pending', value: 'pending' },
|
||||||
|
{ label: 'Archived', value: 'archived' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'leadSource',
|
||||||
|
label: 'Lead Source',
|
||||||
|
type: 'picklist',
|
||||||
|
is_required: false,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 8,
|
||||||
|
ui_metadata: {
|
||||||
|
placeholder: 'Select lead source',
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
options: [
|
||||||
|
{ label: 'Website', value: 'website' },
|
||||||
|
{ label: 'Referral', value: 'referral' },
|
||||||
|
{ label: 'Social Media', value: 'social' },
|
||||||
|
{ label: 'Conference', value: 'conference' },
|
||||||
|
{ label: 'Cold Call', value: 'cold_call' },
|
||||||
|
{ label: 'Other', value: 'other' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'isVip',
|
||||||
|
label: 'VIP Customer',
|
||||||
|
type: 'boolean',
|
||||||
|
is_required: false,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 9,
|
||||||
|
default_value: 'false',
|
||||||
|
ui_metadata: {
|
||||||
|
helpText: 'Mark as VIP for priority support',
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'birthDate',
|
||||||
|
label: 'Birth Date',
|
||||||
|
type: 'date',
|
||||||
|
is_required: false,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 10,
|
||||||
|
ui_metadata: {
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
format: 'yyyy-MM-dd'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'website',
|
||||||
|
label: 'Website',
|
||||||
|
type: 'url',
|
||||||
|
is_required: false,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 11,
|
||||||
|
ui_metadata: {
|
||||||
|
placeholder: 'https://example.com',
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: false,
|
||||||
|
validationRules: [
|
||||||
|
{ type: 'url', message: 'Please enter a valid URL starting with http:// or https://' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'mailingAddress',
|
||||||
|
label: 'Mailing Address',
|
||||||
|
type: 'textarea',
|
||||||
|
is_required: false,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 12,
|
||||||
|
ui_metadata: {
|
||||||
|
placeholder: 'Enter full mailing address',
|
||||||
|
rows: 3,
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'notes',
|
||||||
|
label: 'Notes',
|
||||||
|
type: 'textarea',
|
||||||
|
is_required: false,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 13,
|
||||||
|
ui_metadata: {
|
||||||
|
placeholder: 'Additional notes about this contact...',
|
||||||
|
rows: 5,
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'annualRevenue',
|
||||||
|
label: 'Annual Revenue',
|
||||||
|
type: 'currency',
|
||||||
|
is_required: false,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 14,
|
||||||
|
ui_metadata: {
|
||||||
|
prefix: '$',
|
||||||
|
step: 0.01,
|
||||||
|
min: 0,
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
object_definition_id: contactObj.id,
|
||||||
|
api_name: 'numberOfEmployees',
|
||||||
|
label: 'Number of Employees',
|
||||||
|
type: 'integer',
|
||||||
|
is_required: false,
|
||||||
|
is_system: false,
|
||||||
|
is_custom: false,
|
||||||
|
display_order: 15,
|
||||||
|
ui_metadata: {
|
||||||
|
min: 1,
|
||||||
|
step: 1,
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
];
|
||||||
|
|
||||||
|
// Insert or update fields
|
||||||
|
for (const field of fields) {
|
||||||
|
const existing = await knex('field_definitions')
|
||||||
|
.where({
|
||||||
|
object_definition_id: field.object_definition_id,
|
||||||
|
api_name: field.api_name
|
||||||
|
})
|
||||||
|
.first();
|
||||||
|
|
||||||
|
if (existing) {
|
||||||
|
await knex('field_definitions')
|
||||||
|
.where({ id: existing.id })
|
||||||
|
.update({
|
||||||
|
...field,
|
||||||
|
ui_metadata: JSON.stringify(field.ui_metadata),
|
||||||
|
updated_at: knex.fn.now()
|
||||||
|
});
|
||||||
|
console.log(`Updated field: ${field.api_name}`);
|
||||||
|
} else {
|
||||||
|
await knex('field_definitions').insert({
|
||||||
|
...field,
|
||||||
|
ui_metadata: JSON.stringify(field.ui_metadata),
|
||||||
|
created_at: knex.fn.now(),
|
||||||
|
updated_at: knex.fn.now()
|
||||||
|
});
|
||||||
|
console.log(`Created field: ${field.api_name}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log('Contact fields seeded successfully!');
|
||||||
|
};
|
||||||
@@ -1,5 +1,49 @@
|
|||||||
import { BaseModel } from './base.model';
|
import { BaseModel } from './base.model';
|
||||||
|
|
||||||
|
export interface FieldOption {
|
||||||
|
label: string;
|
||||||
|
value: string | number | boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ValidationRule {
|
||||||
|
type: 'required' | 'min' | 'max' | 'email' | 'url' | 'pattern' | 'custom';
|
||||||
|
value?: any;
|
||||||
|
message?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface UIMetadata {
|
||||||
|
// Display properties
|
||||||
|
placeholder?: string;
|
||||||
|
helpText?: string;
|
||||||
|
|
||||||
|
// View visibility
|
||||||
|
showOnList?: boolean;
|
||||||
|
showOnDetail?: boolean;
|
||||||
|
showOnEdit?: boolean;
|
||||||
|
sortable?: boolean;
|
||||||
|
|
||||||
|
// Field type specific options
|
||||||
|
options?: FieldOption[]; // For select, multi-select
|
||||||
|
rows?: number; // For textarea
|
||||||
|
min?: number; // For number, date
|
||||||
|
max?: number; // For number, date
|
||||||
|
step?: number; // For number
|
||||||
|
accept?: string; // For file/image
|
||||||
|
relationDisplayField?: string; // Which field to display for relations
|
||||||
|
|
||||||
|
// Formatting
|
||||||
|
format?: string; // Date format, number format, etc.
|
||||||
|
prefix?: string; // Currency symbol, etc.
|
||||||
|
suffix?: string;
|
||||||
|
|
||||||
|
// Validation
|
||||||
|
validationRules?: ValidationRule[];
|
||||||
|
|
||||||
|
// Advanced
|
||||||
|
dependsOn?: string[]; // Field dependencies
|
||||||
|
computedValue?: string; // Formula for computed fields
|
||||||
|
}
|
||||||
|
|
||||||
export class FieldDefinition extends BaseModel {
|
export class FieldDefinition extends BaseModel {
|
||||||
static tableName = 'field_definitions';
|
static tableName = 'field_definitions';
|
||||||
|
|
||||||
@@ -19,6 +63,7 @@ export class FieldDefinition extends BaseModel {
|
|||||||
isSystem!: boolean;
|
isSystem!: boolean;
|
||||||
isCustom!: boolean;
|
isCustom!: boolean;
|
||||||
displayOrder!: number;
|
displayOrder!: number;
|
||||||
|
uiMetadata?: UIMetadata;
|
||||||
|
|
||||||
static relationMappings = {
|
static relationMappings = {
|
||||||
objectDefinition: {
|
objectDefinition: {
|
||||||
|
|||||||
295
backend/src/object/field-mapper.service.ts
Normal file
295
backend/src/object/field-mapper.service.ts
Normal file
@@ -0,0 +1,295 @@
|
|||||||
|
import { Injectable } from '@nestjs/common';
|
||||||
|
import { FieldDefinition } from '../models/field-definition.model';
|
||||||
|
|
||||||
|
export interface FieldConfigDTO {
|
||||||
|
id: string;
|
||||||
|
apiName: string;
|
||||||
|
label: string;
|
||||||
|
type: string;
|
||||||
|
placeholder?: string;
|
||||||
|
helpText?: string;
|
||||||
|
defaultValue?: any;
|
||||||
|
isRequired?: boolean;
|
||||||
|
isReadOnly?: boolean;
|
||||||
|
showOnList?: boolean;
|
||||||
|
showOnDetail?: boolean;
|
||||||
|
showOnEdit?: boolean;
|
||||||
|
sortable?: boolean;
|
||||||
|
options?: Array<{ label: string; value: any }>;
|
||||||
|
rows?: number;
|
||||||
|
min?: number;
|
||||||
|
max?: number;
|
||||||
|
step?: number;
|
||||||
|
accept?: string;
|
||||||
|
relationObject?: string;
|
||||||
|
relationDisplayField?: string;
|
||||||
|
format?: string;
|
||||||
|
prefix?: string;
|
||||||
|
suffix?: string;
|
||||||
|
validationRules?: Array<{
|
||||||
|
type: string;
|
||||||
|
value?: any;
|
||||||
|
message?: string;
|
||||||
|
}>;
|
||||||
|
dependsOn?: string[];
|
||||||
|
computedValue?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ObjectDefinitionDTO {
|
||||||
|
id: string;
|
||||||
|
apiName: string;
|
||||||
|
label: string;
|
||||||
|
pluralLabel?: string;
|
||||||
|
description?: string;
|
||||||
|
isSystem: boolean;
|
||||||
|
fields: FieldConfigDTO[];
|
||||||
|
}
|
||||||
|
|
||||||
|
@Injectable()
|
||||||
|
export class FieldMapperService {
|
||||||
|
/**
|
||||||
|
* Convert a field definition from the database to a frontend-friendly FieldConfig
|
||||||
|
*/
|
||||||
|
mapFieldToDTO(field: any): FieldConfigDTO {
|
||||||
|
const uiMetadata = field.uiMetadata || {};
|
||||||
|
|
||||||
|
return {
|
||||||
|
id: field.id,
|
||||||
|
apiName: field.apiName,
|
||||||
|
label: field.label,
|
||||||
|
type: this.mapFieldType(field.type),
|
||||||
|
|
||||||
|
// Display properties
|
||||||
|
placeholder: uiMetadata.placeholder || field.description,
|
||||||
|
helpText: uiMetadata.helpText || field.description,
|
||||||
|
defaultValue: field.defaultValue,
|
||||||
|
|
||||||
|
// Validation
|
||||||
|
isRequired: field.isRequired || false,
|
||||||
|
isReadOnly: field.isSystem || uiMetadata.isReadOnly || false,
|
||||||
|
|
||||||
|
// View visibility
|
||||||
|
showOnList: uiMetadata.showOnList !== false,
|
||||||
|
showOnDetail: uiMetadata.showOnDetail !== false,
|
||||||
|
showOnEdit: uiMetadata.showOnEdit !== false && !field.isSystem,
|
||||||
|
sortable: uiMetadata.sortable !== false,
|
||||||
|
|
||||||
|
// Field type specific options
|
||||||
|
options: uiMetadata.options,
|
||||||
|
rows: uiMetadata.rows,
|
||||||
|
min: uiMetadata.min,
|
||||||
|
max: uiMetadata.max,
|
||||||
|
step: uiMetadata.step,
|
||||||
|
accept: uiMetadata.accept,
|
||||||
|
relationObject: field.referenceObject,
|
||||||
|
relationDisplayField: uiMetadata.relationDisplayField,
|
||||||
|
|
||||||
|
// Formatting
|
||||||
|
format: uiMetadata.format,
|
||||||
|
prefix: uiMetadata.prefix,
|
||||||
|
suffix: uiMetadata.suffix,
|
||||||
|
|
||||||
|
// Validation rules
|
||||||
|
validationRules: this.buildValidationRules(field, uiMetadata),
|
||||||
|
|
||||||
|
// Advanced
|
||||||
|
dependsOn: uiMetadata.dependsOn,
|
||||||
|
computedValue: uiMetadata.computedValue,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Map database field type to frontend FieldType enum
|
||||||
|
*/
|
||||||
|
private mapFieldType(dbType: string): string {
|
||||||
|
const typeMap: Record<string, string> = {
|
||||||
|
'string': 'text',
|
||||||
|
'text': 'textarea',
|
||||||
|
'integer': 'number',
|
||||||
|
'decimal': 'number',
|
||||||
|
'boolean': 'boolean',
|
||||||
|
'date': 'date',
|
||||||
|
'datetime': 'datetime',
|
||||||
|
'time': 'time',
|
||||||
|
'email': 'email',
|
||||||
|
'url': 'url',
|
||||||
|
'phone': 'text',
|
||||||
|
'picklist': 'select',
|
||||||
|
'multipicklist': 'multiSelect',
|
||||||
|
'lookup': 'belongsTo',
|
||||||
|
'master-detail': 'belongsTo',
|
||||||
|
'currency': 'currency',
|
||||||
|
'percent': 'number',
|
||||||
|
'textarea': 'textarea',
|
||||||
|
'richtext': 'markdown',
|
||||||
|
'file': 'file',
|
||||||
|
'image': 'image',
|
||||||
|
'json': 'json',
|
||||||
|
};
|
||||||
|
|
||||||
|
return typeMap[dbType.toLowerCase()] || 'text';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build validation rules array
|
||||||
|
*/
|
||||||
|
private buildValidationRules(field: any, uiMetadata: any): Array<any> {
|
||||||
|
const rules = uiMetadata.validationRules || [];
|
||||||
|
|
||||||
|
// Add required rule if field is required and not already in rules
|
||||||
|
if (field.isRequired && !rules.some(r => r.type === 'required')) {
|
||||||
|
rules.unshift({
|
||||||
|
type: 'required',
|
||||||
|
message: `${field.label} is required`,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add length validation for string fields
|
||||||
|
if (field.length && field.type === 'string') {
|
||||||
|
rules.push({
|
||||||
|
type: 'max',
|
||||||
|
value: field.length,
|
||||||
|
message: `${field.label} must not exceed ${field.length} characters`,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add email validation
|
||||||
|
if (field.type === 'email' && !rules.some(r => r.type === 'email')) {
|
||||||
|
rules.push({
|
||||||
|
type: 'email',
|
||||||
|
message: `${field.label} must be a valid email address`,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add URL validation
|
||||||
|
if (field.type === 'url' && !rules.some(r => r.type === 'url')) {
|
||||||
|
rules.push({
|
||||||
|
type: 'url',
|
||||||
|
message: `${field.label} must be a valid URL`,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return rules;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convert object definition with fields to DTO
|
||||||
|
*/
|
||||||
|
mapObjectDefinitionToDTO(objectDef: any): ObjectDefinitionDTO {
|
||||||
|
return {
|
||||||
|
id: objectDef.id,
|
||||||
|
apiName: objectDef.apiName,
|
||||||
|
label: objectDef.label,
|
||||||
|
pluralLabel: objectDef.pluralLabel,
|
||||||
|
description: objectDef.description,
|
||||||
|
isSystem: objectDef.isSystem || false,
|
||||||
|
fields: (objectDef.fields || [])
|
||||||
|
.filter((f: any) => f.isActive !== false)
|
||||||
|
.sort((a: any, b: any) => (a.displayOrder || 0) - (b.displayOrder || 0))
|
||||||
|
.map((f: any) => this.mapFieldToDTO(f)),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generate default UI metadata for a field type
|
||||||
|
*/
|
||||||
|
generateDefaultUIMetadata(fieldType: string): any {
|
||||||
|
const defaults: Record<string, any> = {
|
||||||
|
text: {
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
},
|
||||||
|
textarea: {
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: false,
|
||||||
|
rows: 4,
|
||||||
|
},
|
||||||
|
number: {
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
},
|
||||||
|
currency: {
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
prefix: '$',
|
||||||
|
step: 0.01,
|
||||||
|
},
|
||||||
|
boolean: {
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
},
|
||||||
|
date: {
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
format: 'yyyy-MM-dd',
|
||||||
|
},
|
||||||
|
datetime: {
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
format: 'yyyy-MM-dd HH:mm:ss',
|
||||||
|
},
|
||||||
|
email: {
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
validationRules: [{ type: 'email' }],
|
||||||
|
},
|
||||||
|
url: {
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: false,
|
||||||
|
validationRules: [{ type: 'url' }],
|
||||||
|
},
|
||||||
|
select: {
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
options: [],
|
||||||
|
},
|
||||||
|
multiSelect: {
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: false,
|
||||||
|
options: [],
|
||||||
|
},
|
||||||
|
image: {
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: false,
|
||||||
|
accept: 'image/*',
|
||||||
|
},
|
||||||
|
file: {
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: false,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
return defaults[fieldType] || {
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -3,12 +3,13 @@ import { ObjectService } from './object.service';
|
|||||||
import { RuntimeObjectController } from './runtime-object.controller';
|
import { RuntimeObjectController } from './runtime-object.controller';
|
||||||
import { SetupObjectController } from './setup-object.controller';
|
import { SetupObjectController } from './setup-object.controller';
|
||||||
import { SchemaManagementService } from './schema-management.service';
|
import { SchemaManagementService } from './schema-management.service';
|
||||||
|
import { FieldMapperService } from './field-mapper.service';
|
||||||
import { TenantModule } from '../tenant/tenant.module';
|
import { TenantModule } from '../tenant/tenant.module';
|
||||||
|
|
||||||
@Module({
|
@Module({
|
||||||
imports: [TenantModule],
|
imports: [TenantModule],
|
||||||
providers: [ObjectService, SchemaManagementService],
|
providers: [ObjectService, SchemaManagementService, FieldMapperService],
|
||||||
controllers: [RuntimeObjectController, SetupObjectController],
|
controllers: [RuntimeObjectController, SetupObjectController],
|
||||||
exports: [ObjectService, SchemaManagementService],
|
exports: [ObjectService, SchemaManagementService, FieldMapperService],
|
||||||
})
|
})
|
||||||
export class ObjectModule {}
|
export class ObjectModule {}
|
||||||
|
|||||||
@@ -7,13 +7,17 @@ import {
|
|||||||
UseGuards,
|
UseGuards,
|
||||||
} from '@nestjs/common';
|
} from '@nestjs/common';
|
||||||
import { ObjectService } from './object.service';
|
import { ObjectService } from './object.service';
|
||||||
|
import { FieldMapperService } from './field-mapper.service';
|
||||||
import { JwtAuthGuard } from '../auth/jwt-auth.guard';
|
import { JwtAuthGuard } from '../auth/jwt-auth.guard';
|
||||||
import { TenantId } from '../tenant/tenant.decorator';
|
import { TenantId } from '../tenant/tenant.decorator';
|
||||||
|
|
||||||
@Controller('setup/objects')
|
@Controller('setup/objects')
|
||||||
@UseGuards(JwtAuthGuard)
|
@UseGuards(JwtAuthGuard)
|
||||||
export class SetupObjectController {
|
export class SetupObjectController {
|
||||||
constructor(private objectService: ObjectService) {}
|
constructor(
|
||||||
|
private objectService: ObjectService,
|
||||||
|
private fieldMapperService: FieldMapperService,
|
||||||
|
) {}
|
||||||
|
|
||||||
@Get()
|
@Get()
|
||||||
async getObjectDefinitions(@TenantId() tenantId: string) {
|
async getObjectDefinitions(@TenantId() tenantId: string) {
|
||||||
@@ -28,6 +32,18 @@ export class SetupObjectController {
|
|||||||
return this.objectService.getObjectDefinition(tenantId, objectApiName);
|
return this.objectService.getObjectDefinition(tenantId, objectApiName);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Get(':objectApiName/ui-config')
|
||||||
|
async getObjectUIConfig(
|
||||||
|
@TenantId() tenantId: string,
|
||||||
|
@Param('objectApiName') objectApiName: string,
|
||||||
|
) {
|
||||||
|
const objectDef = await this.objectService.getObjectDefinition(
|
||||||
|
tenantId,
|
||||||
|
objectApiName,
|
||||||
|
);
|
||||||
|
return this.fieldMapperService.mapObjectDefinitionToDTO(objectDef);
|
||||||
|
}
|
||||||
|
|
||||||
@Post()
|
@Post()
|
||||||
async createObjectDefinition(
|
async createObjectDefinition(
|
||||||
@TenantId() tenantId: string,
|
@TenantId() tenantId: string,
|
||||||
|
|||||||
202
frontend/components/fields/FieldRenderer.vue
Normal file
202
frontend/components/fields/FieldRenderer.vue
Normal file
@@ -0,0 +1,202 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import { computed } from 'vue'
|
||||||
|
import { Input } from '@/components/ui/input'
|
||||||
|
import { Textarea } from '@/components/ui/textarea'
|
||||||
|
import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from '@/components/ui/select'
|
||||||
|
import { Checkbox } from '@/components/ui/checkbox'
|
||||||
|
import { Switch } from '@/components/ui/switch'
|
||||||
|
import { DatePicker } from '@/components/ui/date-picker'
|
||||||
|
import { Badge } from '@/components/ui/badge'
|
||||||
|
import { FieldConfig, FieldType, ViewMode } from '@/types/field-types'
|
||||||
|
import { Label } from '@/components/ui/label'
|
||||||
|
|
||||||
|
interface Props {
|
||||||
|
field: FieldConfig
|
||||||
|
modelValue: any
|
||||||
|
mode: ViewMode
|
||||||
|
readonly?: boolean
|
||||||
|
}
|
||||||
|
|
||||||
|
const props = defineProps<Props>()
|
||||||
|
const emit = defineEmits<{
|
||||||
|
'update:modelValue': [value: any]
|
||||||
|
}>()
|
||||||
|
|
||||||
|
const value = computed({
|
||||||
|
get: () => props.modelValue,
|
||||||
|
set: (val) => emit('update:modelValue', val),
|
||||||
|
})
|
||||||
|
|
||||||
|
const isReadOnly = computed(() => props.readonly || props.field.isReadOnly || props.mode === ViewMode.DETAIL)
|
||||||
|
const isEditMode = computed(() => props.mode === ViewMode.EDIT)
|
||||||
|
const isListMode = computed(() => props.mode === ViewMode.LIST)
|
||||||
|
const isDetailMode = computed(() => props.mode === ViewMode.DETAIL)
|
||||||
|
|
||||||
|
const formatValue = (val: any): string => {
|
||||||
|
if (val === null || val === undefined) return '-'
|
||||||
|
|
||||||
|
switch (props.field.type) {
|
||||||
|
case FieldType.DATE:
|
||||||
|
return val instanceof Date ? val.toLocaleDateString() : new Date(val).toLocaleDateString()
|
||||||
|
case FieldType.DATETIME:
|
||||||
|
return val instanceof Date ? val.toLocaleString() : new Date(val).toLocaleString()
|
||||||
|
case FieldType.BOOLEAN:
|
||||||
|
return val ? 'Yes' : 'No'
|
||||||
|
case FieldType.CURRENCY:
|
||||||
|
return `${props.field.prefix || '$'}${Number(val).toFixed(2)}${props.field.suffix || ''}`
|
||||||
|
case FieldType.SELECT:
|
||||||
|
const option = props.field.options?.find(opt => opt.value === val)
|
||||||
|
return option?.label || val
|
||||||
|
case FieldType.MULTI_SELECT:
|
||||||
|
if (!Array.isArray(val)) return '-'
|
||||||
|
return val.map(v => {
|
||||||
|
const opt = props.field.options?.find(o => o.value === v)
|
||||||
|
return opt?.label || v
|
||||||
|
}).join(', ')
|
||||||
|
default:
|
||||||
|
return String(val)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="field-renderer space-y-2">
|
||||||
|
<!-- Label (shown in edit and detail modes) -->
|
||||||
|
<Label v-if="!isListMode" :for="field.id" class="flex items-center gap-2">
|
||||||
|
{{ field.label }}
|
||||||
|
<span v-if="field.isRequired && isEditMode" class="text-destructive">*</span>
|
||||||
|
</Label>
|
||||||
|
|
||||||
|
<!-- Help Text -->
|
||||||
|
<p v-if="field.helpText && !isListMode" class="text-sm text-muted-foreground">
|
||||||
|
{{ field.helpText }}
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<!-- List View - Simple text display -->
|
||||||
|
<div v-if="isListMode" class="text-sm truncate">
|
||||||
|
<Badge v-if="field.type === FieldType.BOOLEAN" :variant="value ? 'default' : 'secondary'">
|
||||||
|
{{ formatValue(value) }}
|
||||||
|
</Badge>
|
||||||
|
<template v-else>
|
||||||
|
{{ formatValue(value) }}
|
||||||
|
</template>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Detail View - Formatted display -->
|
||||||
|
<div v-else-if="isDetailMode" class="space-y-1">
|
||||||
|
<div v-if="field.type === FieldType.BOOLEAN" class="flex items-center gap-2">
|
||||||
|
<Checkbox :checked="value" disabled />
|
||||||
|
<span class="text-sm">{{ formatValue(value) }}</span>
|
||||||
|
</div>
|
||||||
|
<div v-else-if="field.type === FieldType.MULTI_SELECT" class="flex flex-wrap gap-2">
|
||||||
|
<Badge v-for="(item, idx) in value" :key="idx" variant="secondary">
|
||||||
|
{{ props.field.options?.find(opt => opt.value === item)?.label || item }}
|
||||||
|
</Badge>
|
||||||
|
</div>
|
||||||
|
<div v-else-if="field.type === FieldType.URL && value" class="text-sm">
|
||||||
|
<a :href="value" target="_blank" class="text-primary hover:underline">
|
||||||
|
{{ value }}
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
<div v-else-if="field.type === FieldType.EMAIL && value" class="text-sm">
|
||||||
|
<a :href="`mailto:${value}`" class="text-primary hover:underline">
|
||||||
|
{{ value }}
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
<div v-else-if="field.type === FieldType.MARKDOWN && value" class="prose prose-sm">
|
||||||
|
<div v-html="value" />
|
||||||
|
</div>
|
||||||
|
<div v-else class="text-sm font-medium">
|
||||||
|
{{ formatValue(value) }}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Edit View - Input components -->
|
||||||
|
<div v-else-if="isEditMode && !isReadOnly">
|
||||||
|
<!-- Text Input -->
|
||||||
|
<Input
|
||||||
|
v-if="[FieldType.TEXT, FieldType.EMAIL, FieldType.URL, FieldType.PASSWORD].includes(field.type)"
|
||||||
|
:id="field.id"
|
||||||
|
v-model="value"
|
||||||
|
:type="field.type === FieldType.PASSWORD ? 'password' : field.type === FieldType.EMAIL ? 'email' : field.type === FieldType.URL ? 'url' : 'text'"
|
||||||
|
:placeholder="field.placeholder"
|
||||||
|
:required="field.isRequired"
|
||||||
|
:disabled="field.isReadOnly"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<!-- Textarea -->
|
||||||
|
<Textarea
|
||||||
|
v-else-if="field.type === FieldType.TEXTAREA || field.type === FieldType.MARKDOWN"
|
||||||
|
:id="field.id"
|
||||||
|
v-model="value"
|
||||||
|
:placeholder="field.placeholder"
|
||||||
|
:rows="field.rows || 4"
|
||||||
|
:required="field.isRequired"
|
||||||
|
:disabled="field.isReadOnly"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<!-- Number Input -->
|
||||||
|
<Input
|
||||||
|
v-else-if="[FieldType.NUMBER, FieldType.CURRENCY].includes(field.type)"
|
||||||
|
:id="field.id"
|
||||||
|
v-model.number="value"
|
||||||
|
type="number"
|
||||||
|
:placeholder="field.placeholder"
|
||||||
|
:min="field.min"
|
||||||
|
:max="field.max"
|
||||||
|
:step="field.step || (field.type === FieldType.CURRENCY ? 0.01 : 1)"
|
||||||
|
:required="field.isRequired"
|
||||||
|
:disabled="field.isReadOnly"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<!-- Select -->
|
||||||
|
<Select v-else-if="field.type === FieldType.SELECT" v-model="value">
|
||||||
|
<SelectTrigger :id="field.id">
|
||||||
|
<SelectValue :placeholder="field.placeholder || 'Select an option'" />
|
||||||
|
</SelectTrigger>
|
||||||
|
<SelectContent>
|
||||||
|
<SelectItem v-for="option in field.options" :key="String(option.value)" :value="String(option.value)">
|
||||||
|
{{ option.label }}
|
||||||
|
</SelectItem>
|
||||||
|
</SelectContent>
|
||||||
|
</Select>
|
||||||
|
|
||||||
|
<!-- Boolean - Checkbox -->
|
||||||
|
<div v-else-if="field.type === FieldType.BOOLEAN" class="flex items-center gap-2">
|
||||||
|
<Checkbox :id="field.id" v-model:checked="value" :disabled="field.isReadOnly" />
|
||||||
|
<Label :for="field.id" class="text-sm font-normal cursor-pointer">
|
||||||
|
{{ field.placeholder || field.label }}
|
||||||
|
</Label>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Date Picker -->
|
||||||
|
<DatePicker
|
||||||
|
v-else-if="[FieldType.DATE, FieldType.DATETIME].includes(field.type)"
|
||||||
|
v-model="value"
|
||||||
|
:placeholder="field.placeholder"
|
||||||
|
:disabled="field.isReadOnly"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<!-- Fallback -->
|
||||||
|
<Input
|
||||||
|
v-else
|
||||||
|
:id="field.id"
|
||||||
|
v-model="value"
|
||||||
|
:placeholder="field.placeholder"
|
||||||
|
:required="field.isRequired"
|
||||||
|
:disabled="field.isReadOnly"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Read-only Edit View -->
|
||||||
|
<div v-else-if="isEditMode && isReadOnly" class="text-sm text-muted-foreground">
|
||||||
|
{{ formatValue(value) }}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.field-renderer {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
17
frontend/components/ui/badge/Badge.vue
Normal file
17
frontend/components/ui/badge/Badge.vue
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import type { BadgeVariants } from "."
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
import { badgeVariants } from "."
|
||||||
|
|
||||||
|
const props = defineProps<{
|
||||||
|
variant?: BadgeVariants["variant"]
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
}>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div :class="cn(badgeVariants({ variant }), props.class)">
|
||||||
|
<slot />
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
26
frontend/components/ui/badge/index.ts
Normal file
26
frontend/components/ui/badge/index.ts
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
import type { VariantProps } from "class-variance-authority"
|
||||||
|
import { cva } from "class-variance-authority"
|
||||||
|
|
||||||
|
export { default as Badge } from "./Badge.vue"
|
||||||
|
|
||||||
|
export const badgeVariants = cva(
|
||||||
|
"inline-flex gap-1 items-center rounded-md border px-2.5 py-0.5 text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2",
|
||||||
|
{
|
||||||
|
variants: {
|
||||||
|
variant: {
|
||||||
|
default:
|
||||||
|
"border-transparent bg-primary text-primary-foreground shadow hover:bg-primary/80",
|
||||||
|
secondary:
|
||||||
|
"border-transparent bg-secondary text-secondary-foreground hover:bg-secondary/80",
|
||||||
|
destructive:
|
||||||
|
"border-transparent bg-destructive text-destructive-foreground shadow hover:bg-destructive/80",
|
||||||
|
outline: "text-foreground",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
defaultVariants: {
|
||||||
|
variant: "default",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
export type BadgeVariants = VariantProps<typeof badgeVariants>
|
||||||
58
frontend/components/ui/calendar/Calendar.vue
Normal file
58
frontend/components/ui/calendar/Calendar.vue
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
<script lang="ts" setup>
|
||||||
|
import type { CalendarRootEmits, CalendarRootProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { CalendarRoot, useForwardPropsEmits } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
import { CalendarCell, CalendarCellTrigger, CalendarGrid, CalendarGridBody, CalendarGridHead, CalendarGridRow, CalendarHeadCell, CalendarHeader, CalendarHeading, CalendarNextButton, CalendarPrevButton } from "."
|
||||||
|
|
||||||
|
const props = defineProps<CalendarRootProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const emits = defineEmits<CalendarRootEmits>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<CalendarRoot
|
||||||
|
v-slot="{ grid, weekDays }"
|
||||||
|
:class="cn('p-3', props.class)"
|
||||||
|
v-bind="forwarded"
|
||||||
|
>
|
||||||
|
<CalendarHeader>
|
||||||
|
<CalendarPrevButton />
|
||||||
|
<CalendarHeading />
|
||||||
|
<CalendarNextButton />
|
||||||
|
</CalendarHeader>
|
||||||
|
|
||||||
|
<div class="flex flex-col gap-y-4 mt-4 sm:flex-row sm:gap-x-4 sm:gap-y-0">
|
||||||
|
<CalendarGrid v-for="month in grid" :key="month.value.toString()">
|
||||||
|
<CalendarGridHead>
|
||||||
|
<CalendarGridRow>
|
||||||
|
<CalendarHeadCell
|
||||||
|
v-for="day in weekDays" :key="day"
|
||||||
|
>
|
||||||
|
{{ day }}
|
||||||
|
</CalendarHeadCell>
|
||||||
|
</CalendarGridRow>
|
||||||
|
</CalendarGridHead>
|
||||||
|
<CalendarGridBody>
|
||||||
|
<CalendarGridRow v-for="(weekDates, index) in month.rows" :key="`weekDate-${index}`" class="mt-2 w-full">
|
||||||
|
<CalendarCell
|
||||||
|
v-for="weekDate in weekDates"
|
||||||
|
:key="weekDate.toString()"
|
||||||
|
:date="weekDate"
|
||||||
|
>
|
||||||
|
<CalendarCellTrigger
|
||||||
|
:day="weekDate"
|
||||||
|
:month="month.value"
|
||||||
|
/>
|
||||||
|
</CalendarCell>
|
||||||
|
</CalendarGridRow>
|
||||||
|
</CalendarGridBody>
|
||||||
|
</CalendarGrid>
|
||||||
|
</div>
|
||||||
|
</CalendarRoot>
|
||||||
|
</template>
|
||||||
22
frontend/components/ui/calendar/CalendarCell.vue
Normal file
22
frontend/components/ui/calendar/CalendarCell.vue
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
<script lang="ts" setup>
|
||||||
|
import type { CalendarCellProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { CalendarCell, useForwardProps } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<CalendarCellProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwardedProps = useForwardProps(delegatedProps)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<CalendarCell
|
||||||
|
:class="cn('relative p-0 text-center text-sm focus-within:relative focus-within:z-20 [&:has([data-selected])]:rounded-md [&:has([data-selected])]:bg-accent [&:has([data-selected][data-outside-view])]:bg-accent/50', props.class)"
|
||||||
|
v-bind="forwardedProps"
|
||||||
|
>
|
||||||
|
<slot />
|
||||||
|
</CalendarCell>
|
||||||
|
</template>
|
||||||
36
frontend/components/ui/calendar/CalendarCellTrigger.vue
Normal file
36
frontend/components/ui/calendar/CalendarCellTrigger.vue
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
<script lang="ts" setup>
|
||||||
|
import type { CalendarCellTriggerProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { CalendarCellTrigger, useForwardProps } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
import { buttonVariants } from '@/components/ui/button'
|
||||||
|
|
||||||
|
const props = defineProps<CalendarCellTriggerProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwardedProps = useForwardProps(delegatedProps)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<CalendarCellTrigger
|
||||||
|
:class="cn(
|
||||||
|
buttonVariants({ variant: 'ghost' }),
|
||||||
|
'h-8 w-8 p-0 font-normal',
|
||||||
|
'[&[data-today]:not([data-selected])]:bg-accent [&[data-today]:not([data-selected])]:text-accent-foreground',
|
||||||
|
// Selected
|
||||||
|
'data-[selected]:bg-primary data-[selected]:text-primary-foreground data-[selected]:opacity-100 data-[selected]:hover:bg-primary data-[selected]:hover:text-primary-foreground data-[selected]:focus:bg-primary data-[selected]:focus:text-primary-foreground',
|
||||||
|
// Disabled
|
||||||
|
'data-[disabled]:text-muted-foreground data-[disabled]:opacity-50',
|
||||||
|
// Unavailable
|
||||||
|
'data-[unavailable]:text-destructive-foreground data-[unavailable]:line-through',
|
||||||
|
// Outside months
|
||||||
|
'data-[outside-view]:text-muted-foreground data-[outside-view]:opacity-50 [&[data-outside-view][data-selected]]:bg-accent/50 [&[data-outside-view][data-selected]]:text-muted-foreground [&[data-outside-view][data-selected]]:opacity-30',
|
||||||
|
props.class,
|
||||||
|
)"
|
||||||
|
v-bind="forwardedProps"
|
||||||
|
>
|
||||||
|
<slot />
|
||||||
|
</CalendarCellTrigger>
|
||||||
|
</template>
|
||||||
22
frontend/components/ui/calendar/CalendarGrid.vue
Normal file
22
frontend/components/ui/calendar/CalendarGrid.vue
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
<script lang="ts" setup>
|
||||||
|
import type { CalendarGridProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { CalendarGrid, useForwardProps } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<CalendarGridProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwardedProps = useForwardProps(delegatedProps)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<CalendarGrid
|
||||||
|
:class="cn('w-full border-collapse space-y-1', props.class)"
|
||||||
|
v-bind="forwardedProps"
|
||||||
|
>
|
||||||
|
<slot />
|
||||||
|
</CalendarGrid>
|
||||||
|
</template>
|
||||||
12
frontend/components/ui/calendar/CalendarGridBody.vue
Normal file
12
frontend/components/ui/calendar/CalendarGridBody.vue
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
<script lang="ts" setup>
|
||||||
|
import type { CalendarGridBodyProps } from "reka-ui"
|
||||||
|
import { CalendarGridBody } from "reka-ui"
|
||||||
|
|
||||||
|
const props = defineProps<CalendarGridBodyProps>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<CalendarGridBody v-bind="props">
|
||||||
|
<slot />
|
||||||
|
</CalendarGridBody>
|
||||||
|
</template>
|
||||||
13
frontend/components/ui/calendar/CalendarGridHead.vue
Normal file
13
frontend/components/ui/calendar/CalendarGridHead.vue
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
<script lang="ts" setup>
|
||||||
|
import type { CalendarGridHeadProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { CalendarGridHead } from "reka-ui"
|
||||||
|
|
||||||
|
const props = defineProps<CalendarGridHeadProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<CalendarGridHead v-bind="props">
|
||||||
|
<slot />
|
||||||
|
</CalendarGridHead>
|
||||||
|
</template>
|
||||||
19
frontend/components/ui/calendar/CalendarGridRow.vue
Normal file
19
frontend/components/ui/calendar/CalendarGridRow.vue
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
<script lang="ts" setup>
|
||||||
|
import type { CalendarGridRowProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { CalendarGridRow, useForwardProps } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<CalendarGridRowProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwardedProps = useForwardProps(delegatedProps)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<CalendarGridRow :class="cn('flex', props.class)" v-bind="forwardedProps">
|
||||||
|
<slot />
|
||||||
|
</CalendarGridRow>
|
||||||
|
</template>
|
||||||
19
frontend/components/ui/calendar/CalendarHeadCell.vue
Normal file
19
frontend/components/ui/calendar/CalendarHeadCell.vue
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
<script lang="ts" setup>
|
||||||
|
import type { CalendarHeadCellProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { CalendarHeadCell, useForwardProps } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<CalendarHeadCellProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwardedProps = useForwardProps(delegatedProps)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<CalendarHeadCell :class="cn('w-8 rounded-md text-[0.8rem] font-normal text-muted-foreground', props.class)" v-bind="forwardedProps">
|
||||||
|
<slot />
|
||||||
|
</CalendarHeadCell>
|
||||||
|
</template>
|
||||||
19
frontend/components/ui/calendar/CalendarHeader.vue
Normal file
19
frontend/components/ui/calendar/CalendarHeader.vue
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
<script lang="ts" setup>
|
||||||
|
import type { CalendarHeaderProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { CalendarHeader, useForwardProps } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<CalendarHeaderProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwardedProps = useForwardProps(delegatedProps)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<CalendarHeader :class="cn('relative flex w-full items-center justify-between pt-1', props.class)" v-bind="forwardedProps">
|
||||||
|
<slot />
|
||||||
|
</CalendarHeader>
|
||||||
|
</template>
|
||||||
29
frontend/components/ui/calendar/CalendarHeading.vue
Normal file
29
frontend/components/ui/calendar/CalendarHeading.vue
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
<script lang="ts" setup>
|
||||||
|
import type { CalendarHeadingProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { CalendarHeading, useForwardProps } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<CalendarHeadingProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
defineSlots<{
|
||||||
|
default: (props: { headingValue: string }) => any
|
||||||
|
}>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwardedProps = useForwardProps(delegatedProps)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<CalendarHeading
|
||||||
|
v-slot="{ headingValue }"
|
||||||
|
:class="cn('text-sm font-medium', props.class)"
|
||||||
|
v-bind="forwardedProps"
|
||||||
|
>
|
||||||
|
<slot :heading-value>
|
||||||
|
{{ headingValue }}
|
||||||
|
</slot>
|
||||||
|
</CalendarHeading>
|
||||||
|
</template>
|
||||||
30
frontend/components/ui/calendar/CalendarNextButton.vue
Normal file
30
frontend/components/ui/calendar/CalendarNextButton.vue
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
<script lang="ts" setup>
|
||||||
|
import type { CalendarNextProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { ChevronRight } from "lucide-vue-next"
|
||||||
|
import { CalendarNext, useForwardProps } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
import { buttonVariants } from '@/components/ui/button'
|
||||||
|
|
||||||
|
const props = defineProps<CalendarNextProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwardedProps = useForwardProps(delegatedProps)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<CalendarNext
|
||||||
|
:class="cn(
|
||||||
|
buttonVariants({ variant: 'outline' }),
|
||||||
|
'h-7 w-7 bg-transparent p-0 opacity-50 hover:opacity-100',
|
||||||
|
props.class,
|
||||||
|
)"
|
||||||
|
v-bind="forwardedProps"
|
||||||
|
>
|
||||||
|
<slot>
|
||||||
|
<ChevronRight class="h-4 w-4" />
|
||||||
|
</slot>
|
||||||
|
</CalendarNext>
|
||||||
|
</template>
|
||||||
30
frontend/components/ui/calendar/CalendarPrevButton.vue
Normal file
30
frontend/components/ui/calendar/CalendarPrevButton.vue
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
<script lang="ts" setup>
|
||||||
|
import type { CalendarPrevProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { ChevronLeft } from "lucide-vue-next"
|
||||||
|
import { CalendarPrev, useForwardProps } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
import { buttonVariants } from '@/components/ui/button'
|
||||||
|
|
||||||
|
const props = defineProps<CalendarPrevProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwardedProps = useForwardProps(delegatedProps)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<CalendarPrev
|
||||||
|
:class="cn(
|
||||||
|
buttonVariants({ variant: 'outline' }),
|
||||||
|
'h-7 w-7 bg-transparent p-0 opacity-50 hover:opacity-100',
|
||||||
|
props.class,
|
||||||
|
)"
|
||||||
|
v-bind="forwardedProps"
|
||||||
|
>
|
||||||
|
<slot>
|
||||||
|
<ChevronLeft class="h-4 w-4" />
|
||||||
|
</slot>
|
||||||
|
</CalendarPrev>
|
||||||
|
</template>
|
||||||
12
frontend/components/ui/calendar/index.ts
Normal file
12
frontend/components/ui/calendar/index.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
export { default as Calendar } from "./Calendar.vue"
|
||||||
|
export { default as CalendarCell } from "./CalendarCell.vue"
|
||||||
|
export { default as CalendarCellTrigger } from "./CalendarCellTrigger.vue"
|
||||||
|
export { default as CalendarGrid } from "./CalendarGrid.vue"
|
||||||
|
export { default as CalendarGridBody } from "./CalendarGridBody.vue"
|
||||||
|
export { default as CalendarGridHead } from "./CalendarGridHead.vue"
|
||||||
|
export { default as CalendarGridRow } from "./CalendarGridRow.vue"
|
||||||
|
export { default as CalendarHeadCell } from "./CalendarHeadCell.vue"
|
||||||
|
export { default as CalendarHeader } from "./CalendarHeader.vue"
|
||||||
|
export { default as CalendarHeading } from "./CalendarHeading.vue"
|
||||||
|
export { default as CalendarNextButton } from "./CalendarNextButton.vue"
|
||||||
|
export { default as CalendarPrevButton } from "./CalendarPrevButton.vue"
|
||||||
30
frontend/components/ui/checkbox/Checkbox.vue
Normal file
30
frontend/components/ui/checkbox/Checkbox.vue
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { CheckboxRootEmits, CheckboxRootProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { Check } from "lucide-vue-next"
|
||||||
|
import { CheckboxIndicator, CheckboxRoot, useForwardPropsEmits } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<CheckboxRootProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
const emits = defineEmits<CheckboxRootEmits>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<CheckboxRoot
|
||||||
|
v-bind="forwarded"
|
||||||
|
:class="
|
||||||
|
cn('grid place-content-center peer h-4 w-4 shrink-0 rounded-sm border border-primary shadow focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring disabled:cursor-not-allowed disabled:opacity-50 data-[state=checked]:bg-primary data-[state=checked]:text-primary-foreground',
|
||||||
|
props.class)"
|
||||||
|
>
|
||||||
|
<CheckboxIndicator class="grid place-content-center text-current">
|
||||||
|
<slot>
|
||||||
|
<Check class="h-4 w-4" />
|
||||||
|
</slot>
|
||||||
|
</CheckboxIndicator>
|
||||||
|
</CheckboxRoot>
|
||||||
|
</template>
|
||||||
1
frontend/components/ui/checkbox/index.ts
Normal file
1
frontend/components/ui/checkbox/index.ts
Normal file
@@ -0,0 +1 @@
|
|||||||
|
export { default as Checkbox } from "./Checkbox.vue"
|
||||||
86
frontend/components/ui/command/Command.vue
Normal file
86
frontend/components/ui/command/Command.vue
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { ListboxRootEmits, ListboxRootProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { ListboxRoot, useFilter, useForwardPropsEmits } from "reka-ui"
|
||||||
|
import { reactive, ref, watch } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
import { provideCommandContext } from "."
|
||||||
|
|
||||||
|
const props = withDefaults(defineProps<ListboxRootProps & { class?: HTMLAttributes["class"] }>(), {
|
||||||
|
modelValue: "",
|
||||||
|
})
|
||||||
|
|
||||||
|
const emits = defineEmits<ListboxRootEmits>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
||||||
|
|
||||||
|
const allItems = ref<Map<string, string>>(new Map())
|
||||||
|
const allGroups = ref<Map<string, Set<string>>>(new Map())
|
||||||
|
|
||||||
|
const { contains } = useFilter({ sensitivity: "base" })
|
||||||
|
const filterState = reactive({
|
||||||
|
search: "",
|
||||||
|
filtered: {
|
||||||
|
/** The count of all visible items. */
|
||||||
|
count: 0,
|
||||||
|
/** Map from visible item id to its search score. */
|
||||||
|
items: new Map() as Map<string, number>,
|
||||||
|
/** Set of groups with at least one visible item. */
|
||||||
|
groups: new Set() as Set<string>,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
function filterItems() {
|
||||||
|
if (!filterState.search) {
|
||||||
|
filterState.filtered.count = allItems.value.size
|
||||||
|
// Do nothing, each item will know to show itself because search is empty
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reset the groups
|
||||||
|
filterState.filtered.groups = new Set()
|
||||||
|
let itemCount = 0
|
||||||
|
|
||||||
|
// Check which items should be included
|
||||||
|
for (const [id, value] of allItems.value) {
|
||||||
|
const score = contains(value, filterState.search)
|
||||||
|
filterState.filtered.items.set(id, score ? 1 : 0)
|
||||||
|
if (score)
|
||||||
|
itemCount++
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check which groups have at least 1 item shown
|
||||||
|
for (const [groupId, group] of allGroups.value) {
|
||||||
|
for (const itemId of group) {
|
||||||
|
if (filterState.filtered.items.get(itemId)! > 0) {
|
||||||
|
filterState.filtered.groups.add(groupId)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
filterState.filtered.count = itemCount
|
||||||
|
}
|
||||||
|
|
||||||
|
watch(() => filterState.search, () => {
|
||||||
|
filterItems()
|
||||||
|
})
|
||||||
|
|
||||||
|
provideCommandContext({
|
||||||
|
allItems,
|
||||||
|
allGroups,
|
||||||
|
filterState,
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<ListboxRoot
|
||||||
|
v-bind="forwarded"
|
||||||
|
:class="cn('flex h-full w-full flex-col overflow-hidden rounded-md bg-popover text-popover-foreground', props.class)"
|
||||||
|
>
|
||||||
|
<slot />
|
||||||
|
</ListboxRoot>
|
||||||
|
</template>
|
||||||
21
frontend/components/ui/command/CommandDialog.vue
Normal file
21
frontend/components/ui/command/CommandDialog.vue
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { DialogRootEmits, DialogRootProps } from "reka-ui"
|
||||||
|
import { useForwardPropsEmits } from "reka-ui"
|
||||||
|
import { Dialog, DialogContent } from '@/components/ui/dialog'
|
||||||
|
import Command from "./Command.vue"
|
||||||
|
|
||||||
|
const props = defineProps<DialogRootProps>()
|
||||||
|
const emits = defineEmits<DialogRootEmits>()
|
||||||
|
|
||||||
|
const forwarded = useForwardPropsEmits(props, emits)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<Dialog v-bind="forwarded">
|
||||||
|
<DialogContent class="overflow-hidden p-0 shadow-lg">
|
||||||
|
<Command class="[&_[cmdk-group-heading]]:px-2 [&_[cmdk-group-heading]]:font-medium [&_[cmdk-group-heading]]:text-muted-foreground [&_[cmdk-group]:not([hidden])_~[cmdk-group]]:pt-0 [&_[cmdk-group]]:px-2 [&_[cmdk-input-wrapper]_svg]:h-5 [&_[cmdk-input-wrapper]_svg]:w-5 [&_[cmdk-input]]:h-12 [&_[cmdk-item]]:px-2 [&_[cmdk-item]]:py-3 [&_[cmdk-item]_svg]:h-5 [&_[cmdk-item]_svg]:w-5">
|
||||||
|
<slot />
|
||||||
|
</Command>
|
||||||
|
</DialogContent>
|
||||||
|
</Dialog>
|
||||||
|
</template>
|
||||||
23
frontend/components/ui/command/CommandEmpty.vue
Normal file
23
frontend/components/ui/command/CommandEmpty.vue
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { PrimitiveProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { Primitive } from "reka-ui"
|
||||||
|
import { computed } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
import { useCommand } from "."
|
||||||
|
|
||||||
|
const props = defineProps<PrimitiveProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const { filterState } = useCommand()
|
||||||
|
const isRender = computed(() => !!filterState.search && filterState.filtered.count === 0,
|
||||||
|
)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<Primitive v-if="isRender" v-bind="delegatedProps" :class="cn('py-6 text-center text-sm', props.class)">
|
||||||
|
<slot />
|
||||||
|
</Primitive>
|
||||||
|
</template>
|
||||||
44
frontend/components/ui/command/CommandGroup.vue
Normal file
44
frontend/components/ui/command/CommandGroup.vue
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { ListboxGroupProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { ListboxGroup, ListboxGroupLabel, useId } from "reka-ui"
|
||||||
|
import { computed, onMounted, onUnmounted } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
import { provideCommandGroupContext, useCommand } from "."
|
||||||
|
|
||||||
|
const props = defineProps<ListboxGroupProps & {
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
heading?: string
|
||||||
|
}>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const { allGroups, filterState } = useCommand()
|
||||||
|
const id = useId()
|
||||||
|
|
||||||
|
const isRender = computed(() => !filterState.search ? true : filterState.filtered.groups.has(id))
|
||||||
|
|
||||||
|
provideCommandGroupContext({ id })
|
||||||
|
onMounted(() => {
|
||||||
|
if (!allGroups.value.has(id))
|
||||||
|
allGroups.value.set(id, new Set())
|
||||||
|
})
|
||||||
|
onUnmounted(() => {
|
||||||
|
allGroups.value.delete(id)
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<ListboxGroup
|
||||||
|
v-bind="delegatedProps"
|
||||||
|
:id="id"
|
||||||
|
:class="cn('overflow-hidden p-1 text-foreground [&_[cmdk-group-heading]]:px-2 [&_[cmdk-group-heading]]:py-1.5 [&_[cmdk-group-heading]]:text-xs [&_[cmdk-group-heading]]:font-medium [&_[cmdk-group-heading]]:text-muted-foreground', props.class)"
|
||||||
|
:hidden="isRender ? undefined : true"
|
||||||
|
>
|
||||||
|
<ListboxGroupLabel v-if="heading" class="px-2 py-1.5 text-xs font-medium text-muted-foreground">
|
||||||
|
{{ heading }}
|
||||||
|
</ListboxGroupLabel>
|
||||||
|
<slot />
|
||||||
|
</ListboxGroup>
|
||||||
|
</template>
|
||||||
35
frontend/components/ui/command/CommandInput.vue
Normal file
35
frontend/components/ui/command/CommandInput.vue
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { ListboxFilterProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { Search } from "lucide-vue-next"
|
||||||
|
import { ListboxFilter, useForwardProps } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
import { useCommand } from "."
|
||||||
|
|
||||||
|
defineOptions({
|
||||||
|
inheritAttrs: false,
|
||||||
|
})
|
||||||
|
|
||||||
|
const props = defineProps<ListboxFilterProps & {
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
}>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwardedProps = useForwardProps(delegatedProps)
|
||||||
|
|
||||||
|
const { filterState } = useCommand()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="flex items-center border-b px-3" cmdk-input-wrapper>
|
||||||
|
<Search class="mr-2 h-4 w-4 shrink-0 opacity-50" />
|
||||||
|
<ListboxFilter
|
||||||
|
v-bind="{ ...forwardedProps, ...$attrs }"
|
||||||
|
v-model="filterState.search"
|
||||||
|
auto-focus
|
||||||
|
:class="cn('flex h-10 w-full rounded-md bg-transparent py-3 text-sm outline-none placeholder:text-muted-foreground disabled:cursor-not-allowed disabled:opacity-50', props.class)"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
75
frontend/components/ui/command/CommandItem.vue
Normal file
75
frontend/components/ui/command/CommandItem.vue
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { ListboxItemEmits, ListboxItemProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit, useCurrentElement } from "@vueuse/core"
|
||||||
|
import { ListboxItem, useForwardPropsEmits, useId } from "reka-ui"
|
||||||
|
import { computed, onMounted, onUnmounted, ref } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
import { useCommand, useCommandGroup } from "."
|
||||||
|
|
||||||
|
const props = defineProps<ListboxItemProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
const emits = defineEmits<ListboxItemEmits>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
||||||
|
|
||||||
|
const id = useId()
|
||||||
|
const { filterState, allItems, allGroups } = useCommand()
|
||||||
|
const groupContext = useCommandGroup()
|
||||||
|
|
||||||
|
const isRender = computed(() => {
|
||||||
|
if (!filterState.search) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
const filteredCurrentItem = filterState.filtered.items.get(id)
|
||||||
|
// If the filtered items is undefined means not in the all times map yet
|
||||||
|
// Do the first render to add into the map
|
||||||
|
if (filteredCurrentItem === undefined) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check with filter
|
||||||
|
return filteredCurrentItem > 0
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
const itemRef = ref()
|
||||||
|
const currentElement = useCurrentElement(itemRef)
|
||||||
|
onMounted(() => {
|
||||||
|
if (!(currentElement.value instanceof HTMLElement))
|
||||||
|
return
|
||||||
|
|
||||||
|
// textValue to perform filter
|
||||||
|
allItems.value.set(id, currentElement.value.textContent ?? props?.value!.toString())
|
||||||
|
|
||||||
|
const groupId = groupContext?.id
|
||||||
|
if (groupId) {
|
||||||
|
if (!allGroups.value.has(groupId)) {
|
||||||
|
allGroups.value.set(groupId, new Set([id]))
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
allGroups.value.get(groupId)?.add(id)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
onUnmounted(() => {
|
||||||
|
allItems.value.delete(id)
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<ListboxItem
|
||||||
|
v-if="isRender"
|
||||||
|
v-bind="forwarded"
|
||||||
|
:id="id"
|
||||||
|
ref="itemRef"
|
||||||
|
:class="cn('relative flex cursor-default gap-2 select-none items-center rounded-sm px-2 py-1.5 text-sm outline-none data-[highlighted]:bg-accent data-[highlighted]:text-accent-foreground data-[disabled]:pointer-events-none data-[disabled]:opacity-50 [&_svg]:size-4 [&_svg]:shrink-0', props.class)"
|
||||||
|
@select="() => {
|
||||||
|
filterState.search = ''
|
||||||
|
}"
|
||||||
|
>
|
||||||
|
<slot />
|
||||||
|
</ListboxItem>
|
||||||
|
</template>
|
||||||
21
frontend/components/ui/command/CommandList.vue
Normal file
21
frontend/components/ui/command/CommandList.vue
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { ListboxContentProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { ListboxContent, useForwardProps } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<ListboxContentProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwarded = useForwardProps(delegatedProps)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<ListboxContent v-bind="forwarded" :class="cn('max-h-[300px] overflow-y-auto overflow-x-hidden', props.class)">
|
||||||
|
<div role="presentation">
|
||||||
|
<slot />
|
||||||
|
</div>
|
||||||
|
</ListboxContent>
|
||||||
|
</template>
|
||||||
20
frontend/components/ui/command/CommandSeparator.vue
Normal file
20
frontend/components/ui/command/CommandSeparator.vue
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { SeparatorProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { Separator } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<SeparatorProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<Separator
|
||||||
|
v-bind="delegatedProps"
|
||||||
|
:class="cn('-mx-1 h-px bg-border', props.class)"
|
||||||
|
>
|
||||||
|
<slot />
|
||||||
|
</Separator>
|
||||||
|
</template>
|
||||||
14
frontend/components/ui/command/CommandShortcut.vue
Normal file
14
frontend/components/ui/command/CommandShortcut.vue
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<{
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
}>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<span :class="cn('ml-auto text-xs tracking-widest text-muted-foreground', props.class)">
|
||||||
|
<slot />
|
||||||
|
</span>
|
||||||
|
</template>
|
||||||
25
frontend/components/ui/command/index.ts
Normal file
25
frontend/components/ui/command/index.ts
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
import type { Ref } from "vue"
|
||||||
|
import { createContext } from "reka-ui"
|
||||||
|
|
||||||
|
export { default as Command } from "./Command.vue"
|
||||||
|
export { default as CommandDialog } from "./CommandDialog.vue"
|
||||||
|
export { default as CommandEmpty } from "./CommandEmpty.vue"
|
||||||
|
export { default as CommandGroup } from "./CommandGroup.vue"
|
||||||
|
export { default as CommandInput } from "./CommandInput.vue"
|
||||||
|
export { default as CommandItem } from "./CommandItem.vue"
|
||||||
|
export { default as CommandList } from "./CommandList.vue"
|
||||||
|
export { default as CommandSeparator } from "./CommandSeparator.vue"
|
||||||
|
export { default as CommandShortcut } from "./CommandShortcut.vue"
|
||||||
|
|
||||||
|
export const [useCommand, provideCommandContext] = createContext<{
|
||||||
|
allItems: Ref<Map<string, string>>
|
||||||
|
allGroups: Ref<Map<string, Set<string>>>
|
||||||
|
filterState: {
|
||||||
|
search: string
|
||||||
|
filtered: { count: number, items: Map<string, number>, groups: Set<string> }
|
||||||
|
}
|
||||||
|
}>("Command")
|
||||||
|
|
||||||
|
export const [useCommandGroup, provideCommandGroupContext] = createContext<{
|
||||||
|
id?: string
|
||||||
|
}>("CommandGroup")
|
||||||
64
frontend/components/ui/date-picker/DatePicker.vue
Normal file
64
frontend/components/ui/date-picker/DatePicker.vue
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import { ref, computed } from 'vue'
|
||||||
|
import { Calendar } from '@/components/ui/calendar'
|
||||||
|
import { Button } from '@/components/ui/button'
|
||||||
|
import { Popover, PopoverContent, PopoverTrigger } from '@/components/ui/popover'
|
||||||
|
import { CalendarIcon } from 'lucide-vue-next'
|
||||||
|
import { cn } from '@/lib/utils'
|
||||||
|
|
||||||
|
interface Props {
|
||||||
|
modelValue?: Date | string | null
|
||||||
|
placeholder?: string
|
||||||
|
disabled?: boolean
|
||||||
|
format?: string
|
||||||
|
}
|
||||||
|
|
||||||
|
const props = withDefaults(defineProps<Props>(), {
|
||||||
|
placeholder: 'Pick a date',
|
||||||
|
format: 'PPP',
|
||||||
|
})
|
||||||
|
|
||||||
|
const emit = defineEmits<{
|
||||||
|
'update:modelValue': [value: Date | null]
|
||||||
|
}>()
|
||||||
|
|
||||||
|
const value = computed({
|
||||||
|
get: () => {
|
||||||
|
if (!props.modelValue) return undefined
|
||||||
|
return props.modelValue instanceof Date ? props.modelValue : new Date(props.modelValue)
|
||||||
|
},
|
||||||
|
set: (date) => {
|
||||||
|
emit('update:modelValue', date || null)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
const formatDate = (date: Date | undefined) => {
|
||||||
|
if (!date) return props.placeholder
|
||||||
|
return date.toLocaleDateString('en-US', {
|
||||||
|
year: 'numeric',
|
||||||
|
month: 'long',
|
||||||
|
day: 'numeric',
|
||||||
|
})
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<Popover>
|
||||||
|
<PopoverTrigger as-child>
|
||||||
|
<Button
|
||||||
|
variant="outline"
|
||||||
|
:class="cn(
|
||||||
|
'w-full justify-start text-left font-normal',
|
||||||
|
!value && 'text-muted-foreground'
|
||||||
|
)"
|
||||||
|
:disabled="disabled"
|
||||||
|
>
|
||||||
|
<CalendarIcon class="mr-2 h-4 w-4" />
|
||||||
|
{{ formatDate(value) }}
|
||||||
|
</Button>
|
||||||
|
</PopoverTrigger>
|
||||||
|
<PopoverContent class="w-auto p-0">
|
||||||
|
<Calendar v-model="value" initial-focus />
|
||||||
|
</PopoverContent>
|
||||||
|
</Popover>
|
||||||
|
</template>
|
||||||
1
frontend/components/ui/date-picker/index.ts
Normal file
1
frontend/components/ui/date-picker/index.ts
Normal file
@@ -0,0 +1 @@
|
|||||||
|
export { default as DatePicker } from './DatePicker.vue'
|
||||||
15
frontend/components/ui/dialog/Dialog.vue
Normal file
15
frontend/components/ui/dialog/Dialog.vue
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { DialogRootEmits, DialogRootProps } from "reka-ui"
|
||||||
|
import { DialogRoot, useForwardPropsEmits } from "reka-ui"
|
||||||
|
|
||||||
|
const props = defineProps<DialogRootProps>()
|
||||||
|
const emits = defineEmits<DialogRootEmits>()
|
||||||
|
|
||||||
|
const forwarded = useForwardPropsEmits(props, emits)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<DialogRoot v-bind="forwarded">
|
||||||
|
<slot />
|
||||||
|
</DialogRoot>
|
||||||
|
</template>
|
||||||
12
frontend/components/ui/dialog/DialogClose.vue
Normal file
12
frontend/components/ui/dialog/DialogClose.vue
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { DialogCloseProps } from "reka-ui"
|
||||||
|
import { DialogClose } from "reka-ui"
|
||||||
|
|
||||||
|
const props = defineProps<DialogCloseProps>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<DialogClose v-bind="props">
|
||||||
|
<slot />
|
||||||
|
</DialogClose>
|
||||||
|
</template>
|
||||||
46
frontend/components/ui/dialog/DialogContent.vue
Normal file
46
frontend/components/ui/dialog/DialogContent.vue
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { DialogContentEmits, DialogContentProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { X } from "lucide-vue-next"
|
||||||
|
import {
|
||||||
|
DialogClose,
|
||||||
|
DialogContent,
|
||||||
|
DialogOverlay,
|
||||||
|
DialogPortal,
|
||||||
|
useForwardPropsEmits,
|
||||||
|
} from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<DialogContentProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
const emits = defineEmits<DialogContentEmits>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<DialogPortal>
|
||||||
|
<DialogOverlay
|
||||||
|
class="fixed inset-0 z-50 bg-black/80 data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0"
|
||||||
|
/>
|
||||||
|
<DialogContent
|
||||||
|
v-bind="forwarded"
|
||||||
|
:class="
|
||||||
|
cn(
|
||||||
|
'fixed left-1/2 top-1/2 z-50 grid w-full max-w-lg -translate-x-1/2 -translate-y-1/2 gap-4 border bg-background p-6 shadow-lg duration-200 data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[state=closed]:slide-out-to-left-1/2 data-[state=closed]:slide-out-to-top-[48%] data-[state=open]:slide-in-from-left-1/2 data-[state=open]:slide-in-from-top-[48%] sm:rounded-lg',
|
||||||
|
props.class,
|
||||||
|
)"
|
||||||
|
>
|
||||||
|
<slot />
|
||||||
|
|
||||||
|
<DialogClose
|
||||||
|
class="absolute right-4 top-4 rounded-sm opacity-70 ring-offset-background transition-opacity hover:opacity-100 focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2 disabled:pointer-events-none data-[state=open]:bg-accent data-[state=open]:text-muted-foreground"
|
||||||
|
>
|
||||||
|
<X class="w-4 h-4" />
|
||||||
|
<span class="sr-only">Close</span>
|
||||||
|
</DialogClose>
|
||||||
|
</DialogContent>
|
||||||
|
</DialogPortal>
|
||||||
|
</template>
|
||||||
22
frontend/components/ui/dialog/DialogDescription.vue
Normal file
22
frontend/components/ui/dialog/DialogDescription.vue
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { DialogDescriptionProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { DialogDescription, useForwardProps } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<DialogDescriptionProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwardedProps = useForwardProps(delegatedProps)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<DialogDescription
|
||||||
|
v-bind="forwardedProps"
|
||||||
|
:class="cn('text-sm text-muted-foreground', props.class)"
|
||||||
|
>
|
||||||
|
<slot />
|
||||||
|
</DialogDescription>
|
||||||
|
</template>
|
||||||
19
frontend/components/ui/dialog/DialogFooter.vue
Normal file
19
frontend/components/ui/dialog/DialogFooter.vue
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<{ class?: HTMLAttributes["class"] }>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div
|
||||||
|
:class="
|
||||||
|
cn(
|
||||||
|
'flex flex-col-reverse sm:flex-row sm:justify-end sm:gap-x-2',
|
||||||
|
props.class,
|
||||||
|
)
|
||||||
|
"
|
||||||
|
>
|
||||||
|
<slot />
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
16
frontend/components/ui/dialog/DialogHeader.vue
Normal file
16
frontend/components/ui/dialog/DialogHeader.vue
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<{
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
}>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div
|
||||||
|
:class="cn('flex flex-col gap-y-1.5 text-center sm:text-left', props.class)"
|
||||||
|
>
|
||||||
|
<slot />
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
55
frontend/components/ui/dialog/DialogScrollContent.vue
Normal file
55
frontend/components/ui/dialog/DialogScrollContent.vue
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { DialogContentEmits, DialogContentProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { X } from "lucide-vue-next"
|
||||||
|
import {
|
||||||
|
DialogClose,
|
||||||
|
DialogContent,
|
||||||
|
DialogOverlay,
|
||||||
|
DialogPortal,
|
||||||
|
useForwardPropsEmits,
|
||||||
|
} from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<DialogContentProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
const emits = defineEmits<DialogContentEmits>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<DialogPortal>
|
||||||
|
<DialogOverlay
|
||||||
|
class="fixed inset-0 z-50 grid place-items-center overflow-y-auto bg-black/80 data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0"
|
||||||
|
>
|
||||||
|
<DialogContent
|
||||||
|
:class="
|
||||||
|
cn(
|
||||||
|
'relative z-50 grid w-full max-w-lg my-8 gap-4 border border-border bg-background p-6 shadow-lg duration-200 sm:rounded-lg md:w-full',
|
||||||
|
props.class,
|
||||||
|
)
|
||||||
|
"
|
||||||
|
v-bind="forwarded"
|
||||||
|
@pointer-down-outside="(event) => {
|
||||||
|
const originalEvent = event.detail.originalEvent;
|
||||||
|
const target = originalEvent.target as HTMLElement;
|
||||||
|
if (originalEvent.offsetX > target.clientWidth || originalEvent.offsetY > target.clientHeight) {
|
||||||
|
event.preventDefault();
|
||||||
|
}
|
||||||
|
}"
|
||||||
|
>
|
||||||
|
<slot />
|
||||||
|
|
||||||
|
<DialogClose
|
||||||
|
class="absolute top-4 right-4 p-0.5 transition-colors rounded-md hover:bg-secondary"
|
||||||
|
>
|
||||||
|
<X class="w-4 h-4" />
|
||||||
|
<span class="sr-only">Close</span>
|
||||||
|
</DialogClose>
|
||||||
|
</DialogContent>
|
||||||
|
</DialogOverlay>
|
||||||
|
</DialogPortal>
|
||||||
|
</template>
|
||||||
27
frontend/components/ui/dialog/DialogTitle.vue
Normal file
27
frontend/components/ui/dialog/DialogTitle.vue
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { DialogTitleProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { DialogTitle, useForwardProps } from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<DialogTitleProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwardedProps = useForwardProps(delegatedProps)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<DialogTitle
|
||||||
|
v-bind="forwardedProps"
|
||||||
|
:class="
|
||||||
|
cn(
|
||||||
|
'text-lg font-semibold leading-none tracking-tight',
|
||||||
|
props.class,
|
||||||
|
)
|
||||||
|
"
|
||||||
|
>
|
||||||
|
<slot />
|
||||||
|
</DialogTitle>
|
||||||
|
</template>
|
||||||
12
frontend/components/ui/dialog/DialogTrigger.vue
Normal file
12
frontend/components/ui/dialog/DialogTrigger.vue
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { DialogTriggerProps } from "reka-ui"
|
||||||
|
import { DialogTrigger } from "reka-ui"
|
||||||
|
|
||||||
|
const props = defineProps<DialogTriggerProps>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<DialogTrigger v-bind="props">
|
||||||
|
<slot />
|
||||||
|
</DialogTrigger>
|
||||||
|
</template>
|
||||||
9
frontend/components/ui/dialog/index.ts
Normal file
9
frontend/components/ui/dialog/index.ts
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
export { default as Dialog } from "./Dialog.vue"
|
||||||
|
export { default as DialogClose } from "./DialogClose.vue"
|
||||||
|
export { default as DialogContent } from "./DialogContent.vue"
|
||||||
|
export { default as DialogDescription } from "./DialogDescription.vue"
|
||||||
|
export { default as DialogFooter } from "./DialogFooter.vue"
|
||||||
|
export { default as DialogHeader } from "./DialogHeader.vue"
|
||||||
|
export { default as DialogScrollContent } from "./DialogScrollContent.vue"
|
||||||
|
export { default as DialogTitle } from "./DialogTitle.vue"
|
||||||
|
export { default as DialogTrigger } from "./DialogTrigger.vue"
|
||||||
15
frontend/components/ui/popover/Popover.vue
Normal file
15
frontend/components/ui/popover/Popover.vue
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { PopoverRootEmits, PopoverRootProps } from "reka-ui"
|
||||||
|
import { PopoverRoot, useForwardPropsEmits } from "reka-ui"
|
||||||
|
|
||||||
|
const props = defineProps<PopoverRootProps>()
|
||||||
|
const emits = defineEmits<PopoverRootEmits>()
|
||||||
|
|
||||||
|
const forwarded = useForwardPropsEmits(props, emits)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<PopoverRoot v-bind="forwarded">
|
||||||
|
<slot />
|
||||||
|
</PopoverRoot>
|
||||||
|
</template>
|
||||||
44
frontend/components/ui/popover/PopoverContent.vue
Normal file
44
frontend/components/ui/popover/PopoverContent.vue
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { PopoverContentEmits, PopoverContentProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import {
|
||||||
|
PopoverContent,
|
||||||
|
PopoverPortal,
|
||||||
|
useForwardPropsEmits,
|
||||||
|
} from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
defineOptions({
|
||||||
|
inheritAttrs: false,
|
||||||
|
})
|
||||||
|
|
||||||
|
const props = withDefaults(
|
||||||
|
defineProps<PopoverContentProps & { class?: HTMLAttributes["class"] }>(),
|
||||||
|
{
|
||||||
|
align: "center",
|
||||||
|
sideOffset: 4,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
const emits = defineEmits<PopoverContentEmits>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<PopoverPortal>
|
||||||
|
<PopoverContent
|
||||||
|
v-bind="{ ...forwarded, ...$attrs }"
|
||||||
|
:class="
|
||||||
|
cn(
|
||||||
|
'z-50 w-72 rounded-md border bg-popover p-4 text-popover-foreground shadow-md outline-none data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2',
|
||||||
|
props.class,
|
||||||
|
)
|
||||||
|
"
|
||||||
|
>
|
||||||
|
<slot />
|
||||||
|
</PopoverContent>
|
||||||
|
</PopoverPortal>
|
||||||
|
</template>
|
||||||
12
frontend/components/ui/popover/PopoverTrigger.vue
Normal file
12
frontend/components/ui/popover/PopoverTrigger.vue
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { PopoverTriggerProps } from "reka-ui"
|
||||||
|
import { PopoverTrigger } from "reka-ui"
|
||||||
|
|
||||||
|
const props = defineProps<PopoverTriggerProps>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<PopoverTrigger v-bind="props">
|
||||||
|
<slot />
|
||||||
|
</PopoverTrigger>
|
||||||
|
</template>
|
||||||
4
frontend/components/ui/popover/index.ts
Normal file
4
frontend/components/ui/popover/index.ts
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
export { default as Popover } from "./Popover.vue"
|
||||||
|
export { default as PopoverContent } from "./PopoverContent.vue"
|
||||||
|
export { default as PopoverTrigger } from "./PopoverTrigger.vue"
|
||||||
|
export { PopoverAnchor } from "reka-ui"
|
||||||
35
frontend/components/ui/switch/Switch.vue
Normal file
35
frontend/components/ui/switch/Switch.vue
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { SwitchRootEmits, SwitchRootProps } from "reka-ui"
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import {
|
||||||
|
SwitchRoot,
|
||||||
|
SwitchThumb,
|
||||||
|
useForwardPropsEmits,
|
||||||
|
} from "reka-ui"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<SwitchRootProps & { class?: HTMLAttributes["class"] }>()
|
||||||
|
|
||||||
|
const emits = defineEmits<SwitchRootEmits>()
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
|
||||||
|
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<SwitchRoot
|
||||||
|
v-bind="forwarded"
|
||||||
|
:class="cn(
|
||||||
|
'peer inline-flex h-5 w-9 shrink-0 cursor-pointer items-center rounded-full border-2 border-transparent shadow-sm transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 focus-visible:ring-offset-background disabled:cursor-not-allowed disabled:opacity-50 data-[state=checked]:bg-primary data-[state=unchecked]:bg-input',
|
||||||
|
props.class,
|
||||||
|
)"
|
||||||
|
>
|
||||||
|
<SwitchThumb
|
||||||
|
:class="cn('pointer-events-none block h-4 w-4 rounded-full bg-background shadow-lg ring-0 transition-transform data-[state=checked]:translate-x-4 data-[state=unchecked]:translate-x-0')"
|
||||||
|
>
|
||||||
|
<slot name="thumb" />
|
||||||
|
</SwitchThumb>
|
||||||
|
</SwitchRoot>
|
||||||
|
</template>
|
||||||
1
frontend/components/ui/switch/index.ts
Normal file
1
frontend/components/ui/switch/index.ts
Normal file
@@ -0,0 +1 @@
|
|||||||
|
export { default as Switch } from "./Switch.vue"
|
||||||
16
frontend/components/ui/table/Table.vue
Normal file
16
frontend/components/ui/table/Table.vue
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<{
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
}>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="relative w-full overflow-auto">
|
||||||
|
<table :class="cn('w-full caption-bottom text-sm', props.class)">
|
||||||
|
<slot />
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
14
frontend/components/ui/table/TableBody.vue
Normal file
14
frontend/components/ui/table/TableBody.vue
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<{
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
}>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<tbody :class="cn('[&_tr:last-child]:border-0', props.class)">
|
||||||
|
<slot />
|
||||||
|
</tbody>
|
||||||
|
</template>
|
||||||
14
frontend/components/ui/table/TableCaption.vue
Normal file
14
frontend/components/ui/table/TableCaption.vue
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<{
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
}>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<caption :class="cn('mt-4 text-sm text-muted-foreground', props.class)">
|
||||||
|
<slot />
|
||||||
|
</caption>
|
||||||
|
</template>
|
||||||
21
frontend/components/ui/table/TableCell.vue
Normal file
21
frontend/components/ui/table/TableCell.vue
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<{
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
}>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<td
|
||||||
|
:class="
|
||||||
|
cn(
|
||||||
|
'p-2 align-middle [&:has([role=checkbox])]:pr-0 [&>[role=checkbox]]:translate-y-0.5',
|
||||||
|
props.class,
|
||||||
|
)
|
||||||
|
"
|
||||||
|
>
|
||||||
|
<slot />
|
||||||
|
</td>
|
||||||
|
</template>
|
||||||
34
frontend/components/ui/table/TableEmpty.vue
Normal file
34
frontend/components/ui/table/TableEmpty.vue
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { reactiveOmit } from "@vueuse/core"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
import TableCell from "./TableCell.vue"
|
||||||
|
import TableRow from "./TableRow.vue"
|
||||||
|
|
||||||
|
const props = withDefaults(defineProps<{
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
colspan?: number
|
||||||
|
}>(), {
|
||||||
|
colspan: 1,
|
||||||
|
})
|
||||||
|
|
||||||
|
const delegatedProps = reactiveOmit(props, "class")
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<TableRow>
|
||||||
|
<TableCell
|
||||||
|
:class="
|
||||||
|
cn(
|
||||||
|
'p-4 whitespace-nowrap align-middle text-sm text-foreground',
|
||||||
|
props.class,
|
||||||
|
)
|
||||||
|
"
|
||||||
|
v-bind="delegatedProps"
|
||||||
|
>
|
||||||
|
<div class="flex items-center justify-center py-10">
|
||||||
|
<slot />
|
||||||
|
</div>
|
||||||
|
</TableCell>
|
||||||
|
</TableRow>
|
||||||
|
</template>
|
||||||
14
frontend/components/ui/table/TableFooter.vue
Normal file
14
frontend/components/ui/table/TableFooter.vue
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<{
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
}>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<tfoot :class="cn('border-t bg-muted/50 font-medium [&>tr]:last:border-b-0', props.class)">
|
||||||
|
<slot />
|
||||||
|
</tfoot>
|
||||||
|
</template>
|
||||||
14
frontend/components/ui/table/TableHead.vue
Normal file
14
frontend/components/ui/table/TableHead.vue
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<{
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
}>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<th :class="cn('h-10 px-2 text-left align-middle font-medium text-muted-foreground [&:has([role=checkbox])]:pr-0 [&>[role=checkbox]]:translate-y-0.5', props.class)">
|
||||||
|
<slot />
|
||||||
|
</th>
|
||||||
|
</template>
|
||||||
14
frontend/components/ui/table/TableHeader.vue
Normal file
14
frontend/components/ui/table/TableHeader.vue
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<{
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
}>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<thead :class="cn('[&_tr]:border-b', props.class)">
|
||||||
|
<slot />
|
||||||
|
</thead>
|
||||||
|
</template>
|
||||||
14
frontend/components/ui/table/TableRow.vue
Normal file
14
frontend/components/ui/table/TableRow.vue
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<{
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
}>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<tr :class="cn('border-b transition-colors hover:bg-muted/50 data-[state=selected]:bg-muted', props.class)">
|
||||||
|
<slot />
|
||||||
|
</tr>
|
||||||
|
</template>
|
||||||
9
frontend/components/ui/table/index.ts
Normal file
9
frontend/components/ui/table/index.ts
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
export { default as Table } from "./Table.vue"
|
||||||
|
export { default as TableBody } from "./TableBody.vue"
|
||||||
|
export { default as TableCaption } from "./TableCaption.vue"
|
||||||
|
export { default as TableCell } from "./TableCell.vue"
|
||||||
|
export { default as TableEmpty } from "./TableEmpty.vue"
|
||||||
|
export { default as TableFooter } from "./TableFooter.vue"
|
||||||
|
export { default as TableHead } from "./TableHead.vue"
|
||||||
|
export { default as TableHeader } from "./TableHeader.vue"
|
||||||
|
export { default as TableRow } from "./TableRow.vue"
|
||||||
24
frontend/components/ui/textarea/Textarea.vue
Normal file
24
frontend/components/ui/textarea/Textarea.vue
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import type { HTMLAttributes } from "vue"
|
||||||
|
import { useVModel } from "@vueuse/core"
|
||||||
|
import { cn } from "@/lib/utils"
|
||||||
|
|
||||||
|
const props = defineProps<{
|
||||||
|
class?: HTMLAttributes["class"]
|
||||||
|
defaultValue?: string | number
|
||||||
|
modelValue?: string | number
|
||||||
|
}>()
|
||||||
|
|
||||||
|
const emits = defineEmits<{
|
||||||
|
(e: "update:modelValue", payload: string | number): void
|
||||||
|
}>()
|
||||||
|
|
||||||
|
const modelValue = useVModel(props, "modelValue", emits, {
|
||||||
|
passive: true,
|
||||||
|
defaultValue: props.defaultValue,
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<textarea v-model="modelValue" :class="cn('flex min-h-[60px] w-full rounded-md border border-input bg-transparent px-3 py-2 text-sm shadow-sm placeholder:text-muted-foreground focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring disabled:cursor-not-allowed disabled:opacity-50', props.class)" />
|
||||||
|
</template>
|
||||||
1
frontend/components/ui/textarea/index.ts
Normal file
1
frontend/components/ui/textarea/index.ts
Normal file
@@ -0,0 +1 @@
|
|||||||
|
export { default as Textarea } from "./Textarea.vue"
|
||||||
159
frontend/components/views/DetailView.vue
Normal file
159
frontend/components/views/DetailView.vue
Normal file
@@ -0,0 +1,159 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import { computed } from 'vue'
|
||||||
|
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from '@/components/ui/card'
|
||||||
|
import { Button } from '@/components/ui/button'
|
||||||
|
import { Separator } from '@/components/ui/separator'
|
||||||
|
import FieldRenderer from '@/components/fields/FieldRenderer.vue'
|
||||||
|
import { DetailViewConfig, ViewMode, FieldSection } from '@/types/field-types'
|
||||||
|
import { Edit, Trash2, ArrowLeft } from 'lucide-vue-next'
|
||||||
|
import {
|
||||||
|
Collapsible,
|
||||||
|
CollapsibleContent,
|
||||||
|
CollapsibleTrigger,
|
||||||
|
} from '@/components/ui/collapsible'
|
||||||
|
|
||||||
|
interface Props {
|
||||||
|
config: DetailViewConfig
|
||||||
|
data: any
|
||||||
|
loading?: boolean
|
||||||
|
}
|
||||||
|
|
||||||
|
const props = withDefaults(defineProps<Props>(), {
|
||||||
|
loading: false,
|
||||||
|
})
|
||||||
|
|
||||||
|
const emit = defineEmits<{
|
||||||
|
'edit': []
|
||||||
|
'delete': []
|
||||||
|
'back': []
|
||||||
|
'action': [actionId: string]
|
||||||
|
}>()
|
||||||
|
|
||||||
|
// Organize fields into sections
|
||||||
|
const sections = computed<FieldSection[]>(() => {
|
||||||
|
if (props.config.sections && props.config.sections.length > 0) {
|
||||||
|
return props.config.sections
|
||||||
|
}
|
||||||
|
|
||||||
|
// Default section with all visible fields
|
||||||
|
return [{
|
||||||
|
title: 'Details',
|
||||||
|
fields: props.config.fields
|
||||||
|
.filter(f => f.showOnDetail !== false)
|
||||||
|
.map(f => f.apiName),
|
||||||
|
}]
|
||||||
|
})
|
||||||
|
|
||||||
|
const getFieldsBySection = (section: FieldSection) => {
|
||||||
|
return section.fields
|
||||||
|
.map(apiName => props.config.fields.find(f => f.apiName === apiName))
|
||||||
|
.filter(Boolean)
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="detail-view space-y-6">
|
||||||
|
<!-- Header -->
|
||||||
|
<div class="flex items-center justify-between">
|
||||||
|
<div class="flex items-center gap-4">
|
||||||
|
<Button variant="ghost" size="sm" @click="emit('back')">
|
||||||
|
<ArrowLeft class="h-4 w-4 mr-2" />
|
||||||
|
Back
|
||||||
|
</Button>
|
||||||
|
<div>
|
||||||
|
<h2 class="text-2xl font-bold tracking-tight">
|
||||||
|
{{ data?.name || data?.title || config.objectApiName }}
|
||||||
|
</h2>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="flex items-center gap-2">
|
||||||
|
<!-- Custom Actions -->
|
||||||
|
<Button
|
||||||
|
v-for="action in config.actions"
|
||||||
|
:key="action.id"
|
||||||
|
:variant="action.variant || 'outline'"
|
||||||
|
size="sm"
|
||||||
|
@click="emit('action', action.id)"
|
||||||
|
>
|
||||||
|
{{ action.label }}
|
||||||
|
</Button>
|
||||||
|
|
||||||
|
<!-- Default Actions -->
|
||||||
|
<Button variant="outline" size="sm" @click="emit('edit')">
|
||||||
|
<Edit class="h-4 w-4 mr-2" />
|
||||||
|
Edit
|
||||||
|
</Button>
|
||||||
|
<Button variant="destructive" size="sm" @click="emit('delete')">
|
||||||
|
<Trash2 class="h-4 w-4 mr-2" />
|
||||||
|
Delete
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Loading State -->
|
||||||
|
<div v-if="loading" class="flex items-center justify-center py-12">
|
||||||
|
<div class="animate-spin rounded-full h-12 w-12 border-b-2 border-primary"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Content Sections -->
|
||||||
|
<div v-else class="space-y-6">
|
||||||
|
<Card v-for="(section, idx) in sections" :key="idx">
|
||||||
|
<Collapsible
|
||||||
|
v-if="section.collapsible"
|
||||||
|
:default-open="!section.defaultCollapsed"
|
||||||
|
>
|
||||||
|
<CardHeader>
|
||||||
|
<CollapsibleTrigger class="flex items-center justify-between w-full hover:bg-muted/50 -m-2 p-2 rounded">
|
||||||
|
<div>
|
||||||
|
<CardTitle v-if="section.title">{{ section.title }}</CardTitle>
|
||||||
|
<CardDescription v-if="section.description">
|
||||||
|
{{ section.description }}
|
||||||
|
</CardDescription>
|
||||||
|
</div>
|
||||||
|
</CollapsibleTrigger>
|
||||||
|
</CardHeader>
|
||||||
|
<CollapsibleContent>
|
||||||
|
<CardContent>
|
||||||
|
<div class="grid gap-6 md:grid-cols-2">
|
||||||
|
<FieldRenderer
|
||||||
|
v-for="field in getFieldsBySection(section)"
|
||||||
|
:key="field.id"
|
||||||
|
:field="field"
|
||||||
|
:model-value="data[field.apiName]"
|
||||||
|
:mode="ViewMode.DETAIL"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</CardContent>
|
||||||
|
</CollapsibleContent>
|
||||||
|
</Collapsible>
|
||||||
|
|
||||||
|
<template v-else>
|
||||||
|
<CardHeader v-if="section.title || section.description">
|
||||||
|
<CardTitle v-if="section.title">{{ section.title }}</CardTitle>
|
||||||
|
<CardDescription v-if="section.description">
|
||||||
|
{{ section.description }}
|
||||||
|
</CardDescription>
|
||||||
|
</CardHeader>
|
||||||
|
<CardContent>
|
||||||
|
<div class="grid gap-6 md:grid-cols-2">
|
||||||
|
<FieldRenderer
|
||||||
|
v-for="field in getFieldsBySection(section)"
|
||||||
|
:key="field.id"
|
||||||
|
:field="field"
|
||||||
|
:model-value="data[field.apiName]"
|
||||||
|
:mode="ViewMode.DETAIL"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</CardContent>
|
||||||
|
</template>
|
||||||
|
</Card>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.detail-view {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
273
frontend/components/views/EditView.vue
Normal file
273
frontend/components/views/EditView.vue
Normal file
@@ -0,0 +1,273 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import { ref, computed, watch } from 'vue'
|
||||||
|
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from '@/components/ui/card'
|
||||||
|
import { Button } from '@/components/ui/button'
|
||||||
|
import { Separator } from '@/components/ui/separator'
|
||||||
|
import FieldRenderer from '@/components/fields/FieldRenderer.vue'
|
||||||
|
import { EditViewConfig, ViewMode, FieldSection, FieldValidationRule } from '@/types/field-types'
|
||||||
|
import { Save, X, ArrowLeft } from 'lucide-vue-next'
|
||||||
|
import {
|
||||||
|
Collapsible,
|
||||||
|
CollapsibleContent,
|
||||||
|
CollapsibleTrigger,
|
||||||
|
} from '@/components/ui/collapsible'
|
||||||
|
|
||||||
|
interface Props {
|
||||||
|
config: EditViewConfig
|
||||||
|
data?: any
|
||||||
|
loading?: boolean
|
||||||
|
saving?: boolean
|
||||||
|
}
|
||||||
|
|
||||||
|
const props = withDefaults(defineProps<Props>(), {
|
||||||
|
data: () => ({}),
|
||||||
|
loading: false,
|
||||||
|
saving: false,
|
||||||
|
})
|
||||||
|
|
||||||
|
const emit = defineEmits<{
|
||||||
|
'save': [data: any]
|
||||||
|
'cancel': []
|
||||||
|
'back': []
|
||||||
|
}>()
|
||||||
|
|
||||||
|
// Form data
|
||||||
|
const formData = ref<Record<string, any>>({ ...props.data })
|
||||||
|
const errors = ref<Record<string, string>>({})
|
||||||
|
|
||||||
|
// Watch for data changes (useful for edit mode)
|
||||||
|
watch(() => props.data, (newData) => {
|
||||||
|
formData.value = { ...newData }
|
||||||
|
}, { deep: true })
|
||||||
|
|
||||||
|
// Organize fields into sections
|
||||||
|
const sections = computed<FieldSection[]>(() => {
|
||||||
|
if (props.config.sections && props.config.sections.length > 0) {
|
||||||
|
return props.config.sections
|
||||||
|
}
|
||||||
|
|
||||||
|
// Default section with all visible fields
|
||||||
|
return [{
|
||||||
|
title: 'Details',
|
||||||
|
fields: props.config.fields
|
||||||
|
.filter(f => f.showOnEdit !== false)
|
||||||
|
.map(f => f.apiName),
|
||||||
|
}]
|
||||||
|
})
|
||||||
|
|
||||||
|
const getFieldsBySection = (section: FieldSection) => {
|
||||||
|
return section.fields
|
||||||
|
.map(apiName => props.config.fields.find(f => f.apiName === apiName))
|
||||||
|
.filter(Boolean)
|
||||||
|
}
|
||||||
|
|
||||||
|
const validateField = (field: any): string | null => {
|
||||||
|
const value = formData.value[field.apiName]
|
||||||
|
|
||||||
|
// Required validation
|
||||||
|
if (field.isRequired && (value === null || value === undefined || value === '')) {
|
||||||
|
return `${field.label} is required`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Custom validation rules
|
||||||
|
if (field.validationRules) {
|
||||||
|
for (const rule of field.validationRules) {
|
||||||
|
switch (rule.type) {
|
||||||
|
case 'required':
|
||||||
|
if (value === null || value === undefined || value === '') {
|
||||||
|
return rule.message || `${field.label} is required`
|
||||||
|
}
|
||||||
|
break
|
||||||
|
case 'min':
|
||||||
|
if (typeof value === 'number' && value < rule.value) {
|
||||||
|
return rule.message || `${field.label} must be at least ${rule.value}`
|
||||||
|
}
|
||||||
|
if (typeof value === 'string' && value.length < rule.value) {
|
||||||
|
return rule.message || `${field.label} must be at least ${rule.value} characters`
|
||||||
|
}
|
||||||
|
break
|
||||||
|
case 'max':
|
||||||
|
if (typeof value === 'number' && value > rule.value) {
|
||||||
|
return rule.message || `${field.label} must be at most ${rule.value}`
|
||||||
|
}
|
||||||
|
if (typeof value === 'string' && value.length > rule.value) {
|
||||||
|
return rule.message || `${field.label} must be at most ${rule.value} characters`
|
||||||
|
}
|
||||||
|
break
|
||||||
|
case 'email':
|
||||||
|
if (value && !/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(value)) {
|
||||||
|
return rule.message || `${field.label} must be a valid email`
|
||||||
|
}
|
||||||
|
break
|
||||||
|
case 'url':
|
||||||
|
if (value && !/^https?:\/\/.+/.test(value)) {
|
||||||
|
return rule.message || `${field.label} must be a valid URL`
|
||||||
|
}
|
||||||
|
break
|
||||||
|
case 'pattern':
|
||||||
|
if (value && !new RegExp(rule.value).test(value)) {
|
||||||
|
return rule.message || `${field.label} has invalid format`
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
const validateForm = (): boolean => {
|
||||||
|
errors.value = {}
|
||||||
|
let isValid = true
|
||||||
|
|
||||||
|
for (const field of props.config.fields) {
|
||||||
|
const error = validateField(field)
|
||||||
|
if (error) {
|
||||||
|
errors.value[field.apiName] = error
|
||||||
|
isValid = false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return isValid
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleSave = () => {
|
||||||
|
if (validateForm()) {
|
||||||
|
emit('save', { ...formData.value })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleCancel = () => {
|
||||||
|
formData.value = { ...props.data }
|
||||||
|
errors.value = {}
|
||||||
|
emit('cancel')
|
||||||
|
}
|
||||||
|
|
||||||
|
const updateFieldValue = (apiName: string, value: any) => {
|
||||||
|
formData.value[apiName] = value
|
||||||
|
// Clear error for this field when user starts editing
|
||||||
|
if (errors.value[apiName]) {
|
||||||
|
delete errors.value[apiName]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="edit-view space-y-6">
|
||||||
|
<!-- Header -->
|
||||||
|
<div class="flex items-center justify-between">
|
||||||
|
<div class="flex items-center gap-4">
|
||||||
|
<Button variant="ghost" size="sm" @click="emit('back')">
|
||||||
|
<ArrowLeft class="h-4 w-4 mr-2" />
|
||||||
|
Back
|
||||||
|
</Button>
|
||||||
|
<div>
|
||||||
|
<h2 class="text-2xl font-bold tracking-tight">
|
||||||
|
{{ data?.id ? 'Edit' : 'Create' }} {{ config.objectApiName }}
|
||||||
|
</h2>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="flex items-center gap-2">
|
||||||
|
<Button variant="outline" @click="handleCancel" :disabled="saving">
|
||||||
|
<X class="h-4 w-4 mr-2" />
|
||||||
|
{{ config.cancelLabel || 'Cancel' }}
|
||||||
|
</Button>
|
||||||
|
<Button @click="handleSave" :disabled="saving">
|
||||||
|
<Save class="h-4 w-4 mr-2" />
|
||||||
|
{{ config.submitLabel || 'Save' }}
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Loading State -->
|
||||||
|
<div v-if="loading" class="flex items-center justify-center py-12">
|
||||||
|
<div class="animate-spin rounded-full h-12 w-12 border-b-2 border-primary"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Form Sections -->
|
||||||
|
<form v-else @submit.prevent="handleSave" class="space-y-6">
|
||||||
|
<Card v-for="(section, idx) in sections" :key="idx">
|
||||||
|
<Collapsible
|
||||||
|
v-if="section.collapsible"
|
||||||
|
:default-open="!section.defaultCollapsed"
|
||||||
|
>
|
||||||
|
<CardHeader>
|
||||||
|
<CollapsibleTrigger class="flex items-center justify-between w-full hover:bg-muted/50 -m-2 p-2 rounded">
|
||||||
|
<div>
|
||||||
|
<CardTitle v-if="section.title">{{ section.title }}</CardTitle>
|
||||||
|
<CardDescription v-if="section.description">
|
||||||
|
{{ section.description }}
|
||||||
|
</CardDescription>
|
||||||
|
</div>
|
||||||
|
</CollapsibleTrigger>
|
||||||
|
</CardHeader>
|
||||||
|
<CollapsibleContent>
|
||||||
|
<CardContent>
|
||||||
|
<div class="grid gap-6 md:grid-cols-2">
|
||||||
|
<div
|
||||||
|
v-for="field in getFieldsBySection(section)"
|
||||||
|
:key="field.id"
|
||||||
|
class="space-y-1"
|
||||||
|
>
|
||||||
|
<FieldRenderer
|
||||||
|
:field="field"
|
||||||
|
:model-value="formData[field.apiName]"
|
||||||
|
:mode="ViewMode.EDIT"
|
||||||
|
@update:model-value="updateFieldValue(field.apiName, $event)"
|
||||||
|
/>
|
||||||
|
<p v-if="errors[field.apiName]" class="text-sm text-destructive">
|
||||||
|
{{ errors[field.apiName] }}
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</CardContent>
|
||||||
|
</CollapsibleContent>
|
||||||
|
</Collapsible>
|
||||||
|
|
||||||
|
<template v-else>
|
||||||
|
<CardHeader v-if="section.title || section.description">
|
||||||
|
<CardTitle v-if="section.title">{{ section.title }}</CardTitle>
|
||||||
|
<CardDescription v-if="section.description">
|
||||||
|
{{ section.description }}
|
||||||
|
</CardDescription>
|
||||||
|
</CardHeader>
|
||||||
|
<CardContent>
|
||||||
|
<div class="grid gap-6 md:grid-cols-2">
|
||||||
|
<div
|
||||||
|
v-for="field in getFieldsBySection(section)"
|
||||||
|
:key="field.id"
|
||||||
|
class="space-y-1"
|
||||||
|
>
|
||||||
|
<FieldRenderer
|
||||||
|
:field="field"
|
||||||
|
:model-value="formData[field.apiName]"
|
||||||
|
:mode="ViewMode.EDIT"
|
||||||
|
@update:model-value="updateFieldValue(field.apiName, $event)"
|
||||||
|
/>
|
||||||
|
<p v-if="errors[field.apiName]" class="text-sm text-destructive">
|
||||||
|
{{ errors[field.apiName] }}
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</CardContent>
|
||||||
|
</template>
|
||||||
|
</Card>
|
||||||
|
|
||||||
|
<!-- Hidden submit button for form submission -->
|
||||||
|
<button type="submit" class="hidden" />
|
||||||
|
</form>
|
||||||
|
|
||||||
|
<!-- Save indicator -->
|
||||||
|
<div v-if="saving" class="fixed bottom-4 right-4 bg-primary text-primary-foreground px-4 py-2 rounded-lg shadow-lg flex items-center gap-2">
|
||||||
|
<div class="animate-spin rounded-full h-4 w-4 border-b-2 border-primary-foreground"></div>
|
||||||
|
<span>Saving...</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.edit-view {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
234
frontend/components/views/ListView.vue
Normal file
234
frontend/components/views/ListView.vue
Normal file
@@ -0,0 +1,234 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import { ref, computed, onMounted } from 'vue'
|
||||||
|
import {
|
||||||
|
Table,
|
||||||
|
TableBody,
|
||||||
|
TableCell,
|
||||||
|
TableHead,
|
||||||
|
TableHeader,
|
||||||
|
TableRow,
|
||||||
|
} from '@/components/ui/table'
|
||||||
|
import { Button } from '@/components/ui/button'
|
||||||
|
import { Input } from '@/components/ui/input'
|
||||||
|
import { Badge } from '@/components/ui/badge'
|
||||||
|
import { Checkbox } from '@/components/ui/checkbox'
|
||||||
|
import FieldRenderer from '@/components/fields/FieldRenderer.vue'
|
||||||
|
import { ListViewConfig, ViewMode, FieldType } from '@/types/field-types'
|
||||||
|
import { ChevronDown, ChevronUp, Search, Plus, Download, Trash2, Edit } from 'lucide-vue-next'
|
||||||
|
|
||||||
|
interface Props {
|
||||||
|
config: ListViewConfig
|
||||||
|
data?: any[]
|
||||||
|
loading?: boolean
|
||||||
|
selectable?: boolean
|
||||||
|
}
|
||||||
|
|
||||||
|
const props = withDefaults(defineProps<Props>(), {
|
||||||
|
data: () => [],
|
||||||
|
loading: false,
|
||||||
|
selectable: false,
|
||||||
|
})
|
||||||
|
|
||||||
|
const emit = defineEmits<{
|
||||||
|
'row-click': [row: any]
|
||||||
|
'row-select': [rows: any[]]
|
||||||
|
'create': []
|
||||||
|
'edit': [row: any]
|
||||||
|
'delete': [rows: any[]]
|
||||||
|
'action': [actionId: string, rows: any[]]
|
||||||
|
'sort': [field: string, direction: 'asc' | 'desc']
|
||||||
|
'search': [query: string]
|
||||||
|
'refresh': []
|
||||||
|
}>()
|
||||||
|
|
||||||
|
// State
|
||||||
|
const selectedRows = ref<Set<string>>(new Set())
|
||||||
|
const searchQuery = ref('')
|
||||||
|
const sortField = ref<string>('')
|
||||||
|
const sortDirection = ref<'asc' | 'desc'>('asc')
|
||||||
|
|
||||||
|
// Computed
|
||||||
|
const visibleFields = computed(() =>
|
||||||
|
props.config.fields.filter(f => f.showOnList !== false)
|
||||||
|
)
|
||||||
|
|
||||||
|
const allSelected = computed({
|
||||||
|
get: () => props.data.length > 0 && selectedRows.value.size === props.data.length,
|
||||||
|
set: (val: boolean) => {
|
||||||
|
if (val) {
|
||||||
|
selectedRows.value = new Set(props.data.map(row => row.id))
|
||||||
|
} else {
|
||||||
|
selectedRows.value.clear()
|
||||||
|
}
|
||||||
|
emit('row-select', getSelectedRows())
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
const getSelectedRows = () => {
|
||||||
|
return props.data.filter(row => selectedRows.value.has(row.id))
|
||||||
|
}
|
||||||
|
|
||||||
|
const toggleRowSelection = (rowId: string) => {
|
||||||
|
if (selectedRows.value.has(rowId)) {
|
||||||
|
selectedRows.value.delete(rowId)
|
||||||
|
} else {
|
||||||
|
selectedRows.value.add(rowId)
|
||||||
|
}
|
||||||
|
emit('row-select', getSelectedRows())
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleSort = (field: string) => {
|
||||||
|
if (sortField.value === field) {
|
||||||
|
sortDirection.value = sortDirection.value === 'asc' ? 'desc' : 'asc'
|
||||||
|
} else {
|
||||||
|
sortField.value = field
|
||||||
|
sortDirection.value = 'asc'
|
||||||
|
}
|
||||||
|
emit('sort', field, sortDirection.value)
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleSearch = () => {
|
||||||
|
emit('search', searchQuery.value)
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleAction = (actionId: string) => {
|
||||||
|
emit('action', actionId, getSelectedRows())
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="list-view space-y-4">
|
||||||
|
<!-- Toolbar -->
|
||||||
|
<div class="flex items-center justify-between gap-4">
|
||||||
|
<!-- Search -->
|
||||||
|
<div v-if="config.searchable !== false" class="flex-1 max-w-sm">
|
||||||
|
<div class="relative">
|
||||||
|
<Search class="absolute left-2 top-2.5 h-4 w-4 text-muted-foreground" />
|
||||||
|
<Input
|
||||||
|
v-model="searchQuery"
|
||||||
|
placeholder="Search..."
|
||||||
|
class="pl-8"
|
||||||
|
@keyup.enter="handleSearch"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="flex items-center gap-2">
|
||||||
|
<!-- Bulk Actions -->
|
||||||
|
<template v-if="selectedRows.size > 0">
|
||||||
|
<Badge variant="secondary" class="px-3 py-1">
|
||||||
|
{{ selectedRows.size }} selected
|
||||||
|
</Badge>
|
||||||
|
<Button variant="outline" size="sm" @click="emit('delete', getSelectedRows())">
|
||||||
|
<Trash2 class="h-4 w-4 mr-2" />
|
||||||
|
Delete
|
||||||
|
</Button>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<!-- Custom Actions -->
|
||||||
|
<Button
|
||||||
|
v-for="action in config.actions"
|
||||||
|
:key="action.id"
|
||||||
|
:variant="action.variant || 'outline'"
|
||||||
|
size="sm"
|
||||||
|
@click="handleAction(action.id)"
|
||||||
|
>
|
||||||
|
{{ action.label }}
|
||||||
|
</Button>
|
||||||
|
|
||||||
|
<!-- Export -->
|
||||||
|
<Button v-if="config.exportable" variant="outline" size="sm">
|
||||||
|
<Download class="h-4 w-4 mr-2" />
|
||||||
|
Export
|
||||||
|
</Button>
|
||||||
|
|
||||||
|
<!-- Create -->
|
||||||
|
<Button size="sm" @click="emit('create')">
|
||||||
|
<Plus class="h-4 w-4 mr-2" />
|
||||||
|
New
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Table -->
|
||||||
|
<div class="border rounded-lg">
|
||||||
|
<Table>
|
||||||
|
<TableHeader>
|
||||||
|
<TableRow>
|
||||||
|
<TableHead v-if="selectable" class="w-12">
|
||||||
|
<Checkbox v-model:checked="allSelected" />
|
||||||
|
</TableHead>
|
||||||
|
<TableHead
|
||||||
|
v-for="field in visibleFields"
|
||||||
|
:key="field.id"
|
||||||
|
:class="{ 'cursor-pointer hover:bg-muted/50': field.sortable !== false }"
|
||||||
|
@click="field.sortable !== false && handleSort(field.apiName)"
|
||||||
|
>
|
||||||
|
<div class="flex items-center gap-2">
|
||||||
|
{{ field.label }}
|
||||||
|
<template v-if="field.sortable !== false && sortField === field.apiName">
|
||||||
|
<ChevronUp v-if="sortDirection === 'asc'" class="h-4 w-4" />
|
||||||
|
<ChevronDown v-else class="h-4 w-4" />
|
||||||
|
</template>
|
||||||
|
</div>
|
||||||
|
</TableHead>
|
||||||
|
<TableHead class="w-20">Actions</TableHead>
|
||||||
|
</TableRow>
|
||||||
|
</TableHeader>
|
||||||
|
<TableBody>
|
||||||
|
<TableRow v-if="loading">
|
||||||
|
<TableCell :colspan="visibleFields.length + (selectable ? 2 : 1)" class="text-center py-8">
|
||||||
|
<div class="flex items-center justify-center">
|
||||||
|
<div class="animate-spin rounded-full h-8 w-8 border-b-2 border-primary"></div>
|
||||||
|
</div>
|
||||||
|
</TableCell>
|
||||||
|
</TableRow>
|
||||||
|
<TableRow v-else-if="data.length === 0">
|
||||||
|
<TableCell :colspan="visibleFields.length + (selectable ? 2 : 1)" class="text-center py-8 text-muted-foreground">
|
||||||
|
No records found
|
||||||
|
</TableCell>
|
||||||
|
</TableRow>
|
||||||
|
<TableRow
|
||||||
|
v-else
|
||||||
|
v-for="row in data"
|
||||||
|
:key="row.id"
|
||||||
|
class="cursor-pointer hover:bg-muted/50"
|
||||||
|
@click="emit('row-click', row)"
|
||||||
|
>
|
||||||
|
<TableCell v-if="selectable" @click.stop>
|
||||||
|
<Checkbox
|
||||||
|
:checked="selectedRows.has(row.id)"
|
||||||
|
@update:checked="toggleRowSelection(row.id)"
|
||||||
|
/>
|
||||||
|
</TableCell>
|
||||||
|
<TableCell v-for="field in visibleFields" :key="field.id">
|
||||||
|
<FieldRenderer
|
||||||
|
:field="field"
|
||||||
|
:model-value="row[field.apiName]"
|
||||||
|
:mode="ViewMode.LIST"
|
||||||
|
/>
|
||||||
|
</TableCell>
|
||||||
|
<TableCell @click.stop>
|
||||||
|
<div class="flex items-center gap-1">
|
||||||
|
<Button variant="ghost" size="sm" @click="emit('edit', row)">
|
||||||
|
<Edit class="h-4 w-4" />
|
||||||
|
</Button>
|
||||||
|
<Button variant="ghost" size="sm" @click="emit('delete', [row])">
|
||||||
|
<Trash2 class="h-4 w-4" />
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
|
</TableCell>
|
||||||
|
</TableRow>
|
||||||
|
</TableBody>
|
||||||
|
</Table>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Pagination would go here -->
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.list-view {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
326
frontend/composables/useFieldViews.ts
Normal file
326
frontend/composables/useFieldViews.ts
Normal file
@@ -0,0 +1,326 @@
|
|||||||
|
import { computed, ref } from 'vue'
|
||||||
|
import type { FieldConfig, ListViewConfig, DetailViewConfig, EditViewConfig, ViewMode } from '@/types/field-types'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Composable for working with dynamic fields and views
|
||||||
|
* Helps convert backend field definitions to frontend field configs
|
||||||
|
*/
|
||||||
|
export const useFields = () => {
|
||||||
|
/**
|
||||||
|
* Convert backend field definition to frontend FieldConfig
|
||||||
|
*/
|
||||||
|
const mapFieldDefinitionToConfig = (fieldDef: any): FieldConfig => {
|
||||||
|
return {
|
||||||
|
id: fieldDef.id,
|
||||||
|
apiName: fieldDef.apiName,
|
||||||
|
label: fieldDef.label,
|
||||||
|
type: fieldDef.type,
|
||||||
|
|
||||||
|
// Default values
|
||||||
|
placeholder: fieldDef.uiMetadata?.placeholder || fieldDef.description,
|
||||||
|
helpText: fieldDef.uiMetadata?.helpText || fieldDef.description,
|
||||||
|
defaultValue: fieldDef.defaultValue,
|
||||||
|
|
||||||
|
// Validation
|
||||||
|
isRequired: fieldDef.isRequired,
|
||||||
|
isReadOnly: fieldDef.isSystem || fieldDef.uiMetadata?.isReadOnly,
|
||||||
|
validationRules: fieldDef.uiMetadata?.validationRules || [],
|
||||||
|
|
||||||
|
// View options
|
||||||
|
showOnList: fieldDef.uiMetadata?.showOnList ?? true,
|
||||||
|
showOnDetail: fieldDef.uiMetadata?.showOnDetail ?? true,
|
||||||
|
showOnEdit: fieldDef.uiMetadata?.showOnEdit ?? !fieldDef.isSystem,
|
||||||
|
sortable: fieldDef.uiMetadata?.sortable ?? true,
|
||||||
|
|
||||||
|
// Field type specific
|
||||||
|
options: fieldDef.uiMetadata?.options,
|
||||||
|
rows: fieldDef.uiMetadata?.rows,
|
||||||
|
min: fieldDef.uiMetadata?.min,
|
||||||
|
max: fieldDef.uiMetadata?.max,
|
||||||
|
step: fieldDef.uiMetadata?.step,
|
||||||
|
accept: fieldDef.uiMetadata?.accept,
|
||||||
|
relationObject: fieldDef.referenceObject,
|
||||||
|
relationDisplayField: fieldDef.uiMetadata?.relationDisplayField,
|
||||||
|
|
||||||
|
// Formatting
|
||||||
|
format: fieldDef.uiMetadata?.format,
|
||||||
|
prefix: fieldDef.uiMetadata?.prefix,
|
||||||
|
suffix: fieldDef.uiMetadata?.suffix,
|
||||||
|
|
||||||
|
// Advanced
|
||||||
|
dependsOn: fieldDef.uiMetadata?.dependsOn,
|
||||||
|
computedValue: fieldDef.uiMetadata?.computedValue,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build a ListView configuration from object definition
|
||||||
|
*/
|
||||||
|
const buildListViewConfig = (
|
||||||
|
objectDef: any,
|
||||||
|
customConfig?: Partial<ListViewConfig>
|
||||||
|
): ListViewConfig => {
|
||||||
|
const fields = objectDef.fields?.map(mapFieldDefinitionToConfig) || []
|
||||||
|
|
||||||
|
return {
|
||||||
|
objectApiName: objectDef.apiName,
|
||||||
|
mode: 'list' as ViewMode,
|
||||||
|
fields,
|
||||||
|
pageSize: 25,
|
||||||
|
searchable: true,
|
||||||
|
filterable: true,
|
||||||
|
exportable: true,
|
||||||
|
...customConfig,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build a DetailView configuration from object definition
|
||||||
|
*/
|
||||||
|
const buildDetailViewConfig = (
|
||||||
|
objectDef: any,
|
||||||
|
customConfig?: Partial<DetailViewConfig>
|
||||||
|
): DetailViewConfig => {
|
||||||
|
const fields = objectDef.fields?.map(mapFieldDefinitionToConfig) || []
|
||||||
|
|
||||||
|
return {
|
||||||
|
objectApiName: objectDef.apiName,
|
||||||
|
mode: 'detail' as ViewMode,
|
||||||
|
fields,
|
||||||
|
...customConfig,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build an EditView configuration from object definition
|
||||||
|
*/
|
||||||
|
const buildEditViewConfig = (
|
||||||
|
objectDef: any,
|
||||||
|
customConfig?: Partial<EditViewConfig>
|
||||||
|
): EditViewConfig => {
|
||||||
|
const fields = objectDef.fields?.map(mapFieldDefinitionToConfig) || []
|
||||||
|
|
||||||
|
return {
|
||||||
|
objectApiName: objectDef.apiName,
|
||||||
|
mode: 'edit' as ViewMode,
|
||||||
|
fields,
|
||||||
|
submitLabel: 'Save',
|
||||||
|
cancelLabel: 'Cancel',
|
||||||
|
...customConfig,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Auto-generate sections based on field types or custom logic
|
||||||
|
*/
|
||||||
|
const generateSections = (fields: FieldConfig[]) => {
|
||||||
|
// Group fields by some logic - this is a simple example
|
||||||
|
const basicFields = fields.filter(f =>
|
||||||
|
['text', 'email', 'password', 'number'].includes(f.type)
|
||||||
|
)
|
||||||
|
const relationFields = fields.filter(f =>
|
||||||
|
['belongsTo', 'hasMany', 'manyToMany'].includes(f.type)
|
||||||
|
)
|
||||||
|
const otherFields = fields.filter(f =>
|
||||||
|
!basicFields.includes(f) && !relationFields.includes(f)
|
||||||
|
)
|
||||||
|
|
||||||
|
const sections = []
|
||||||
|
|
||||||
|
if (basicFields.length > 0) {
|
||||||
|
sections.push({
|
||||||
|
title: 'Basic Information',
|
||||||
|
fields: basicFields.map(f => f.apiName),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if (relationFields.length > 0) {
|
||||||
|
sections.push({
|
||||||
|
title: 'Related Records',
|
||||||
|
fields: relationFields.map(f => f.apiName),
|
||||||
|
collapsible: true,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if (otherFields.length > 0) {
|
||||||
|
sections.push({
|
||||||
|
title: 'Additional Information',
|
||||||
|
fields: otherFields.map(f => f.apiName),
|
||||||
|
collapsible: true,
|
||||||
|
defaultCollapsed: true,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
return sections
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
mapFieldDefinitionToConfig,
|
||||||
|
buildListViewConfig,
|
||||||
|
buildDetailViewConfig,
|
||||||
|
buildEditViewConfig,
|
||||||
|
generateSections,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Composable for managing view state (CRUD operations)
|
||||||
|
*/
|
||||||
|
export const useViewState = <T extends { id?: string }>(
|
||||||
|
apiEndpoint: string
|
||||||
|
) => {
|
||||||
|
const records = ref<T[]>([])
|
||||||
|
const currentRecord = ref<T | null>(null)
|
||||||
|
const currentView = ref<'list' | 'detail' | 'edit'>('list')
|
||||||
|
const loading = ref(false)
|
||||||
|
const saving = ref(false)
|
||||||
|
const error = ref<string | null>(null)
|
||||||
|
|
||||||
|
const api = useApi()
|
||||||
|
|
||||||
|
const fetchRecords = async (params?: Record<string, any>) => {
|
||||||
|
loading.value = true
|
||||||
|
error.value = null
|
||||||
|
try {
|
||||||
|
const response = await api.get(apiEndpoint, { params })
|
||||||
|
records.value = response.data
|
||||||
|
} catch (e: any) {
|
||||||
|
error.value = e.message
|
||||||
|
console.error('Failed to fetch records:', e)
|
||||||
|
} finally {
|
||||||
|
loading.value = false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const fetchRecord = async (id: string) => {
|
||||||
|
loading.value = true
|
||||||
|
error.value = null
|
||||||
|
try {
|
||||||
|
const response = await api.get(`${apiEndpoint}/${id}`)
|
||||||
|
currentRecord.value = response.data
|
||||||
|
} catch (e: any) {
|
||||||
|
error.value = e.message
|
||||||
|
console.error('Failed to fetch record:', e)
|
||||||
|
} finally {
|
||||||
|
loading.value = false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const createRecord = async (data: Partial<T>) => {
|
||||||
|
saving.value = true
|
||||||
|
error.value = null
|
||||||
|
try {
|
||||||
|
const response = await api.post(apiEndpoint, data)
|
||||||
|
records.value.push(response.data)
|
||||||
|
currentRecord.value = response.data
|
||||||
|
return response.data
|
||||||
|
} catch (e: any) {
|
||||||
|
error.value = e.message
|
||||||
|
console.error('Failed to create record:', e)
|
||||||
|
throw e
|
||||||
|
} finally {
|
||||||
|
saving.value = false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const updateRecord = async (id: string, data: Partial<T>) => {
|
||||||
|
saving.value = true
|
||||||
|
error.value = null
|
||||||
|
try {
|
||||||
|
const response = await api.put(`${apiEndpoint}/${id}`, data)
|
||||||
|
const idx = records.value.findIndex(r => r.id === id)
|
||||||
|
if (idx !== -1) {
|
||||||
|
records.value[idx] = response.data
|
||||||
|
}
|
||||||
|
currentRecord.value = response.data
|
||||||
|
return response.data
|
||||||
|
} catch (e: any) {
|
||||||
|
error.value = e.message
|
||||||
|
console.error('Failed to update record:', e)
|
||||||
|
throw e
|
||||||
|
} finally {
|
||||||
|
saving.value = false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const deleteRecord = async (id: string) => {
|
||||||
|
loading.value = true
|
||||||
|
error.value = null
|
||||||
|
try {
|
||||||
|
await api.delete(`${apiEndpoint}/${id}`)
|
||||||
|
records.value = records.value.filter(r => r.id !== id)
|
||||||
|
if (currentRecord.value?.id === id) {
|
||||||
|
currentRecord.value = null
|
||||||
|
}
|
||||||
|
} catch (e: any) {
|
||||||
|
error.value = e.message
|
||||||
|
console.error('Failed to delete record:', e)
|
||||||
|
throw e
|
||||||
|
} finally {
|
||||||
|
loading.value = false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const deleteRecords = async (ids: string[]) => {
|
||||||
|
loading.value = true
|
||||||
|
error.value = null
|
||||||
|
try {
|
||||||
|
await Promise.all(ids.map(id => api.delete(`${apiEndpoint}/${id}`)))
|
||||||
|
records.value = records.value.filter(r => !ids.includes(r.id!))
|
||||||
|
} catch (e: any) {
|
||||||
|
error.value = e.message
|
||||||
|
console.error('Failed to delete records:', e)
|
||||||
|
throw e
|
||||||
|
} finally {
|
||||||
|
loading.value = false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const showList = () => {
|
||||||
|
currentView.value = 'list'
|
||||||
|
currentRecord.value = null
|
||||||
|
}
|
||||||
|
|
||||||
|
const showDetail = (record: T) => {
|
||||||
|
currentRecord.value = record
|
||||||
|
currentView.value = 'detail'
|
||||||
|
}
|
||||||
|
|
||||||
|
const showEdit = (record?: T) => {
|
||||||
|
currentRecord.value = record || ({} as T)
|
||||||
|
currentView.value = 'edit'
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleSave = async (data: T) => {
|
||||||
|
if (data.id) {
|
||||||
|
await updateRecord(data.id, data)
|
||||||
|
} else {
|
||||||
|
await createRecord(data)
|
||||||
|
}
|
||||||
|
showDetail(currentRecord.value!)
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
// State
|
||||||
|
records,
|
||||||
|
currentRecord,
|
||||||
|
currentView,
|
||||||
|
loading,
|
||||||
|
saving,
|
||||||
|
error,
|
||||||
|
|
||||||
|
// Methods
|
||||||
|
fetchRecords,
|
||||||
|
fetchRecord,
|
||||||
|
createRecord,
|
||||||
|
updateRecord,
|
||||||
|
deleteRecord,
|
||||||
|
deleteRecords,
|
||||||
|
|
||||||
|
// Navigation
|
||||||
|
showList,
|
||||||
|
showDetail,
|
||||||
|
showEdit,
|
||||||
|
handleSave,
|
||||||
|
}
|
||||||
|
}
|
||||||
8
frontend/package-lock.json
generated
8
frontend/package-lock.json
generated
@@ -16,7 +16,7 @@
|
|||||||
"lucide-vue-next": "^0.309.0",
|
"lucide-vue-next": "^0.309.0",
|
||||||
"nuxt": "^3.10.0",
|
"nuxt": "^3.10.0",
|
||||||
"radix-vue": "^1.4.1",
|
"radix-vue": "^1.4.1",
|
||||||
"reka-ui": "^2.6.0",
|
"reka-ui": "^2.6.1",
|
||||||
"shadcn-nuxt": "^2.3.3",
|
"shadcn-nuxt": "^2.3.3",
|
||||||
"tailwind-merge": "^2.2.1",
|
"tailwind-merge": "^2.2.1",
|
||||||
"vue": "^3.4.15",
|
"vue": "^3.4.15",
|
||||||
@@ -12790,9 +12790,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/reka-ui": {
|
"node_modules/reka-ui": {
|
||||||
"version": "2.6.0",
|
"version": "2.6.1",
|
||||||
"resolved": "https://registry.npmjs.org/reka-ui/-/reka-ui-2.6.0.tgz",
|
"resolved": "https://registry.npmjs.org/reka-ui/-/reka-ui-2.6.1.tgz",
|
||||||
"integrity": "sha512-NrGMKrABD97l890mFS3TNUzB0BLUfbL3hh0NjcJRIUSUljb288bx3Mzo31nOyUcdiiW0HqFGXJwyCBh9cWgb0w==",
|
"integrity": "sha512-XK7cJDQoNuGXfCNzBBo/81Yg/OgjPwvbabnlzXG2VsdSgNsT6iIkuPBPr+C0Shs+3bb0x0lbPvgQAhMSCKm5Ww==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@floating-ui/dom": "^1.6.13",
|
"@floating-ui/dom": "^1.6.13",
|
||||||
|
|||||||
@@ -22,7 +22,7 @@
|
|||||||
"lucide-vue-next": "^0.309.0",
|
"lucide-vue-next": "^0.309.0",
|
||||||
"nuxt": "^3.10.0",
|
"nuxt": "^3.10.0",
|
||||||
"radix-vue": "^1.4.1",
|
"radix-vue": "^1.4.1",
|
||||||
"reka-ui": "^2.6.0",
|
"reka-ui": "^2.6.1",
|
||||||
"shadcn-nuxt": "^2.3.3",
|
"shadcn-nuxt": "^2.3.3",
|
||||||
"tailwind-merge": "^2.2.1",
|
"tailwind-merge": "^2.2.1",
|
||||||
"vue": "^3.4.15",
|
"vue": "^3.4.15",
|
||||||
|
|||||||
@@ -0,0 +1,197 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import { ref, computed, onMounted } from 'vue'
|
||||||
|
import { useRoute, useRouter } from 'vue-router'
|
||||||
|
import { useApi } from '@/composables/useApi'
|
||||||
|
import { useFields, useViewState } from '@/composables/useFieldViews'
|
||||||
|
import ListView from '@/components/views/ListView.vue'
|
||||||
|
import DetailView from '@/components/views/DetailView.vue'
|
||||||
|
import EditView from '@/components/views/EditView.vue'
|
||||||
|
|
||||||
|
const route = useRoute()
|
||||||
|
const router = useRouter()
|
||||||
|
const api = useApi()
|
||||||
|
const { buildListViewConfig, buildDetailViewConfig, buildEditViewConfig } = useFields()
|
||||||
|
|
||||||
|
// Get object API name from route
|
||||||
|
const objectApiName = computed(() => route.params.objectName as string)
|
||||||
|
const recordId = computed(() => route.params.recordId as string)
|
||||||
|
const view = computed(() => route.params.view as 'list' | 'detail' | 'edit' || 'list')
|
||||||
|
|
||||||
|
// State
|
||||||
|
const objectDefinition = ref<any>(null)
|
||||||
|
const loading = ref(true)
|
||||||
|
const error = ref<string | null>(null)
|
||||||
|
|
||||||
|
// Use view state composable
|
||||||
|
const {
|
||||||
|
records,
|
||||||
|
currentRecord,
|
||||||
|
loading: dataLoading,
|
||||||
|
saving,
|
||||||
|
fetchRecords,
|
||||||
|
fetchRecord,
|
||||||
|
deleteRecord,
|
||||||
|
deleteRecords,
|
||||||
|
handleSave,
|
||||||
|
} = useViewState(`/api/runtime/objects/${objectApiName.value}`)
|
||||||
|
|
||||||
|
// View configs
|
||||||
|
const listConfig = computed(() => {
|
||||||
|
if (!objectDefinition.value) return null
|
||||||
|
return buildListViewConfig(objectDefinition.value, {
|
||||||
|
searchable: true,
|
||||||
|
exportable: true,
|
||||||
|
filterable: true,
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
const detailConfig = computed(() => {
|
||||||
|
if (!objectDefinition.value) return null
|
||||||
|
return buildDetailViewConfig(objectDefinition.value)
|
||||||
|
})
|
||||||
|
|
||||||
|
const editConfig = computed(() => {
|
||||||
|
if (!objectDefinition.value) return null
|
||||||
|
return buildEditViewConfig(objectDefinition.value)
|
||||||
|
})
|
||||||
|
|
||||||
|
// Fetch object definition
|
||||||
|
const fetchObjectDefinition = async () => {
|
||||||
|
try {
|
||||||
|
loading.value = true
|
||||||
|
error.value = null
|
||||||
|
const response = await api.get(`/api/runtime/objects/${objectApiName.value}/definition`)
|
||||||
|
objectDefinition.value = response.data
|
||||||
|
} catch (e: any) {
|
||||||
|
error.value = e.message || 'Failed to load object definition'
|
||||||
|
console.error('Error fetching object definition:', e)
|
||||||
|
} finally {
|
||||||
|
loading.value = false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Navigation handlers
|
||||||
|
const handleRowClick = (row: any) => {
|
||||||
|
router.push(`/app/objects/${objectApiName.value}/${row.id}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleCreate = () => {
|
||||||
|
router.push(`/app/objects/${objectApiName.value}/new`)
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleEdit = (row?: any) => {
|
||||||
|
const id = row?.id || recordId.value
|
||||||
|
router.push(`/app/objects/${objectApiName.value}/${id}/edit`)
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleBack = () => {
|
||||||
|
router.push(`/app/objects/${objectApiName.value}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleDelete = async (rows: any[]) => {
|
||||||
|
if (confirm(`Delete ${rows.length} record(s)? This action cannot be undone.`)) {
|
||||||
|
try {
|
||||||
|
const ids = rows.map(r => r.id)
|
||||||
|
await deleteRecords(ids)
|
||||||
|
if (view.value !== 'list') {
|
||||||
|
await router.push(`/app/objects/${objectApiName.value}`)
|
||||||
|
}
|
||||||
|
} catch (e: any) {
|
||||||
|
error.value = e.message || 'Failed to delete records'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleSaveRecord = async (data: any) => {
|
||||||
|
try {
|
||||||
|
await handleSave(data)
|
||||||
|
router.push(`/app/objects/${objectApiName.value}/${currentRecord.value?.id || data.id}`)
|
||||||
|
} catch (e: any) {
|
||||||
|
error.value = e.message || 'Failed to save record'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleCancel = () => {
|
||||||
|
if (recordId.value) {
|
||||||
|
router.push(`/app/objects/${objectApiName.value}/${recordId.value}`)
|
||||||
|
} else {
|
||||||
|
router.push(`/app/objects/${objectApiName.value}`)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Initialize
|
||||||
|
onMounted(async () => {
|
||||||
|
await fetchObjectDefinition()
|
||||||
|
|
||||||
|
if (view.value === 'list') {
|
||||||
|
await fetchRecords()
|
||||||
|
} else if (recordId.value && recordId.value !== 'new') {
|
||||||
|
await fetchRecord(recordId.value)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="object-view-container">
|
||||||
|
<!-- Loading State -->
|
||||||
|
<div v-if="loading" class="flex items-center justify-center min-h-screen">
|
||||||
|
<div class="text-center space-y-4">
|
||||||
|
<div class="animate-spin rounded-full h-12 w-12 border-b-2 border-primary mx-auto"></div>
|
||||||
|
<p class="text-muted-foreground">Loading {{ objectApiName }}...</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Error State -->
|
||||||
|
<div v-else-if="error" class="flex items-center justify-center min-h-screen">
|
||||||
|
<div class="text-center space-y-4 max-w-md">
|
||||||
|
<div class="text-destructive text-5xl">⚠️</div>
|
||||||
|
<h2 class="text-2xl font-bold">Error</h2>
|
||||||
|
<p class="text-muted-foreground">{{ error }}</p>
|
||||||
|
<Button @click="router.back()">Go Back</Button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- List View -->
|
||||||
|
<ListView
|
||||||
|
v-else-if="view === 'list' && listConfig"
|
||||||
|
:config="listConfig"
|
||||||
|
:data="records"
|
||||||
|
:loading="dataLoading"
|
||||||
|
selectable
|
||||||
|
@row-click="handleRowClick"
|
||||||
|
@create="handleCreate"
|
||||||
|
@edit="handleEdit"
|
||||||
|
@delete="handleDelete"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<!-- Detail View -->
|
||||||
|
<DetailView
|
||||||
|
v-else-if="view === 'detail' && detailConfig && currentRecord"
|
||||||
|
:config="detailConfig"
|
||||||
|
:data="currentRecord"
|
||||||
|
:loading="dataLoading"
|
||||||
|
@edit="handleEdit"
|
||||||
|
@delete="() => handleDelete([currentRecord])"
|
||||||
|
@back="handleBack"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<!-- Edit View -->
|
||||||
|
<EditView
|
||||||
|
v-else-if="(view === 'edit' || recordId === 'new') && editConfig"
|
||||||
|
:config="editConfig"
|
||||||
|
:data="currentRecord || {}"
|
||||||
|
:loading="dataLoading"
|
||||||
|
:saving="saving"
|
||||||
|
@save="handleSaveRecord"
|
||||||
|
@cancel="handleCancel"
|
||||||
|
@back="handleBack"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.object-view-container {
|
||||||
|
min-height: 100vh;
|
||||||
|
padding: 2rem;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
427
frontend/pages/demo/field-views.vue
Normal file
427
frontend/pages/demo/field-views.vue
Normal file
@@ -0,0 +1,427 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import { ref, computed } from 'vue'
|
||||||
|
import { useRouter } from 'vue-router'
|
||||||
|
import ListView from '@/components/views/ListView.vue'
|
||||||
|
import DetailView from '@/components/views/DetailView.vue'
|
||||||
|
import EditView from '@/components/views/EditView.vue'
|
||||||
|
import { Tabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'
|
||||||
|
import {
|
||||||
|
FieldType,
|
||||||
|
ViewMode,
|
||||||
|
type ListViewConfig,
|
||||||
|
type DetailViewConfig,
|
||||||
|
type EditViewConfig,
|
||||||
|
type FieldConfig
|
||||||
|
} from '@/types/field-types'
|
||||||
|
|
||||||
|
// Example: Contact Object
|
||||||
|
const contactFields: FieldConfig[] = [
|
||||||
|
{
|
||||||
|
id: '1',
|
||||||
|
apiName: 'firstName',
|
||||||
|
label: 'First Name',
|
||||||
|
type: FieldType.TEXT,
|
||||||
|
isRequired: true,
|
||||||
|
placeholder: 'Enter first name',
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '2',
|
||||||
|
apiName: 'lastName',
|
||||||
|
label: 'Last Name',
|
||||||
|
type: FieldType.TEXT,
|
||||||
|
isRequired: true,
|
||||||
|
placeholder: 'Enter last name',
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
sortable: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '3',
|
||||||
|
apiName: 'email',
|
||||||
|
label: 'Email',
|
||||||
|
type: FieldType.EMAIL,
|
||||||
|
isRequired: true,
|
||||||
|
placeholder: 'email@example.com',
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
validationRules: [
|
||||||
|
{ type: 'email', message: 'Please enter a valid email address' }
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '4',
|
||||||
|
apiName: 'phone',
|
||||||
|
label: 'Phone',
|
||||||
|
type: FieldType.TEXT,
|
||||||
|
placeholder: '+1 (555) 000-0000',
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '5',
|
||||||
|
apiName: 'company',
|
||||||
|
label: 'Company',
|
||||||
|
type: FieldType.TEXT,
|
||||||
|
placeholder: 'Company name',
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '6',
|
||||||
|
apiName: 'status',
|
||||||
|
label: 'Status',
|
||||||
|
type: FieldType.SELECT,
|
||||||
|
isRequired: true,
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
options: [
|
||||||
|
{ label: 'Active', value: 'active' },
|
||||||
|
{ label: 'Inactive', value: 'inactive' },
|
||||||
|
{ label: 'Pending', value: 'pending' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '7',
|
||||||
|
apiName: 'isVip',
|
||||||
|
label: 'VIP Customer',
|
||||||
|
type: FieldType.BOOLEAN,
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '8',
|
||||||
|
apiName: 'birthDate',
|
||||||
|
label: 'Birth Date',
|
||||||
|
type: FieldType.DATE,
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '9',
|
||||||
|
apiName: 'notes',
|
||||||
|
label: 'Notes',
|
||||||
|
type: FieldType.TEXTAREA,
|
||||||
|
placeholder: 'Additional notes...',
|
||||||
|
rows: 4,
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '10',
|
||||||
|
apiName: 'website',
|
||||||
|
label: 'Website',
|
||||||
|
type: FieldType.URL,
|
||||||
|
placeholder: 'https://example.com',
|
||||||
|
showOnList: false,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
// Sample data
|
||||||
|
const sampleContacts = ref([
|
||||||
|
{
|
||||||
|
id: '1',
|
||||||
|
firstName: 'John',
|
||||||
|
lastName: 'Doe',
|
||||||
|
email: 'john.doe@example.com',
|
||||||
|
phone: '+1 (555) 123-4567',
|
||||||
|
company: 'Acme Corp',
|
||||||
|
status: 'active',
|
||||||
|
isVip: true,
|
||||||
|
birthDate: new Date('1985-03-15'),
|
||||||
|
notes: 'Preferred customer, always pays on time.',
|
||||||
|
website: 'https://acmecorp.com',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '2',
|
||||||
|
firstName: 'Jane',
|
||||||
|
lastName: 'Smith',
|
||||||
|
email: 'jane.smith@example.com',
|
||||||
|
phone: '+1 (555) 987-6543',
|
||||||
|
company: 'Tech Solutions',
|
||||||
|
status: 'active',
|
||||||
|
isVip: false,
|
||||||
|
birthDate: new Date('1990-07-22'),
|
||||||
|
notes: 'Interested in enterprise plan.',
|
||||||
|
website: 'https://techsolutions.com',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: '3',
|
||||||
|
firstName: 'Bob',
|
||||||
|
lastName: 'Johnson',
|
||||||
|
email: 'bob.johnson@example.com',
|
||||||
|
phone: '+1 (555) 456-7890',
|
||||||
|
company: 'StartupXYZ',
|
||||||
|
status: 'pending',
|
||||||
|
isVip: false,
|
||||||
|
birthDate: new Date('1988-11-30'),
|
||||||
|
notes: 'New lead from conference.',
|
||||||
|
website: 'https://startupxyz.com',
|
||||||
|
},
|
||||||
|
])
|
||||||
|
|
||||||
|
// View configurations
|
||||||
|
const listConfig: ListViewConfig = {
|
||||||
|
objectApiName: 'Contact',
|
||||||
|
mode: ViewMode.LIST,
|
||||||
|
fields: contactFields,
|
||||||
|
pageSize: 10,
|
||||||
|
searchable: true,
|
||||||
|
filterable: true,
|
||||||
|
exportable: true,
|
||||||
|
actions: [
|
||||||
|
{
|
||||||
|
id: 'bulk-email',
|
||||||
|
label: 'Send Email',
|
||||||
|
variant: 'outline',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
||||||
|
|
||||||
|
const detailConfig: DetailViewConfig = {
|
||||||
|
objectApiName: 'Contact',
|
||||||
|
mode: ViewMode.DETAIL,
|
||||||
|
fields: contactFields,
|
||||||
|
sections: [
|
||||||
|
{
|
||||||
|
title: 'Contact Information',
|
||||||
|
description: 'Basic contact details',
|
||||||
|
fields: ['firstName', 'lastName', 'email', 'phone'],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Company Information',
|
||||||
|
description: 'Company and business details',
|
||||||
|
fields: ['company', 'website', 'status', 'isVip'],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Additional Information',
|
||||||
|
fields: ['birthDate', 'notes'],
|
||||||
|
collapsible: true,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
actions: [
|
||||||
|
{
|
||||||
|
id: 'send-email',
|
||||||
|
label: 'Send Email',
|
||||||
|
variant: 'outline',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
||||||
|
|
||||||
|
const editConfig: EditViewConfig = {
|
||||||
|
objectApiName: 'Contact',
|
||||||
|
mode: ViewMode.EDIT,
|
||||||
|
fields: contactFields,
|
||||||
|
sections: [
|
||||||
|
{
|
||||||
|
title: 'Contact Information',
|
||||||
|
description: 'Basic contact details',
|
||||||
|
fields: ['firstName', 'lastName', 'email', 'phone'],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Company Information',
|
||||||
|
fields: ['company', 'website', 'status', 'isVip'],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Additional Information',
|
||||||
|
fields: ['birthDate', 'notes'],
|
||||||
|
collapsible: true,
|
||||||
|
defaultCollapsed: true,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
submitLabel: 'Save Contact',
|
||||||
|
cancelLabel: 'Cancel',
|
||||||
|
}
|
||||||
|
|
||||||
|
// State management
|
||||||
|
const currentView = ref<'list' | 'detail' | 'edit'>('list')
|
||||||
|
const selectedContact = ref<any>(null)
|
||||||
|
const isLoading = ref(false)
|
||||||
|
const isSaving = ref(false)
|
||||||
|
|
||||||
|
// Event handlers
|
||||||
|
const handleRowClick = (row: any) => {
|
||||||
|
selectedContact.value = row
|
||||||
|
currentView.value = 'detail'
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleCreate = () => {
|
||||||
|
selectedContact.value = {}
|
||||||
|
currentView.value = 'edit'
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleEdit = (row?: any) => {
|
||||||
|
selectedContact.value = row || selectedContact.value
|
||||||
|
currentView.value = 'edit'
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleDelete = (rows: any[]) => {
|
||||||
|
if (confirm(`Delete ${rows.length} contact(s)?`)) {
|
||||||
|
rows.forEach(row => {
|
||||||
|
const idx = sampleContacts.value.findIndex(c => c.id === row.id)
|
||||||
|
if (idx !== -1) {
|
||||||
|
sampleContacts.value.splice(idx, 1)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
if (selectedContact.value && rows.some(r => r.id === selectedContact.value.id)) {
|
||||||
|
currentView.value = 'list'
|
||||||
|
selectedContact.value = null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleSave = async (data: any) => {
|
||||||
|
isSaving.value = true
|
||||||
|
// Simulate API call
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 1000))
|
||||||
|
|
||||||
|
if (data.id) {
|
||||||
|
// Update existing
|
||||||
|
const idx = sampleContacts.value.findIndex(c => c.id === data.id)
|
||||||
|
if (idx !== -1) {
|
||||||
|
sampleContacts.value[idx] = data
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// Create new
|
||||||
|
data.id = String(Date.now())
|
||||||
|
sampleContacts.value.push(data)
|
||||||
|
}
|
||||||
|
|
||||||
|
isSaving.value = false
|
||||||
|
selectedContact.value = data
|
||||||
|
currentView.value = 'detail'
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleCancel = () => {
|
||||||
|
if (selectedContact.value?.id) {
|
||||||
|
currentView.value = 'detail'
|
||||||
|
} else {
|
||||||
|
currentView.value = 'list'
|
||||||
|
selectedContact.value = null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleBack = () => {
|
||||||
|
currentView.value = 'list'
|
||||||
|
selectedContact.value = null
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="container mx-auto py-8">
|
||||||
|
<div class="mb-8">
|
||||||
|
<h1 class="text-3xl font-bold tracking-tight">Field Types & Views Demo</h1>
|
||||||
|
<p class="text-muted-foreground mt-2">
|
||||||
|
Laravel Nova-inspired list, detail, and edit views with shadcn-vue components
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<Tabs default-value="demo" class="space-y-4">
|
||||||
|
<TabsList>
|
||||||
|
<TabsTrigger value="demo">Interactive Demo</TabsTrigger>
|
||||||
|
<TabsTrigger value="examples">View Examples</TabsTrigger>
|
||||||
|
</TabsList>
|
||||||
|
|
||||||
|
<TabsContent value="demo" class="space-y-4">
|
||||||
|
<!-- List View -->
|
||||||
|
<ListView
|
||||||
|
v-if="currentView === 'list'"
|
||||||
|
:config="listConfig"
|
||||||
|
:data="sampleContacts"
|
||||||
|
:loading="isLoading"
|
||||||
|
selectable
|
||||||
|
@row-click="handleRowClick"
|
||||||
|
@create="handleCreate"
|
||||||
|
@edit="handleEdit"
|
||||||
|
@delete="handleDelete"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<!-- Detail View -->
|
||||||
|
<DetailView
|
||||||
|
v-else-if="currentView === 'detail'"
|
||||||
|
:config="detailConfig"
|
||||||
|
:data="selectedContact"
|
||||||
|
:loading="isLoading"
|
||||||
|
@edit="handleEdit"
|
||||||
|
@delete="() => handleDelete([selectedContact])"
|
||||||
|
@back="handleBack"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<!-- Edit View -->
|
||||||
|
<EditView
|
||||||
|
v-else-if="currentView === 'edit'"
|
||||||
|
:config="editConfig"
|
||||||
|
:data="selectedContact"
|
||||||
|
:loading="isLoading"
|
||||||
|
:saving="isSaving"
|
||||||
|
@save="handleSave"
|
||||||
|
@cancel="handleCancel"
|
||||||
|
@back="handleBack"
|
||||||
|
/>
|
||||||
|
</TabsContent>
|
||||||
|
|
||||||
|
<TabsContent value="examples" class="space-y-6">
|
||||||
|
<div class="grid gap-6">
|
||||||
|
<div class="border rounded-lg p-6 space-y-4">
|
||||||
|
<h3 class="text-xl font-semibold">Available Field Types</h3>
|
||||||
|
<ul class="grid grid-cols-2 md:grid-cols-3 gap-2 text-sm">
|
||||||
|
<li v-for="(value, key) in FieldType" :key="key" class="flex items-center gap-2">
|
||||||
|
<span class="w-2 h-2 bg-primary rounded-full"></span>
|
||||||
|
{{ key }}
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="border rounded-lg p-6 space-y-4">
|
||||||
|
<h3 class="text-xl font-semibold">Usage Example</h3>
|
||||||
|
<pre class="bg-muted p-4 rounded-lg overflow-x-auto text-sm"><code>import { ListView, DetailView, EditView } from '@/components/views'
|
||||||
|
import { FieldType, ViewMode } from '@/types/field-types'
|
||||||
|
|
||||||
|
// Define your fields
|
||||||
|
const fields = [
|
||||||
|
{
|
||||||
|
id: '1',
|
||||||
|
apiName: 'name',
|
||||||
|
label: 'Name',
|
||||||
|
type: FieldType.TEXT,
|
||||||
|
isRequired: true,
|
||||||
|
showOnList: true,
|
||||||
|
showOnDetail: true,
|
||||||
|
showOnEdit: true,
|
||||||
|
},
|
||||||
|
// ... more fields
|
||||||
|
]
|
||||||
|
|
||||||
|
// Create view configs
|
||||||
|
const listConfig = {
|
||||||
|
objectApiName: 'MyObject',
|
||||||
|
mode: ViewMode.LIST,
|
||||||
|
fields,
|
||||||
|
searchable: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
// Use in template
|
||||||
|
<ListView
|
||||||
|
:config="listConfig"
|
||||||
|
:data="records"
|
||||||
|
@row-click="handleRowClick"
|
||||||
|
/></code></pre>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</TabsContent>
|
||||||
|
</Tabs>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
150
frontend/types/field-types.ts
Normal file
150
frontend/types/field-types.ts
Normal file
@@ -0,0 +1,150 @@
|
|||||||
|
/**
|
||||||
|
* Field Type System inspired by Laravel Nova
|
||||||
|
* Defines all available field types and their configurations
|
||||||
|
*/
|
||||||
|
|
||||||
|
export enum FieldType {
|
||||||
|
// Text fields
|
||||||
|
TEXT = 'text',
|
||||||
|
TEXTAREA = 'textarea',
|
||||||
|
PASSWORD = 'password',
|
||||||
|
EMAIL = 'email',
|
||||||
|
|
||||||
|
// Numeric fields
|
||||||
|
NUMBER = 'number',
|
||||||
|
CURRENCY = 'currency',
|
||||||
|
|
||||||
|
// Selection fields
|
||||||
|
SELECT = 'select',
|
||||||
|
MULTI_SELECT = 'multiSelect',
|
||||||
|
BOOLEAN = 'boolean',
|
||||||
|
|
||||||
|
// Date/Time fields
|
||||||
|
DATE = 'date',
|
||||||
|
DATETIME = 'datetime',
|
||||||
|
TIME = 'time',
|
||||||
|
|
||||||
|
// Relationship fields
|
||||||
|
BELONGS_TO = 'belongsTo',
|
||||||
|
HAS_MANY = 'hasMany',
|
||||||
|
MANY_TO_MANY = 'manyToMany',
|
||||||
|
|
||||||
|
// Rich content
|
||||||
|
MARKDOWN = 'markdown',
|
||||||
|
CODE = 'code',
|
||||||
|
|
||||||
|
// File fields
|
||||||
|
FILE = 'file',
|
||||||
|
IMAGE = 'image',
|
||||||
|
|
||||||
|
// Other
|
||||||
|
URL = 'url',
|
||||||
|
COLOR = 'color',
|
||||||
|
JSON = 'json',
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum ViewMode {
|
||||||
|
LIST = 'list',
|
||||||
|
DETAIL = 'detail',
|
||||||
|
EDIT = 'edit',
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FieldOption {
|
||||||
|
label: string;
|
||||||
|
value: string | number | boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FieldValidationRule {
|
||||||
|
type: 'required' | 'min' | 'max' | 'email' | 'url' | 'pattern' | 'custom';
|
||||||
|
value?: any;
|
||||||
|
message?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FieldConfig {
|
||||||
|
// Basic field properties
|
||||||
|
id: string;
|
||||||
|
apiName: string;
|
||||||
|
label: string;
|
||||||
|
type: FieldType;
|
||||||
|
|
||||||
|
// Display properties
|
||||||
|
placeholder?: string;
|
||||||
|
helpText?: string;
|
||||||
|
defaultValue?: any;
|
||||||
|
|
||||||
|
// Validation
|
||||||
|
isRequired?: boolean;
|
||||||
|
isReadOnly?: boolean;
|
||||||
|
validationRules?: FieldValidationRule[];
|
||||||
|
|
||||||
|
// View-specific options
|
||||||
|
showOnList?: boolean;
|
||||||
|
showOnDetail?: boolean;
|
||||||
|
showOnEdit?: boolean;
|
||||||
|
sortable?: boolean;
|
||||||
|
|
||||||
|
// Field type specific options
|
||||||
|
options?: FieldOption[]; // For select, multi-select
|
||||||
|
rows?: number; // For textarea
|
||||||
|
min?: number; // For number, date
|
||||||
|
max?: number; // For number, date
|
||||||
|
step?: number; // For number
|
||||||
|
accept?: string; // For file/image
|
||||||
|
relationObject?: string; // For relationship fields
|
||||||
|
relationDisplayField?: string; // Which field to display for relations
|
||||||
|
|
||||||
|
// Formatting
|
||||||
|
format?: string; // Date format, number format, etc.
|
||||||
|
prefix?: string; // Currency symbol, etc.
|
||||||
|
suffix?: string;
|
||||||
|
|
||||||
|
// Advanced
|
||||||
|
dependsOn?: string[]; // Field dependencies
|
||||||
|
computedValue?: string; // Formula for computed fields
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ViewConfig {
|
||||||
|
objectApiName: string;
|
||||||
|
fields: FieldConfig[];
|
||||||
|
mode: ViewMode;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ListViewConfig extends ViewConfig {
|
||||||
|
mode: ViewMode.LIST;
|
||||||
|
pageSize?: number;
|
||||||
|
searchable?: boolean;
|
||||||
|
filterable?: boolean;
|
||||||
|
exportable?: boolean;
|
||||||
|
actions?: ViewAction[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface DetailViewConfig extends ViewConfig {
|
||||||
|
mode: ViewMode.DETAIL;
|
||||||
|
sections?: FieldSection[];
|
||||||
|
actions?: ViewAction[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface EditViewConfig extends ViewConfig {
|
||||||
|
mode: ViewMode.EDIT;
|
||||||
|
sections?: FieldSection[];
|
||||||
|
submitLabel?: string;
|
||||||
|
cancelLabel?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FieldSection {
|
||||||
|
title?: string;
|
||||||
|
description?: string;
|
||||||
|
fields: string[]; // Field API names
|
||||||
|
collapsible?: boolean;
|
||||||
|
defaultCollapsed?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ViewAction {
|
||||||
|
id: string;
|
||||||
|
label: string;
|
||||||
|
icon?: string;
|
||||||
|
variant?: 'default' | 'destructive' | 'outline' | 'secondary' | 'ghost' | 'link';
|
||||||
|
confirmation?: string;
|
||||||
|
endpoint?: string;
|
||||||
|
handler?: () => void | Promise<void>;
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user