Add Boolean property type

malberts · claude · malberts · commit 652b3a066fcd · 2026-05-22T20:59:46.000+02:00
Adds a `boolean` property type for true/false values, mirroring the
recently-merged Select pattern. `BooleanValue` and the
`ValueType::Boolean` deserialization path already existed in both PHP
and TS; this PR adds the type wrapper, property definition, schema and
subject UI, and registration.

Schema JSON: `{ "type": "boolean" }`. No type-specific attributes;
`default` may be `true`, `false`, or `null`. The construction-time check
rejects non-boolean defaults, slightly stricter than siblings.

`BooleanInput` always emits a `BooleanValue`, so a Boolean field is
never "unset" once interacted with. The input renders as a single
inline `label [switch]` row to match the `Require a value` row directly
above it in the schema editor.

Demo data: `Is public` on the Company schema (true on ACME Inc), plus
three Boolean variants in the Everything showcase schema.

Co-Authored-By: Claude Opus 4.7 (1M context) &lt;noreply@anthropic.com&gt;
diff --git a/DemoData/Schema/Company.json b/DemoData/Schema/Company.json
@@ -48,6 +48,9 @@
 		"World domination progress": {
 			"type": "number",
 			"default": 0
+		},
+		"Is public": {
+			"type": "boolean"
 		}
 	}
 }
diff --git a/DemoData/Schema/Everything.json b/DemoData/Schema/Everything.json
@@ -81,6 +81,17 @@
 			],
 			"multiple": true
 		},
+		"boolean/boolean": {
+			"type": "boolean"
+		},
+		"boolean/boolean (default true)": {
+			"type": "boolean",
+			"default": true
+		},
+		"boolean/boolean (default false)": {
+			"type": "boolean",
+			"default": false
+		},
 		"relation/relation": {
 			"type": "relation",
 			"relation": "Has product",
diff --git a/DemoData/Subject/ACME_Inc.json b/DemoData/Subject/ACME_Inc.json
@@ -23,6 +23,10 @@
 					"type": "number",
 					"value": 42
 				},
+				"Is public": {
+					"type": "boolean",
+					"value": true
+				},
 				"Products": {
 					"type": "relation",
 					"value": [
diff --git a/docs/reference/schema-format.md b/docs/reference/schema-format.md
@@ -199,6 +199,29 @@ Example:
 }
 ```
 
+### Boolean (`boolean`)
+
+A true/false value, edited via a toggle switch and displayed as "Yes" or "No".
+
+```json
+{
+  "type": "boolean"
+}
+```
+
+This type has no type-specific fields beyond the [common fields](#common-fields).
+The `default` may be `true`, `false`, or `null` (no default).
+
+Example:
+
+```json
+{
+  "type": "boolean",
+  "default": false,
+  "description": "Whether the company is publicly traded"
+}
+```
+
 ## Reserved Property Types
 
 The following types are defined in the JSON schema but not yet implemented:
@@ -211,7 +234,6 @@ The following types are defined in the JSON schema but not yet implemented:
 - `duration` - Time durations
 - `currency` - Monetary values
 - `progress` - Progress indicators
-- `checkbox` - Boolean checkbox
 
 ## REST API
 
diff --git a/extension.json b/extension.json
@@ -308,6 +308,9 @@
 				"neowiki-property-type-select",
 				"neowiki-property-type-datetime",
 				"neowiki-property-type-date",
+				"neowiki-property-type-boolean",
+				"neowiki-boolean-true",
+				"neowiki-boolean-false",
 				"neowiki-infobox-type",
 				"neowiki-infobox-edit-link",
 				"neowiki-field-required",
diff --git a/i18n/en.json b/i18n/en.json
@@ -20,6 +20,9 @@
 	"neowiki-property-type-select": "Select",
 	"neowiki-property-type-datetime": "Date & Time",
 	"neowiki-property-type-date": "Date",
+	"neowiki-property-type-boolean": "Boolean",
+	"neowiki-boolean-true": "Yes",
+	"neowiki-boolean-false": "No",
 
 	"neowiki-neojson-description": "Editing neo slot of \"$1\"",
 
diff --git a/i18n/qqq.json b/i18n/qqq.json
@@ -144,6 +144,9 @@
 	"neowiki-property-type-datetime": "Label for the date and time property type in the schema editor",
 	"neowiki-field-invalid-date": "Validation error shown when the entered date value cannot be parsed. Date values must be strict ISO 8601 calendar dates in YYYY-MM-DD form with no time or timezone component (for example, '2025-06-15'). Values with a time part, partial values such as year-only, and calendar overflows such as '2025-02-30' are rejected, and min/max bounds are inclusive.",
 	"neowiki-property-type-date": "Label for the date (without time) property type in the schema editor",
+	"neowiki-property-type-boolean": "Label for the boolean (true/false) property type shown in the property type selector.",
+	"neowiki-boolean-true": "Label shown in the value display for a boolean property whose value is true (e.g. in the infobox or schema-table 'Initial value' column).",
+	"neowiki-boolean-false": "Label shown in the value display for a boolean property whose value is false (e.g. in the infobox or schema-table 'Initial value' column).",
 	"neowiki-select-unknown-option": "Placeholder shown in a select-property display when a stored option ID cannot be resolved to a label (e.g. the option was removed from the Schema).",
 
 	"neowiki-managesubjects-tab": "Label for the Data tab that appears alongside the standard action tabs (View, Edit, History) on content pages, linking to the Subject management page.",
diff --git a/resources/ext.neowiki/src/Neo.ts b/resources/ext.neowiki/src/Neo.ts
@@ -5,6 +5,7 @@ import { RelationType } from '@/domain/propertyTypes/Relation';
 import { UrlType } from '@/domain/propertyTypes/Url';
 import { DateTimeType } from '@/domain/propertyTypes/DateTime';
 import { DateType } from '@/domain/propertyTypes/Date';
+import { BooleanType } from '@/domain/propertyTypes/Boolean';
 import { PropertyTypeRegistry } from '@/domain/PropertyType';
 import { PropertyDefinitionDeserializer } from '@/domain/PropertyDefinition';
 import { ValueDeserializer } from '@/persistence/ValueDeserializer';
@@ -33,6 +34,7 @@ export class Neo {
 		registry.registerType( new TextType() );
 		registry.registerType( new NumberType() );
 		registry.registerType( new SelectType() );
+		registry.registerType( new BooleanType() );
 		registry.registerType( new RelationType() );
 		registry.registerType( new UrlType() );
 		registry.registerType( new DateTimeType() );
diff --git a/resources/ext.neowiki/src/NeoWikiExtension.ts b/resources/ext.neowiki/src/NeoWikiExtension.ts
@@ -12,6 +12,8 @@ import SelectDisplay from '@/components/Value/SelectDisplay.vue';
 import { RelationType } from '@/domain/propertyTypes/Relation.ts';
 import { DateTimeType } from '@/domain/propertyTypes/DateTime.ts';
 import { DateType } from '@/domain/propertyTypes/Date.ts';
+import { BooleanType } from '@/domain/propertyTypes/Boolean.ts';
+import BooleanDisplay from '@/components/Value/BooleanDisplay.vue';
 import { TypeSpecificComponentRegistry } from '@/TypeSpecificComponentRegistry.ts';
 import { ViewTypeRegistry } from '@/ViewTypeRegistry.ts';
 import Infobox from '@/components/Views/Infobox.vue';
@@ -20,6 +22,7 @@ import DateTimeDisplay from '@/components/Value/DateTimeDisplay.vue';
 import DateTimeInput from '@/components/Value/DateTimeInput.vue';
 import DateDisplay from '@/components/Value/DateDisplay.vue';
 import DateInput from '@/components/Value/DateInput.vue';
+import BooleanInput from '@/components/Value/BooleanInput.vue';
 import { HttpClient } from '@/infrastructure/HttpClient/HttpClient';
 import { ProductionHttpClient } from '@/infrastructure/HttpClient/ProductionHttpClient';
 import { RestSchemaRepository } from '@/persistence/RestSchemaRepository.ts';
@@ -48,14 +51,15 @@ import { MediaWikiPageSaver } from '@/persistence/MediaWikiPageSaver.ts';
 import { SubjectDeserializer } from '@/persistence/SubjectDeserializer.ts';
 import { Neo } from '@/Neo.ts';
 // import { cdxIconStringInteger } from '@/assets/CustomIcons.ts';
-import { cdxIconLink, cdxIconSearchCaseSensitive, cdxIconArticles, cdxIconListBullet, cdxIconMathematics, cdxIconClock, cdxIconCalendar } from '@wikimedia/codex-icons';
+import { cdxIconLink, cdxIconSearchCaseSensitive, cdxIconArticles, cdxIconListBullet, cdxIconMathematics, cdxIconClock, cdxIconCalendar, cdxIconCheck } from '@wikimedia/codex-icons';
 import TextAttributesEditor from '@/components/SchemaEditor/Property/TextAttributesEditor.vue';
 import NumberAttributesEditor from '@/components/SchemaEditor/Property/NumberAttributesEditor.vue';
 import SelectAttributesEditor from '@/components/SchemaEditor/Property/SelectAttributesEditor.vue';
 import UrlAttributesEditor from '@/components/SchemaEditor/Property/UrlAttributesEditor.vue';
 import RelationAttributesEditor from '@/components/SchemaEditor/Property/RelationAttributesEditor.vue';
 import DateTimeAttributesEditor from '@/components/SchemaEditor/Property/DateTimeAttributesEditor.vue';
 import DateAttributesEditor from '@/components/SchemaEditor/Property/DateAttributesEditor.vue';
+import BooleanAttributesEditor from '@/components/SchemaEditor/Property/BooleanAttributesEditor.vue';
 import { SubjectValidator } from '@/domain/SubjectValidator.ts';
 import { PropertyTypeRegistry } from '@/domain/PropertyType.ts';
 import { StoreStateLoader } from '@/persistence/StoreStateLoader.ts';
@@ -138,6 +142,14 @@ export class NeoWikiExtension {
 			icon: cdxIconCalendar,
 		} );
 
+		registry.registerType( BooleanType.typeName, {
+			valueDisplayComponent: BooleanDisplay,
+			valueEditor: BooleanInput,
+			attributesEditor: BooleanAttributesEditor,
+			label: 'neowiki-property-type-boolean',
+			icon: cdxIconCheck,
+		} );
+
 		return registry;
 	}
 
diff --git a/resources/ext.neowiki/src/components/SchemaEditor/Property/BooleanAttributesEditor.vue b/resources/ext.neowiki/src/components/SchemaEditor/Property/BooleanAttributesEditor.vue
@@ -0,0 +1,13 @@
+<template>
+	<!-- cdx-field class is used for spacing -->
+	<!-- Boolean properties have no type-specific attributes. -->
+	<div class="boolean-attributes cdx-field" />
+</template>
+
+<script setup lang="ts">
+import { BooleanProperty } from '@/domain/propertyTypes/Boolean.ts';
+import { AttributesEditorEmits, AttributesEditorProps } from '@/components/SchemaEditor/Property/AttributesEditorContract.ts';
+
+defineProps<AttributesEditorProps<BooleanProperty>>();
+defineEmits<AttributesEditorEmits<BooleanProperty>>();
+</script>
diff --git a/resources/ext.neowiki/src/components/Value/BooleanDisplay.vue b/resources/ext.neowiki/src/components/Value/BooleanDisplay.vue
@@ -0,0 +1,24 @@
+<template>
+	<div>
+		{{ displayText }}
+	</div>
+</template>
+
+<script setup lang="ts">
+import { computed } from 'vue';
+import { ValueType } from '@/domain/Value.ts';
+import { BooleanProperty } from '@/domain/propertyTypes/Boolean.ts';
+import { ValueDisplayProps } from '@/components/Value/ValueDisplayContract.ts';
+
+const props = defineProps<ValueDisplayProps<BooleanProperty>>();
+
+const displayText = computed( (): string => {
+	if ( props.value.type !== ValueType.Boolean ) {
+		return '';
+	}
+
+	return props.value.boolean ?
+		mw.message( 'neowiki-boolean-true' ).text() :
+		mw.message( 'neowiki-boolean-false' ).text();
+} );
+</script>
diff --git a/resources/ext.neowiki/src/components/Value/BooleanInput.vue b/resources/ext.neowiki/src/components/Value/BooleanInput.vue
@@ -0,0 +1,86 @@
+<template>
+	<CdxField
+		:status="validationError === null ? 'default' : 'error'"
+		:messages="validationError === null ? {} : { error: validationError }"
+		:hide-label="true"
+	>
+		<CdxToggleSwitch
+			:model-value="internalValue"
+			:align-switch="true"
+			:label="props.label"
+			@update:model-value="onInput"
+		>
+			{{ props.label }}
+			<CdxIcon
+				v-if="props.property.description"
+				v-tooltip="props.property.description"
+				:icon="cdxIconInfo"
+				class="ext-neowiki-value-input__description-icon"
+				size="small"
+			/>
+		</CdxToggleSwitch>
+	</CdxField>
+</template>
+
+<script lang="ts">
+import type { Value } from '@/domain/Value';
+</script>
+
+<script setup lang="ts">
+import { ref, watch } from 'vue';
+import { CdxField, CdxIcon, CdxToggleSwitch } from '@wikimedia/codex';
+import { cdxIconInfo } from '@wikimedia/codex-icons';
+import { newBooleanValue, BooleanValue, ValueType } from '@/domain/Value';
+import { BooleanType, BooleanProperty } from '@/domain/propertyTypes/Boolean.ts';
+import { ValueInputEmits, ValueInputExposes, ValueInputProps } from '@/components/Value/ValueInputContract.ts';
+import { NeoWikiServices } from '@/NeoWikiServices.ts';
+
+const props = withDefaults(
+	defineProps<ValueInputProps<BooleanProperty>>(),
+	{
+		modelValue: undefined,
+		label: ''
+	}
+);
+
+const emit = defineEmits<ValueInputEmits>();
+
+const validationError = ref<string | null>( null );
+
+const toBoolean = ( value: Value | undefined ): boolean =>
+	value !== undefined && value.type === ValueType.Boolean ? ( value as BooleanValue ).boolean : false;
+
+const internalValue = ref<boolean>( toBoolean( props.modelValue ) );
+
+const propertyType = NeoWikiServices.getPropertyTypeRegistry().getType( BooleanType.typeName );
+
+function validate( value: BooleanValue ): void {
+	const errors = propertyType.validate( value, props.property );
+	validationError.value = errors.length === 0 ? null :
+		mw.message( `neowiki-field-${ errors[ 0 ].code }`, ...( errors[ 0 ].args ?? [] ) ).text();
+}
+
+function onInput( newValue: boolean ): void {
+	internalValue.value = newValue;
+	const value = newBooleanValue( newValue );
+	emit( 'update:modelValue', value );
+	validate( value );
+}
+
+watch( () => props.modelValue, ( newValue ) => {
+	internalValue.value = toBoolean( newValue );
+	validate( newBooleanValue( internalValue.value ) );
+} );
+
+watch( () => props.property, () => {
+	validate( newBooleanValue( internalValue.value ) );
+} );
+
+defineExpose<ValueInputExposes>( {
+	getCurrentValue: function(): Value | undefined {
+		return newBooleanValue( internalValue.value );
+	}
+} );
+
+validate( newBooleanValue( internalValue.value ) );
+</script>
diff --git a/resources/ext.neowiki/src/domain/propertyTypes/Boolean.ts b/resources/ext.neowiki/src/domain/propertyTypes/Boolean.ts
@@ -0,0 +1,50 @@
+import type { PropertyDefinition } from '@/domain/PropertyDefinition';
+import { PropertyName } from '@/domain/PropertyDefinition';
+import { type BooleanValue, newBooleanValue, ValueType } from '@/domain/Value';
+import { BasePropertyType, ValueValidationError } from '@/domain/PropertyType';
+
+export type BooleanProperty = PropertyDefinition;
+
+export class BooleanType extends BasePropertyType<BooleanProperty, BooleanValue> {
+
+	public static readonly valueType = ValueType.Boolean;
+
+	public static readonly typeName = 'boolean';
+
+	public getDisplayAttributeNames(): string[] {
+		return [];
+	}
+
+	public getExampleValue(): BooleanValue {
+		return newBooleanValue( true );
+	}
+
+	public createPropertyDefinitionFromJson( base: PropertyDefinition ): BooleanProperty {
+		return { ...base } as BooleanProperty;
+	}
+
+	public validate( value: BooleanValue | undefined, property: BooleanProperty ): ValueValidationError[] {
+		const errors: ValueValidationError[] = [];
+
+		if ( property.required && value === undefined ) {
+			errors.push( { code: 'required' } );
+		}
+
+		return errors;
+	}
+
+}
+
+type BooleanPropertyAttributes = Omit<Partial<BooleanProperty>, 'name'> & {
+	name?: string | PropertyName;
+};
+
+export function newBooleanProperty( attributes: BooleanPropertyAttributes = {} ): BooleanProperty {
+	return {
+		name: attributes.name instanceof PropertyName ? attributes.name : new PropertyName( attributes.name || 'Boolean' ),
+		type: BooleanType.typeName,
+		description: attributes.description ?? '',
+		required: attributes.required ?? false,
+		default: attributes.default,
+	};
+}
diff --git a/resources/ext.neowiki/src/public-api.ts b/resources/ext.neowiki/src/public-api.ts
@@ -53,6 +53,7 @@ export * from './domain/SubjectRepository';
 export * from './domain/SubjectValidator';
 export * from './domain/SubjectWithContext';
 export * from './domain/Value';
+export * from './domain/propertyTypes/Boolean';
 export * from './domain/propertyTypes/DateTime';
 export * from './domain/propertyTypes/dateTimeConversion';
 export * from './domain/propertyTypes/Date';
diff --git a/resources/ext.neowiki/tests/domain/propertyTypes/Boolean.spec.ts b/resources/ext.neowiki/tests/domain/propertyTypes/Boolean.spec.ts
diff --git a/src/Domain/PropertyType/PropertyTypeRegistry.php b/src/Domain/PropertyType/PropertyTypeRegistry.php
diff --git a/src/Domain/PropertyType/Types/BooleanType.php b/src/Domain/PropertyType/Types/BooleanType.php
diff --git a/src/Domain/Schema/Property/BooleanProperty.php b/src/Domain/Schema/Property/BooleanProperty.php
diff --git a/src/GraphDatabasePlugins/Neo4j/Persistence/Neo4jValueBuilderRegistry.php b/src/GraphDatabasePlugins/Neo4j/Persistence/Neo4jValueBuilderRegistry.php
diff --git a/tests/phpunit/Domain/Schema/Property/BooleanPropertyTest.php b/tests/phpunit/Domain/Schema/Property/BooleanPropertyTest.php

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,9 @@`
`48`	`48`	`"World domination progress": {`
`49`	`49`	`"type": "number",`
`50`	`50`	`"default": 0`
	`51`	`+ },`
	`52`	`+ "Is public": {`
	`53`	`+ "type": "boolean"`
`51`	`54`	`}`
`52`	`55`	`}`
`53`	`56`	`}`