PHPackages arnoson/kirby-form-builder - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. arnoson/kirby-form-builder ActiveKirby-plugin arnoson/kirby-form-builder ========================== Form builder and handler for Kirby 5 0.9.2(1mo ago)23245[5 issues](https://github.com/arnoson/kirby-form-builder/issues)MITPHPCI passing Since Jun 22Pushed 1mo ago4 watchersCompare [ Source](https://github.com/arnoson/kirby-form-builder)[ Packagist](https://packagist.org/packages/arnoson/kirby-form-builder)[ RSS](/packages/arnoson-kirby-form-builder/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (6)Versions (30)Used By (0) ![](./.github/logo-light.svg?2) Kirby Form Builder ================== [](#kirby-form-builder) A flexible form builder and handler based on Kirby's layout and block fields and [Kirby Uniform](https://github.com/mzur/kirby-uniform/). > **⚠️ Repository Renamed** > > This repository was renamed from `kirby-forms` to `kirby-form-builder` in version `0.0.9`. Please update your dependencies and config options accordingly, see [release note](https://github.com/arnoson/kirby-form-builder/releases/tag/v0.9.0). Features -------- [](#features) - 🎨 Form builder using Kirby's built-in layout and blocks fields - 🔒 Form handling using [Kirby Uniform](https://github.com/mzur/kirby-uniform/) - ✔️ Client-side and server-side validation - 📋 View entries directly in the panel - 📬 Send confirmation and notification emails - 🔗 Use Post/Redirect/Get pattern to avoid multiple submission Demo ---- [](#demo) kirby-forms-demo.mp4 Installation ------------ [](#installation) Make sure you have [Kirby Uniform](https://github.com/mzur/kirby-uniform/) installed, then install the plugin using Composer: ``` composer require arnoson/kirby-form-builder ``` Getting started --------------- [](#getting-started) The quickest way to get started is creating a new page with the `form` blueprint provided by the plugin. Now you can build your form in the panel. To render the `form`, use the form snippet inside your template: ``` snippet('form'); ``` Options ------- [](#options) Most options (success message, confirmation emails, ...) can be configured per form direcly in the panel in the form's `Settings` tab. These global options can only be set in the plugin's config: ``` 'arnoson.kirby-form-builder' => [ // A list of email addresses that can be selected in the panel as the sender // of confirmation and notification emails. 'fromEmails' => [], // Wether or not to use client validation (in addition to server-side // validation done by Kirby Uniform). 'clientValidation' => true, // How many columns to use for the grid that determines the layout of the // form. see: https://getkirby.com/docs/reference/panel/fields/layout#calculate-the-column-span-value 'gridColumns' => 12, // Wether or not to use the `autocomplete` attribute for the form element. 'autoComplete' => false, // Automatically add an empty placeholder to fields without a defined // placeholder in the panel. This is useful for css styling relying on // `input:placeholder-shown`. 'addEmptyPlaceholder' => false, // When using the brevo action. // Note: do not hardcode your API key, use an .env file instead. 'brevoApiKey' => '1234', ] ``` Entries ------- [](#entries) Form entries will be saved directly in the form page and can be viewed/deleted/edited in the panel: [![screely-1728499707485](https://private-user-images.githubusercontent.com/15122993/375093355-36a44b02-10ec-4806-870d-2de324604e90.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzU0Mzc5MTAsIm5iZiI6MTc3NTQzNzYxMCwicGF0aCI6Ii8xNTEyMjk5My8zNzUwOTMzNTUtMzZhNDRiMDItMTBlYy00ODA2LTg3MGQtMmRlMzI0NjA0ZTkwLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA0MDYlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNDA2VDAxMDY1MFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTRhN2M1MGY0MDY2MGU5OTliNzU0NjEyZDFkMDM4Njk2YTgzYTk0Njg2MGFlNTQ4ZDI0ZDBlOTA4ZTcyYTJkYzAmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.T0wg2nBPPicT6qsmA8EeTCwKK9nq-WsorqSqmNEv8U8)](https://private-user-images.githubusercontent.com/15122993/375093355-36a44b02-10ec-4806-870d-2de324604e90.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzU0Mzc5MTAsIm5iZiI6MTc3NTQzNzYxMCwicGF0aCI6Ii8xNTEyMjk5My8zNzUwOTMzNTUtMzZhNDRiMDItMTBlYy00ODA2LTg3MGQtMmRlMzI0NjA0ZTkwLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA0MDYlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNDA2VDAxMDY1MFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTRhN2M1MGY0MDY2MGU5OTliNzU0NjEyZDFkMDM4Njk2YTgzYTk0Njg2MGFlNTQ4ZDI0ZDBlOTA4ZTcyYTJkYzAmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.T0wg2nBPPicT6qsmA8EeTCwKK9nq-WsorqSqmNEv8U8) Using Different Layouts ----------------------- [](#using-different-layouts) By creating your own `fields/form-fields` blueprint, you can overwrite the possible layouts in the form builder. Use this [file](https://github.com/arnoson/kirby-form-builder/blob/master/blueprints/fields/form-fields.yml) as a starting point. Run Additional Actions ---------------------- [](#run-additional-actions) You can run additional actions on a per form basis. Just return an array of actions from the form's page model. See [form-workshop.php](https://github.com/arnoson/kirby-form-builder/blob/main/example/site/models/form-workshop.php) for a complete example. ``` // site/models/form.php // Define your own action or use any Kirby Uniform action instead. class MyAction extends Uniform\Actions\Action { public function perform() { $page = $this->option('page'); $form = $this->form; // Do something with the form or form page ... } } class FormPage extends Kirby\Cms\Page { public function actions() { return [MyAction::class]; } } ``` Adding Custom Fields -------------------- [](#adding-custom-fields) The easiest way to add your own custom fields is to start with the [example](https://github.com/arnoson/kirby-form-builder/tree/master/example/site/plugins/custom-form-fields). Custom fields consist of - A block blueprint (defining the field settings like `required`, `min`, `max`, ...) - A block snippet (to render the fields on the form) The block name must follow the naming convention of `form-field-`, where `` is a [panel field](https://getkirby.com/docs/reference/panel/fields), used to render the field's value in the [Entries](#entries) view. Ideally, a custom field should also have a [block preview](https://getkirby.com/docs/cookbook/panel/custom-block-type#simple-index-js). To show your custom field as an option in the Kirby Form Builder form builder, you have to override the `fields/form-fields` blueprint, see the [example](https://github.com/arnoson/kirby-form-builder/tree/master/example/site/blueprints/fields/form-fields.yml). Contribute ---------- [](#contribute) Contributions to the plugin and it's documentation are welcome :~) Please make sure you: - use prettier to format your code (should happen automatically if you work on this project in VSCode) - use [conventional commits](https://www.conventionalcommits.org) (these are used to automatically generate release messages, including credits for your contributions) To get started have a look at the `package.json`. ### Health Score 46 — FairBetter than 93% of packages Maintenance88 Actively maintained with recent releases Popularity20 Limited adoption so far Community17 Small or concentrated contributor base Maturity52 Maturing project, gaining track record Bus Factor1 Top contributor holds 65.5% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~62 days Recently: every ~51 days Total 29 Last Release 38d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/6d95ad9b77de39a85a0f39a1cc84535de5affc9aa1150862252681972f4215d9?d=identicon)[arnoson](/maintainers/arnoson) --- Top Contributors [![arnoson](https://avatars.githubusercontent.com/u/15122993?v=4)](https://github.com/arnoson "arnoson (36 commits)")[![fmujakitz](https://avatars.githubusercontent.com/u/17797495?v=4)](https://github.com/fmujakitz "fmujakitz (8 commits)")[![andrepimpao](https://avatars.githubusercontent.com/u/41913452?v=4)](https://github.com/andrepimpao "andrepimpao (4 commits)")[![ceesvanegmond](https://avatars.githubusercontent.com/u/883497?v=4)](https://github.com/ceesvanegmond "ceesvanegmond (4 commits)")[![AlexanderBoenninger](https://avatars.githubusercontent.com/u/56273185?v=4)](https://github.com/AlexanderBoenninger "AlexanderBoenninger (2 commits)")[![mprofitlich](https://avatars.githubusercontent.com/u/6146601?v=4)](https://github.com/mprofitlich "mprofitlich (1 commits)") ### Embed Badge ![Health badge](/badges/arnoson-kirby-form-builder/health.svg) ``` [![Health](https://phpackages.com/badges/arnoson-kirby-form-builder/health.svg)](https://phpackages.com/packages/arnoson-kirby-form-builder) ``` ### Alternatives [getkirby/cms The Kirby core 1.5k535.5k350](/packages/getkirby-cms)[distantnative/retour-for-kirby Manage redirects and track 404s right from the Kirby CMS Panel 14689.4k1](/packages/distantnative-retour-for-kirby)[arnoson/kirby-vite Vite helper for Kirby CMS 9759.2k3](/packages/arnoson-kirby-vite)[getkirby/staticache Static site performance on demand 9615.4k](/packages/getkirby-staticache)[fabianmichael/kirby-meta Your all-in-one powerhouse for any SEO and metadata needs imaginable. 6910.7k1](/packages/fabianmichael-kirby-meta)[thathoff/kirby-oauth Kirby OAuth 2 Plugin 3823.9k](/packages/thathoff-kirby-oauth) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)