From 769f07af2ed60a6922f15dffdb353c963be7fa80 Mon Sep 17 00:00:00 2001 From: Adrian Cojocariu Date: Tue, 30 Apr 2024 12:54:46 +0300 Subject: [PATCH 1/3] Update docs for Algolia 2.1.5 changes. --- .../integrations/algolia.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/marketplace-and-integrations/integrations/algolia.md b/marketplace-and-integrations/integrations/algolia.md index cbd70d83d3b..7178d1de0b1 100644 --- a/marketplace-and-integrations/integrations/algolia.md +++ b/marketplace-and-integrations/integrations/algolia.md @@ -121,7 +121,7 @@ To customize the returned value from Umbraco CMS you would need to use a custom To extend the behavior, there are available options: -### Version 2.0.0 and up +### Version 2.0.0 to 2.1.5 Starting with version 2.0.0, we provide a collection of converters for the following Umbraco property editors: - `Umbraco.TrueFalse` @@ -171,6 +171,23 @@ services.AddUmbraco(_env, _config) .Build(); ``` +### Version 2.1.5 and up + +Following [this](https://github.com/umbraco/Umbraco.Cms.Integrations/issues/188) issue, that affects `Umbraco.TinyMCE` property editor in Umbraco 13, we have passed the `IProperty` object to the parse method of the converters. + +A custom converter will look like this, allowing developers to add their implementation based on the content property. +```csharp + public class MyTagsConverter : IAlgoliaIndexValueConverter + { + public string Name => Core.Constants.PropertyEditors.Aliases.Tags; + + public object ParseIndexValues(IProperty property, IEnumerable indexValues) + { + return new[] { "Umbraco", "is", "awesome" }; + } + } +``` + ### Up to version 1.5.0 These implementations contain a custom converter for the `Umbraco.MediaPicker3` property editor. From e988602867ed07717b82fa1e7fc6b2406612ef72 Mon Sep 17 00:00:00 2001 From: Adrian Cojocariu Date: Tue, 30 Apr 2024 14:00:25 +0300 Subject: [PATCH 2/3] Arrange version block --- .../integrations/algolia.md | 34 +++++++++---------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/marketplace-and-integrations/integrations/algolia.md b/marketplace-and-integrations/integrations/algolia.md index 7178d1de0b1..e88931bf0df 100644 --- a/marketplace-and-integrations/integrations/algolia.md +++ b/marketplace-and-integrations/integrations/algolia.md @@ -121,6 +121,23 @@ To customize the returned value from Umbraco CMS you would need to use a custom To extend the behavior, there are available options: +### Version 2.1.5 and up + +Following [this](https://github.com/umbraco/Umbraco.Cms.Integrations/issues/188) issue, that affects `Umbraco.TinyMCE` property editor in Umbraco 13, we have passed the `IProperty` object to the parse method of the converters. + +A custom converter will look like this, allowing developers to add their implementation based on the content property. +```csharp + public class MyTagsConverter : IAlgoliaIndexValueConverter + { + public string Name => Core.Constants.PropertyEditors.Aliases.Tags; + + public object ParseIndexValues(IProperty property, IEnumerable indexValues) + { + return new[] { "Umbraco", "is", "awesome" }; + } + } +``` + ### Version 2.0.0 to 2.1.5 Starting with version 2.0.0, we provide a collection of converters for the following Umbraco property editors: @@ -171,23 +188,6 @@ services.AddUmbraco(_env, _config) .Build(); ``` -### Version 2.1.5 and up - -Following [this](https://github.com/umbraco/Umbraco.Cms.Integrations/issues/188) issue, that affects `Umbraco.TinyMCE` property editor in Umbraco 13, we have passed the `IProperty` object to the parse method of the converters. - -A custom converter will look like this, allowing developers to add their implementation based on the content property. -```csharp - public class MyTagsConverter : IAlgoliaIndexValueConverter - { - public string Name => Core.Constants.PropertyEditors.Aliases.Tags; - - public object ParseIndexValues(IProperty property, IEnumerable indexValues) - { - return new[] { "Umbraco", "is", "awesome" }; - } - } -``` - ### Up to version 1.5.0 These implementations contain a custom converter for the `Umbraco.MediaPicker3` property editor. From cd0549e080740352c903dc5e1700f0733786f5b4 Mon Sep 17 00:00:00 2001 From: Adrian Cojocariu Date: Tue, 30 Apr 2024 14:01:47 +0300 Subject: [PATCH 3/3] Docs rephrasing --- marketplace-and-integrations/integrations/algolia.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/marketplace-and-integrations/integrations/algolia.md b/marketplace-and-integrations/integrations/algolia.md index e88931bf0df..7e738910676 100644 --- a/marketplace-and-integrations/integrations/algolia.md +++ b/marketplace-and-integrations/integrations/algolia.md @@ -123,9 +123,9 @@ To extend the behavior, there are available options: ### Version 2.1.5 and up -Following [this](https://github.com/umbraco/Umbraco.Cms.Integrations/issues/188) issue, that affects `Umbraco.TinyMCE` property editor in Umbraco 13, we have passed the `IProperty` object to the parse method of the converters. +As a resolution for [an issue](https://github.com/umbraco/Umbraco.Cms.Integrations/issues/188) that affects `Umbraco.TinyMCE` property editor in Umbraco 13, the `IProperty` object has been passed to the parse method of the converters. -A custom converter will look like this, allowing developers to add their implementation based on the content property. +A custom converter will look like this, allowing developers to add their implementation based on the content property: ```csharp public class MyTagsConverter : IAlgoliaIndexValueConverter {