API reference

Every public class of celerik/ui, generated from the PHP code and its docblocks.

Celerik\Ui

• Assets: Renders the tags for the prebuilt bundle (public/celerik.css and public/celerik.js).
• Component: Base class for every Celerik UI component.
• ComponentRegistry: Maps component names to classes. Plugins register their own components here and the matching initializer on the client with Celerik.register(name, fn).

Celerik\Ui\Adapters\Laravel

• CelerikServiceProvider: Auto-discovered through extra.laravel.providers in composer.json.
• EloquentDataSource: Data source for an Eloquent or query builder, e.g. new EloquentDataSource(User::query()).
• EloquentEventSource: Event source for an Eloquent or query builder, e.g. new EloquentEventSource(Meeting::query(), ['start' => 'starts_at', 'end' => 'ends_at']).

Celerik\Ui\Adapters\Laravel\View

• AssetsComponent: <x-celerik-assets /> or <x-celerik-assets theme="material" custom-theme="/css/acme.css" /> — load jQuery and Bootstrap before it.
• CelerikComponent: <x-celerik :component="$grid" />

Celerik\Ui\Adapters\Symfony

• CelerikTwigExtension: {{ celerik_assets() }} or {{ celerik_assets(theme: 'material', customTheme: '/css/acme.css') }} — load jQuery and Bootstrap before it. {{ celerik(grid) }} — renders any Celerik component.
• CelerikUiBundle: Register in config/bundles.php: php Celerik\Ui\Adapters\Symfony\CelerikUiBundle::class => ['all' => true],
• DoctrineDataSource: Data source for a Doctrine ORM query builder, e.g. new DoctrineDataSource($repository->createQueryBuilder('u')->select('u.id, u.name, u.email')).
• DoctrineEventSource: Event source for a Doctrine ORM query builder, e.g. new DoctrineEventSource($repository->createQueryBuilder('m'), ['start' => 'startsAt', 'end' => 'endsAt']).

Celerik\Ui\Components

• Chart: Chart backed by Chart.js.
• FileManager: File manager (elFinder). The connector endpoint runs FileManagerConnector::run().
• Form: Bootstrap form with client-side validation (Parsley.js) and input masks (Inputmask).
• Grid: Data grid backed by DataTables.
• Modal: Bootstrap modal dialog. Bootstrap's JS (the page's bootstrap.bundle) handles opening, focus trapping, Escape and returning focus to the trigger.
• Notification: Toast notifications (Notyf), typically from flash messages after a redirect.
• Scheduler: Scheduler / calendar backed by FullCalendar (MIT plugins only).
• Tabs: Bootstrap tabs following the WAI-ARIA tabs pattern (tablist, tab, tabpanel). Bootstrap's JS switches panels and handles arrow-key navigation.
• ThemeBuilder: Edit a theme's tokens with a live preview of real components and a WCAG contrast report, then export the stylesheet (Theme::toCss()) or the theme JSON.

Celerik\Ui\Components\Form

• Field: A Bootstrap form control with validation rules.

Celerik\Ui\Components\Grid

• Column

Celerik\Ui\Data

• ArrayDataSource: In-memory data source for plain PHP arrays (framework-free apps, fixtures, tests).
• ArrayEventSource: In-memory event source for plain PHP arrays, fixtures and tests.
• DataRequest: Normalized paging, sorting, search and filter parameters.
• DataResult: One page of rows plus the metadata every Celerik endpoint returns:
• DataSourceInterface: A source of rows for data-bound components (Grid today, Scheduler and others later).
• DateRange: The visible date range FullCalendar asks events for: ?start=...&end=... (end exclusive).
• Event: A calendar event, validated on construction and serialized in FullCalendar's format.
• EventResult: Events for one date range, in the standard Celerik envelope:
• EventSourceInterface: A source of calendar events for the Scheduler.

Celerik\Ui\FileManager

• FileManagerConfig: A locked-down elFinder connector configuration for one local folder.
• FileManagerConnector: Runs the elFinder connector (studio-42/elfinder) for one request.

Celerik\Ui\Support

• Arr: Dot-notation helpers for row arrays (user.name reads $row['user']['name']).
• Dates: Strict ISO 8601 date parsing for values coming from requests and databases.
• EditorHtml: Server-side cleaning of rich text editor output (Field::editor()).
• Html: Minimal, escaping-by-default HTML builder used by every component.
• RawHtml: Trusted HTML, inserted as-is where components accept content (Modal, Tabs). Create it with Html::raw() only for markup you control or have sanitized.

Celerik\Ui\Theme

• Console: The celerik-theme command: build a theme stylesheet from theme.json, check its contrast, or start a theme from a preset.
• Contrast: WCAG 2.x contrast checks for theme palettes. The pairs come from theme/contrast.json, which the ThemeBuilder and the tests use too.
• ContrastResult: The contrast of one color pair of a theme, in one mode.
• Stylesheet: Writes a theme's stylesheet: custom properties for the light and dark palettes and the shape tokens, loaded after celerik.css and the base theme's stylesheet.
• Theme: A Celerik theme: design tokens on top of a base look (theme/theme.schema.json).

Celerik\Ui\Upload

• StoredFile: A validated file in its final location.
• UploadException: A rejected upload. The message is safe to show to the user.
• UploadHandler: Validates and stores uploads.
• UploadRules: Which files an upload field accepts: MIME types with their allowed extensions, a size limit and a file count. The same rules drive the field (accept attribute, client-side checks, help text) and the server (UploadHandler).
• UploadedFile: A file received over HTTP, before validation.