Emptiness

Nullable Property Value Converters for value types in Umbraco.

Install it:

dotnet add package Our.Umbraco.Emptiness

Why would I want that?

If an editor hasn't set a value for a "value type" property, then these converters will return null instead of a default value. This makes editor intent clearer - you can tell the difference between an integer that an edtor intentionally chose to be "0" as opposed to an integer property that's been left empty.

The Converters

Nullable Property Value Converters

Return null if an editor has not entered a value.

Enabled by default:

• NullableDatePickerConverter
• NullableDecimalConverter
• NullableIntegerConverter

Disabled by default:

• NullableLabelConverter

Property Value Converters for Toggles (True/False)

Though they don't have a null state in the UI, they can be empty if:

1. A property has been added to a content type, but some content of that type has not been (re)published since.
2. Content has been created via the API, without the property value having been set.

In these cases the following converters might be helpful...

YesNoDefaultConverter

Enabled by default. This converter returns the "Initial State" (default) value that has been configured in the property editor's settings.

NullableYesNoConverter

Disabled by default.

Configuration

You can configure Emptiness with appsettings.json like this:

  "Emptiness": {
    "EnabledConverters": [
      "NullableDatePickerConverter",
      "NullableDecimalConverter",
      "NullableIntegerConverter"
    ],
    "TrueFalseConverter": "DefaultValue"
  }

This is the default configuration.

EnabledConverters

If provided, enables only the PVCs listed.

Property Value Converter names:

• NullableDatePickerConverter
• NullableDecimalConverter
• NullableIntegerConverter
• NullableLabelConverter

TrueFalseConverter

Determines the True/False (Yes/No) conveter to use for booleans.

Options:

• Core - use Umbraco's built in converter.
• DefaultValue - use the YesNoDefaultConverter
• Nullable - use the NullableYesNoConverter

License(s) & Copyright

Copyright © 2022 Jason Elkin

Licensed under the MIT License.

Crate image created by vectorpocket - www.freepik.com