https://github.com/callumbwhyte/super-value-converters
A collection of powerful property value converters for cleaner code in Umbraco
https://github.com/callumbwhyte/super-value-converters
converters dotnet models-builder umbraco
Last synced: 11 days ago
JSON representation
A collection of powerful property value converters for cleaner code in Umbraco
- Host: GitHub
- URL: https://github.com/callumbwhyte/super-value-converters
- Owner: callumbwhyte
- License: mit
- Created: 2019-01-29T09:25:34.000Z (about 6 years ago)
- Default Branch: v9/dev
- Last Pushed: 2024-02-18T01:25:37.000Z (about 1 year ago)
- Last Synced: 2024-05-01T14:51:24.682Z (12 months ago)
- Topics: converters, dotnet, models-builder, umbraco
- Language: C#
- Homepage:
- Size: 331 KB
- Stars: 14
- Watchers: 3
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Umbraco SuperValueConverters
[](https://www.nuget.org/packages/Our.Umbraco.SuperValueConverters/)
_Looking for SuperValueConverters for **Umbraco 8**? Check the [v8/dev](https://github.com/callumbwhyte/super-value-converters/tree/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](https://www.nuget.org/packages/Our.Umbraco.SuperValueConverters/).
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](https://our.umbraco.com/documentation/Getting-Started/Backoffice/Property-Editors/Built-in-Property-Editors/Multinode-Treepicker2) or [Nested Content](https://our.umbraco.com/documentation/Getting-Started/Backoffice/Property-Editors/Built-in-Property-Editors/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`.
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:
* Multi-Node Tree Picker
* Nested Content
### Models Builder
SuperValueConverters works seamlessly with [Models Builder](https://our.umbraco.com/documentation/Reference/Templating/Modelsbuilder/) _(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](https://our.umbraco.com/Documentation/Reference/Templating/Modelsbuilder/Using-Interfaces) 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](https://callumwhyte.com/) and contributors. If you have any questions about the project please get in touch on [Twitter](https://twitter.com/callumbwhyte), or by raising an issue on GitHub.
## Credits
The logo uses the [Energy](https://thenounproject.com/term/search/1603715/) icon from the [Noun Project](https://thenounproject.com) by [Scarlett McKay](https://thenounproject.com/scarlett.mckay/), licensed under [CC BY 3.0 US](https://creativecommons.org/licenses/by/3.0/us/).
### A special #h5yr to our contributors
* [Lee Kelleher](https://github.com/leekelleher)
* [Robert Foster](https://github.com/robertjf)
* [Lukasz Koruba](https://github.com/lkoruba)
* [Nik Rimington](https://github.com/NikRimington)
* [Alejandro Ocampo](https://github.com/ja0b)
* [Richard Thompson](https://github.com/richarth)
## License
Copyright © 2024 [Callum Whyte](https://callumwhyte.com/), and other contributors
Licensed under the [MIT License](LICENSE.md).