README

Laravel/PHP Composer package providing standardized DTOs and helper functions for the react-ubiquitous UI Config API.

The backend produces a UIStageConfig JSON tree; the react-ubiquitous frontend renders it without any code changes.

Requirements

• PHP 8.1+
• Composer

Installation

composer require nssivanitesh/react-ubiquitous-composer

If you are using Laravel, the ReactUbiquitousServiceProvider is auto-discovered via the extra.laravel section of composer.json.

Core Concepts

The JSON object hierarchy is:

UIStageConfig
 └─ UIPageConfig[]
     └─ UISectionConfig[]   (flex | grid | hero | table | chart | …)
         └─ UIElementConfig[]  (input | select | button | …)

Every class implements toArray() which returns the exact JSON shape expected by the frontend.

Quick Start

use ReactUbiquitous\Helpers\UIHelper;
use ReactUbiquitous\DTOs\Sections\FlexSectionConfig;
use ReactUbiquitous\DTOs\Sections\TableSectionConfig;
use ReactUbiquitous\DTOs\Elements\InputElementConfig;
use ReactUbiquitous\DTOs\Elements\ButtonElementConfig;
use ReactUbiquitous\DTOs\Supporting\TableColumn;
use ReactUbiquitous\Enums\UITheme;

// Build a stage with one page containing a flex section
$stage = UIHelper::stage('my-app')
    ->title('My Application')
    ->theme(UITheme::Light)
    ->addPage(
        UIHelper::page('home', 'Home', 1)
            ->addSection(new FlexSectionConfig(
                id: 'search-bar',
                elements: [
                    new InputElementConfig(
                        id: 'q',
                        name: 'q',
                        inputType: 'text',
                        placeholder: 'Search…',
                        label: 'Search',
                    ),
                    new ButtonElementConfig(
                        id: 'btn-search',
                        name: 'btn-search',
                        text: 'Search',
                        buttonType: 'submit',
                    ),
                ],
                gap: '1rem',
            ))
            ->build()
    )
    ->build();

// Serialize to JSON
return response()->json($stage->toArray());

Validation Builder

use ReactUbiquitous\Helpers\UIHelper;
use ReactUbiquitous\DTOs\Elements\InputElementConfig;

$validations = UIHelper::validation()
    ->required()
    ->email('Please enter a valid email address.')
    ->build();

$emailField = new InputElementConfig(
    id: 'email',
    name: 'email',
    inputType: 'email',
    label: 'Email',
    validations: $validations,
);

DTOs Reference

Testing

composer install
./vendor/bin/phpunit

Local Development with Laravel Sail

This package ships with a Docker Compose configuration that gives you a PHP 8.2 environment without needing PHP installed on your host machine — similar to how Laravel Sail works for full Laravel applications.

Prerequisites

• Docker Desktop (or Docker Engine + Compose plugin)

First-time setup

# Build the image and install Composer dependencies
docker compose build
docker compose run --rm php composer install

Running tests

docker compose run --rm php ./vendor/bin/phpunit

Opening an interactive shell

docker compose run --rm php bash

Running any Composer command

docker compose run --rm php composer <command>

Changelog

See CHANGELOG.md.

License

MIT — see LICENSE.