PHPackages                             hananils/kirby-checkbox-field - 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. [Utility & Helpers](/categories/utility)
4. /
5. hananils/kirby-checkbox-field

ActiveKirby-plugin[Utility & Helpers](/categories/utility)

hananils/kirby-checkbox-field
=============================

Checkbox is a simple field that is a companion of the core toggle field. It offers a single checkbox with label and info text and can be used wherever a single option is required and the "on" and "off" metaphor of a toggle does not suit well.

1.0.0(10mo ago)14MITPHPPHP ^8.2

Since Jun 25Pushed 2mo ago2 watchersCompare

[ Source](https://github.com/hananils/kirby-checkbox-field)[ Packagist](https://packagist.org/packages/hananils/kirby-checkbox-field)[ Docs](https://kirby.hananils.de/plugins/checkbox-field)[ RSS](/packages/hananils-kirby-checkbox-field/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (2)Versions (2)Used By (0)

[![Kirby Checkbox Field](.github/title.png)](.github/title.png)

Checkbox is a simple field for Kirby that is a companion of the core toggle field. It offers a single checkbox with label and info text and can be used wherever a single option is required and the "on" and "off" metaphor of a toggle does not suit well.

Note

Please check out the online documentation at [kirby.hananils.de/plugins/checkbox-field](https://kirby.hananils.de/plugins/checkbox-field) for further information.

Introduction
============

[](#introduction)

Toggles – like [the core field](https://getkirby.com/docs/reference/panel/fields/toggle) – and checkboxes have a lot in common as they both allow users to change the state of a setting. The mental models behind both concepts are different though. While a toggle usually conveys an immediate action, switching a setting "on" or "off" like a lightbulb, ticking a checkbox does not imply an action but communicates consent or disconsent. "Do you agree to the terms of service?" Yes or no.

For all use cases where you don't want to toggle a switch but what to represent a content choice, this field is for you.

Tip

Do you think this should be a core field, too? [Go and tell the Kirby team!](https://feedback.getkirby.com/)

Example
-------

[](#example)

The field setup is minimal:

```
checkbox:
  type: checkbox
  label: I like ticking boxes
  info: You can untick the box again later if you changed your mind.

```

Please note that the label for this field is not displayed above the field but beside the checkbox itself. The label thus represents the option the editor checks or unchecks.

Templating
----------

[](#templating)

Just like with the toggle field, a checkbox value can be converted to a proper boolean:

```
$bool = $page->checkbox()->toBool();
```

And the field methods `isTrue` and `isFalse` can be used to validate a setting and:

```
if ($page->checkbox()->isTrue()) {
  // do something
}

```

Installation
------------

[](#installation)

### Download

[](#download)

Download and copy this repository to `/site/plugins/checkbox-field`.

### Git submodule

[](#git-submodule)

```
git submodule add https://github.com/hananils/kirby-checkbox-field.git site/plugins/checkbox-field

```

### Composer

[](#composer)

```
composer require hananils/kirby-checkbox-field

```

License
=======

[](#license)

This plugin is provided freely under the [MIT license](LICENSE.md) by [hana+nils · Büro für Gestaltung](https://hananils.de).
We create visual designs for digital and analog media.

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance73

Regular maintenance activity

Popularity6

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

322d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e0465cfa7ef2b9a264429068ddfeb765f3881f9c611048d2e7e95dfad4afbb35?d=identicon)[hananils](/maintainers/hananils)

---

Top Contributors

[![nilshoerrmann](https://avatars.githubusercontent.com/u/25466?v=4)](https://github.com/nilshoerrmann "nilshoerrmann (9 commits)")

###  Code Quality

Static AnalysisRector

### Embed Badge

![Health badge](/badges/hananils-kirby-checkbox-field/health.svg)

```
[![Health](https://phpackages.com/badges/hananils-kirby-checkbox-field/health.svg)](https://phpackages.com/packages/hananils-kirby-checkbox-field)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)