Skip to content

README_FIELDS.md

Latest commit

 

History

History
352 lines (331 loc) · 48.9 KB

README_FIELDS.md

File metadata and controls

352 lines (331 loc) · 48.9 KB
Raw

JCB! Fields

What Are Fields?

Fields are the foundation of every Joomla Component Builder (JCB) project.

They define how data is stored, validated, rendered, and interacted with in your Joomla extensions.

Fields let you control everything from the underlying database schema to the user interface, all within a single configuration.

Each Field:

  • Defines database structure (type, size, default, null, unique keys, indexes)
  • Binds to a fieldtype, determining HTML rendering and behavior
  • Supports per-field custom PHP for model saving and retrieval
  • Allows styling and scripting (HTML attributes, JS, CSS)
  • Automatically generates Joomla-compliant XML field definitions

Where Are Fields Used in JCB?

Fields are universal integrated — they are used in, highly structured areas:

  • ✅ Admin Views (the native Joomla back-end editing views)
  • ✅ Modules (frontend display configurations)
  • ✅ Plugins (event-driven integrations)
  • ✅ Component Configurations (global parameter settings)

What Can a Field Do?

A Field in JCB can define:

  • Database Type & Schema: int, varchar, json, custom, nullable, defaults, indexes
  • Permissions: who can view/edit the field (ACL)
  • Rendering Options: HTML classes, labels, JS behaviors
  • Model Integration: how the value is saved or retrieved
  • Dynamic Logic: PHP hooks for onGet, onSave, onPrepareForm, etc.
  • Fieldtypes: link to rich behaviors like Model Selects, Subforms, Toggle Switches, Encrypted Fields, etc.

This centralization makes field management efficient and highly reusable.

Reuse and Sharing

Fields are standalone entities:

  • Define once, reuse across multiple Admin Views, Modules, or Plugins
  • Fields can also be exported and shared via repositories
  • JCB will automatically adjust them to fit into each consuming context

This means less duplication, and greater consistency across your entire component structure.

Versioning and Customization

To update a field:

  • Click "reset" in the JCB UI to sync with this repository
  • Or fork this repository, customize the field, and point JCB to your fork

This preserves version control while allowing your own field improvements to live independently.

Fields define both structure and behavior — they are where your data comes alive.

Index of Fields

All used in Joomla Component Builder - Source - Mirror - Download

Joomla Volunteer Portal Octoleo Llewellyn Telegram Mastodon X (Twitter) GitHub YouTube n8n Docker Hub Open Collective GPG Key