callumbwhyte / super-value-converters

A collection of powerful property value converters for cleaner code in Umbraco
MIT License
14 stars 12 forks source link
converters dotnet models-builder umbraco

Umbraco SuperValueConverters

Umbraco SuperValueConverters

NuGet release

Looking for SuperValueConverters for Umbraco 8? Check the v8/dev branch.

SuperValueConverters is a collection of powerful property value converters for Umbraco, eliminating the need for casting and null checks on Umbraco picker values in views or controllers and helping to keep code cleaner.

Getting started

This package is supported on Umbraco v10-v12 and v13

Once installed you don't need to do anything to activate SuperValueConverters.

Installation

SuperValueConverters is available via NuGet.

To install with the .NET CLI, run the following command:

$ dotnet add package Our.Umbraco.SuperValueConverters

To install from within Visual Studio, use the NuGet Package Manager UI or run the following command:

PM> Install-Package Our.Umbraco.SuperValueConverters

Usage

Where a picker that returns multiple items (such as MNTP or Nested Content) has been configured to only allow a single item to be selected (via it's "maxItems" setting), the returned value will now be a single IPublishedContent rather than IEnumerable<IPublishedContent>.

Supported value converters will no longer return null if no value has been picked - an empty collection will be returned instead, preventing the need for null checks.

Currently the following datatypes are supported:

Models Builder

SuperValueConverters works seamlessly with Models Builder (if you're using it) to return the correct model types from pickers rather than IPublishedContent.

Where a picker has been configured to only allow items of a specific doctype, the returned value will be already cast to the relevant Models Builder generated model.

In cases where an allowed doctype uses compositions Models Builder will generate an interface for that model. If more than one allowed doctype on a given picker implements the same interface, the returned value will be cast to the shared interface rather than the default IPublishedContent.

Contribution guidelines

To raise a new bug, create an issue on the GitHub repository. To fix a bug or add new features, fork the repository and send a pull request with your changes. Feel free to add ideas to the repository's issues list if you would to discuss anything related to the library.

Who do I talk to?

This project is maintained by Callum Whyte and contributors. If you have any questions about the project please get in touch on Twitter, or by raising an issue on GitHub.

Credits

The logo uses the Energy icon from the Noun Project by Scarlett McKay, licensed under CC BY 3.0 US.

A special #h5yr to our contributors

License

Copyright © 2024 Callum Whyte, and other contributors

Licensed under the MIT License.