Download the PHP package litepie/form without Composer

Litepie Form Builder

Package: litepie/form | Type: Laravel Form Builder | Laravel: 11+ & 12+ | PHP: 8.2+
AI Context: See .ai-context.md for structured package information for AI assistants

A comprehensive, production-ready Laravel form builder package inspired by the original Litepie/Form but completely rewritten for Laravel 12 with modern design patterns and advanced features.

📋 Table of Contents

• Features
• Installation
• Quick Start
• Field Types
• Advanced Features
• Form Container
• Client-Side Integration
• Validation
• File Uploads
• Performance & Caching
• Testing
• API Reference
• Documentation
• Contributing
• Security
• Support

✨ Features

• 🚀 Laravel 12 Ready: Built for Laravel 11+ with full Laravel 12 compatibility
• 🎨 Multiple UI Frameworks: Bootstrap 5, Bootstrap 4, Tailwind CSS, and custom themes
• 📝 30+ Field Types: Complete field library including advanced types like rich text, maps, file uploads
• 🔐 Field Visibility Control: Permission-based, role-based, and conditional field visibility
  • Methods: can(), roles(), visibleWhen(), isVisible()
  • Integration: Works with render(), toArray(), toJson()
• 💾 Performance Caching: User-scoped form caching with TTL support
  • Methods: cache(), cached(), clearCache(), withoutCache()
  • Automatic per-user cache scoping
• 🏗️ Hierarchical Organization: Groups → Sections → Rows → Fields
  • Methods: group(), section(), row(), divider(), endGroup(), endSection()
  • Auto-assignment of fields to active group/section
• 📐 Grid Layout System: Responsive 12-column grid with custom widths
  • Methods: col(), width(), defaultWidth()
  • Output includes width, row, group, section metadata
• ✅ Advanced Validation: Real-time validation, conditional rules, custom validators
• 🔀 Conditional Logic: Dynamic field visibility, validation, and multi-step forms
• 📁 File Management: Drag & drop uploads, image cropping, gallery management, cloud storage
• 📦 Form Container: Manage multiple forms with tabbed, accordion, or stacked interfaces
• ♿ Accessibility: WCAG 2.1 AA compliant with full screen reader support
• ⚡ Performance: Optimized rendering, asset bundling, lazy loading
• 🌐 Client-Side Ready: Full support for Vue.js, React, Angular with toArray() and toJson()
• 🧪 Well Tested: Comprehensive test suite with 95%+ code coverage
• 🎯 Developer Friendly: Fluent API, extensive documentation, helper functions

📦 Installation

Publish the configuration and assets:

Include the CSS and JavaScript assets in your layout:

🚀 Quick Start

Creating Fields

The package provides multiple ways to create fields:

Method 1: Using Field::make() (Recommended)

Method 2: Using Form Builder add() method

Method 3: Using Specific Field Classes

Basic Contact Form

Registration Form with File Upload

Helper Functions

Field Visibility & Permissions

Control field visibility based on user permissions and roles:

See VISIBILITY.md for complete visibility control documentation.

Performance: Caching Form Output

Enable caching for forms that don't change frequently:

Use caching for:

• Forms with many fields and complex visibility logic
• API endpoints serving the same form to many users
• Admin panels with heavy permission checks

Grid Layout & Column Width

Control field widths for responsive grid layouts (works with Bootstrap, Tailwind, or any frontend):

Frontend Implementation:

Hierarchical Form Organization (Groups, Sections, Rows)

Organize complex forms with a hierarchical structure: Form → Groups → Sections → Rows → Fields

Key Features:

• Groups: Top-level organization with titles and descriptions
• Sections: Sub-groups within groups (can have multiple sections per group)
• Rows: Layout containers for fields with column widths
• Dividers: Visual separators with optional labels
• Auto-assignment: Fields added after group() or section() automatically inherit the group/section
• Flexible nesting: Mix grouped and ungrouped fields in the same form

Alternative Syntax (without fluent methods):

Output Structure (toArray/toJson):

Frontend Rendering:

Divider Types:

📝 Field Types

'required' => true

]);

// Form container $container = form_container('my-container');

// Quick container creation $quickContainer = form_container_quick([ 'form1' => [ 'fields' => ['name' => 'text', 'email' => 'email'], 'containerOptions' => ['title' => 'Contact Info'] ] ], ['name' => 'Multi-Form Container', 'tabbed' => true]); blade @extends('layouts.app')

@section('content')

@endsection

@push('styles') {!! form_include_assets(true, false) !!} @endpush

@push('scripts') {!! form_include_assets(false, true) !!} @endpush vue

blade

javascript document.addEventListener('form:validation:success', function(event) { console.log('Form validated successfully', event.detail); });

document.addEventListener('form:validation:error', function(event) { console.log('Validation errors', event.detail.errors); }); bash

Run all tests

composer test

Run specific test suite

composer test -- --filter=FormBuilderTest

Run with coverage

composer test -- --coverage-html coverage bash git clone https://github.com/litepie/form.git cd form composer install composer test bash composer format # Fix code style composer format:check # Check code style composer analyse # Static analysis composer ci # Run all checks

## 📄 License

The MIT License (MIT). Please see [LICENSE](LICENSE) for more information.

## ⚡ Performance & Caching

### Caching Support

Form containers support comprehensive caching to improve performance:

### Cache Configuration

Add to your `config/form.php`:

### Cache Benefits

- **50-90% faster rendering** for complex forms
- **Reduced server load** with cached HTML output
- **Automatic invalidation** when forms are modified
- **Tagged cache** for efficient bulk clearing
- **Multiple drivers** (file, redis, memcached)

For detailed caching documentation, see [doc/caching.md](doc/caching.md).

## � Documentation

- **[Examples](doc/examples.md)** - Comprehensive examples for all field types and features
- **[Container Examples](doc/container-examples.md)** - Multi-form container usage and patterns
- **[Client-Side Examples](doc/client-side-examples.md)** - JavaScript integration and API usage
- **[Caching Guide](doc/caching.md)** - Performance optimization with caching

## �🔒 Security

If you discover security vulnerabilities, please send an email to [email protected] instead of using the issue tracker.

## 📞 Support

- 📖 [Documentation](https://litepie.com/docs/form)
- 🐛 [Issue Tracker](https://github.com/Litepie/Form/issues)
- 💬 [Discussions](https://github.com/Litepie/Form/discussions)
- 📧 [Email Support](mailto:[email protected])

---

## 🏢 About

This package is part of the **Litepie** ecosystem, developed by **Renfos Technologies**. 

### Organization Structure
- **Vendor:** Litepie
- **Framework:** Lavalite
- **Company:** Renfos Technologies

### Links & Resources
- 🌐 **Website:** [https://lavalite.org](https://lavalite.org)
- 📚 **Documentation:** [https://docs.lavalite.org](https://docs.lavalite.org)
- 💼 **Company:** [https://renfos.com](https://renfos.com)
- 📧 **Support:** [[email protected]](mailto:[email protected])

---

## 🤖 For AI Assistants

<!-- AI-METADATA-START -->
**Quick Context File**: [.ai-context.md](.ai-context.md) - Comprehensive package structure and patterns  
**Architecture Pattern**: Fluent Builder + Factory + Service Provider  
**Key Classes**: `FormBuilder`, `Field`, `FormRenderer`, `FormValidator`  
**Main Features**: Visibility Control, Caching, Hierarchical Organization, Grid Layout  
**Output Formats**: HTML (`render()`), Array (`toArray()`), JSON (`toJson()`)  
**Integration**: Laravel 11+/12+, Bootstrap/Tailwind, Vue/React/Angular  

**Common User Requests**:
- "Create form" → `Form::create()->add()->render()`
- "Hide field from users" → `->can('permission')` or `->roles(['admin'])`
- "Improve performance" → `->cache(ttl)`
- "Responsive layout" → `->row([Field::text()->col(6), ...])`
- "Complex sections" → `->group()->section()->row()`
- "JSON for frontend" → `->toArray()` or `->toJson()`
<!-- AI-METADATA-END -->

---

<div align="center">
  <p><strong>Built with ❤️ by Renfos Technologies</strong></p>
  <p><em>Empowering developers with robust Laravel solutions</em></p>
</div>