KXB.Umbraco.UmbracoDictionaryExtension
1.1.1
An extension to the UmbracoHelper with several ease of life improvements, such as code first generation of dictionary items and getting dictionary items from a partial key
Install-Package KXB.Umbraco.UmbracoDictionaryExtension -Version 1.1.1
dotnet add package KXB.Umbraco.UmbracoDictionaryExtension --version 1.1.1
<PackageReference Include="KXB.Umbraco.UmbracoDictionaryExtension" Version="1.1.1" />
paket add KXB.Umbraco.UmbracoDictionaryExtension --version 1.1.1
Umbraco Dictionary Extension
An extension to the UmbracoHelper with several ease of life improvements
Using the new method Umbraco.GetDictionaryValueAndCreateDictionaryItem(string key, string fallback="") you can create dictionary items code first by simply requesting them in your code. It's no longer necessary to manually create the dictionary items under Umbraco -> Settings.
"Folders" in the dictionary is created based on the name of the key, example:
The key "Foo.Bar.Key" will be placed in Dictionary -> "Foo" -> "Bar"
The method has 3 "creation modes":
- "key": This will initialize the dictionary item with the dictionary key stored in the dictionary (This is the default mode)
- "fallback": This will initialize the dictionary item with the fallback value stored in the dictionary
- "empty": This will initialize the dictionary item without a value
The creation mode can be set by modifying the app.config key: "KXB.Umbraco.UmbracoDictionaryExtension.CreationMode"
Using Umbraco.GetDictionaryItemsForPrefix(string prefix) or GetDictionaryValuesForPrefix(string prefix) you can retrieve dictionary values for a given prefix.
Example:
Umbraco.GetDictionaryItemsForPrefix("Foo.") could return dictionary items with the following keys:
- "Foo.Bar"
- "Foo.Foo"
- "Foo.Foo.Bar"
etc
App config keys and their usage:
XB.Umbraco.UmbracoDictionaryExtension.CreationMode" determines what values is stored in newly created keys. Valid options are "key" (default), "fallback", "empty"
"KXB.Umbraco.UmbracoDictionaryExtension.SeparationSymbol" determines which symbol is used to separate "folders" in the names of dictionary keys. Default value is "."
Umbraco Dictionary Extension
An extension to the UmbracoHelper with several ease of life improvements
Using the new method Umbraco.GetDictionaryValueAndCreateDictionaryItem(string key, string fallback="") you can create dictionary items code first by simply requesting them in your code. It's no longer necessary to manually create the dictionary items under Umbraco -> Settings.
"Folders" in the dictionary is created based on the name of the key, example:
The key "Foo.Bar.Key" will be placed in Dictionary -> "Foo" -> "Bar"
The method has 3 "creation modes":
- "key": This will initialize the dictionary item with the dictionary key stored in the dictionary (This is the default mode)
- "fallback": This will initialize the dictionary item with the fallback value stored in the dictionary
- "empty": This will initialize the dictionary item without a value
The creation mode can be set by modifying the app.config key: "KXB.Umbraco.UmbracoDictionaryExtension.CreationMode"
Using Umbraco.GetDictionaryItemsForPrefix(string prefix) or GetDictionaryValuesForPrefix(string prefix) you can retrieve dictionary values for a given prefix.
Example:
Umbraco.GetDictionaryItemsForPrefix("Foo.") could return dictionary items with the following keys:
- "Foo.Bar"
- "Foo.Foo"
- "Foo.Foo.Bar"
etc
App config keys and their usage:
XB.Umbraco.UmbracoDictionaryExtension.CreationMode" determines what values is stored in newly created keys. Valid options are "key" (default), "fallback", "empty"
"KXB.Umbraco.UmbracoDictionaryExtension.SeparationSymbol" determines which symbol is used to separate "folders" in the names of dictionary keys. Default value is "."
Release Notes
Changed default value of "KXB.Umbraco.UmbracoDictionaryExtension.SeparationSymbol" to "." (period).
Dependencies
-
- AutoMapper (>= 3.3.1)
- ClientDependency (>= 1.9.1)
- ClientDependency-Mvc5 (>= 1.8.0)
- Examine (>= 0.1.70)
- HtmlAgilityPack (>= 1.4.9)
- ImageProcessor.Web (>= 4.6.6)
- Markdown (>= 1.14.4)
- Microsoft.AspNet.Identity.Owin (>= 2.2.1)
- Microsoft.AspNet.Mvc (>= 5.2.3)
- Microsoft.AspNet.WebApi (>= 5.2.3)
- Microsoft.AspNet.WebApi.Client (>= 5.2.3)
- Microsoft.Owin.Host.SystemWeb (>= 3.0.1)
- Microsoft.Owin.Security (>= 3.0.1)
- Microsoft.Owin.Security.Cookies (>= 3.0.1)
- Microsoft.Owin.Security.OAuth (>= 3.0.1)
- MySql.Data (>= 6.9.9)
- Newtonsoft.Json (>= 6.0.8)
- semver (>= 1.1.2)
- UmbracoCms.Core (>= 7.0.0)
- UrlRewritingNet (>= 2.0.7)
GitHub Usage
This package is not used by any popular GitHub repositories.
