https://github.com/geta/geta-optimizely-extensions
A comprehensive list of various extension methods improving your productivity for Optimizely sites.
https://github.com/geta/geta-optimizely-extensions
cms optimizely
Last synced: about 2 months ago
JSON representation
A comprehensive list of various extension methods improving your productivity for Optimizely sites.
- Host: GitHub
- URL: https://github.com/geta/geta-optimizely-extensions
- Owner: Geta
- License: mit
- Created: 2021-02-05T08:43:17.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-02-26T07:16:01.000Z (3 months ago)
- Last Synced: 2025-02-26T08:25:06.169Z (3 months ago)
- Topics: cms, optimizely
- Language: C#
- Homepage:
- Size: 127 MB
- Stars: 0
- Watchers: 11
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Extensions and helpers library for Optimizely CMS
,branch:master/statusIcon)
[](https://msdn.microsoft.com/en-us/library/w0x726c2%28v=vs.110%29.aspx)
[](http://world.episerver.com/cms/)
## Description
Optimizely.Extensions is library with useful extension methods and helpers for Optimizely.
## How to get started?
Start by installing NuGet package:
Install-Package Geta.Optimizely.Extensions
## Features
### Basics
You can use the GetChildren and GetPage extension methods to easily fetch pages. They also have generic overloads.
var startPage = ContentReference.StartPage.GetPage();
var sections = ContentReference.StartPage.GetChildren();
### Filters
You can use _FilterForDisplay_ to easily filter out pages that the user shouldn't see. Here is an example of how to filter child pages of start page.
var childPages = ContentReference.StartPage.GetChildren().FilterForDisplay();
### MenuList extension for HtmlHelper
_MenuList_ extension method helps to build menus. Extension method requires two parameters - _ContentReference_ of the menu root page and _@helper_ which generates menu item. _MenuList_ uses _FilterForDisplay_ extension method to filter out pages that the user doesn't have access to, are not published and are not visible in menu and that don't have a template.
_MenuList_ extension method has three optional parameters:
- _includeRoot_ - flag which indicates if root page should be included in menu (default is false)
- _requireVisibleInMenu_ - flag which indicates if pages should be included only when their property _VisibleInMenu_ is true (default is true)
- _requirePageTemplate_ - flag which indicates if pages should have templates
Below is an example how menu can be created for pages under start page.
@{
Func menuItemTemplate =@
@Html.PageLink(item.Page)
}
Or you can do it inline
_MenuList_ creates the list only for one level. For multiple menu levels use _MenuList_ extension in menu item template to generate sub-levels.
@{
Func subMenuItemTemplate =@
@Html.PageLink(item.Page)
Func menuItemTemplate =@
@Html.PageLink(item.Page)
@Html.MenuList(item.Page.ContentLink, subMenuItemTemplate)
}
### QueryStringBuilder
Here we have an example of using _QueryStringBuilder_ to build a filter URL. This can be useful for lists that have filter functionality or sort functionality. To instantiate _QueryStringBuilder_ _UrlHelper_ extensions are used.
Output when URL is: /list
Output when URL is: /list?sort=alphabet
A-Å
Here is an example of using _QueryStringBuilder_ to add a segment to a Optimizely page URL. This can be useful for forms if you want to post to a page controller action.
Output when page URL is: /about-us
### Validation
We have included a simple validation helper for validating email address' using .NET's built in email validation (which updates together with newer versions/patches for .NET).
bool isValidEmail = ValidationHelper.IsValidEmail("[email protected]");
### Enum properties
If you have enum values you want to use in your content types you can use the EnumAttribute to decorate your properties. The values can also be localized.
[BackingType(typeof(PropertyNumber))]
[EnumAttribute(typeof(Priority))]
public virtual Priority Priority { get; set; }
Credits: http://world.episerver.com/Blogs/Linus-Ekstrom/Dates/2014/5/Enum-properties-for-EPiServer-75/
### Categories
You can easily get the child categories of any root category you like (as long as you have it's ID).
IEnumerable categories = Category.GetRoot().ID.GetChildCategories();
When you have a CategoryList and want to get strongly typed Category objects back you can use the GetFullCategories() method.
IEnumerable categories = CurrentPage.Category.GetFullCategories();
If you need to check if the CategoryList has that category you can use the Contains() method.
bool hasBikes = CurrentPage.Category.Contains("bikes");
### Enumerable extensions
You can easily check if content references are part of a list using `MemberOf`, `MemberOfAny` or `MemberOfAll`, for example to check if a page has any of the supplied categories:
```
IEnumerable categories = ...;
var pagesWithCat = _contentLoader
.GetChildren(contentLink, loaderOptions)
.Where(x => x.Categories.MemberOfAny(categories));
```
### External/friendly URL
This can be useful when used together with sharing widgets.
string fullUrl = CurrentPage.GetFriendlyUrl();
### Singleton page
Allows easily load the page which is a single instance of a type.
Loading the singleton page of a type by a parent _ContentReference_.
var testPage1 = ContentReference.StartPage.GetSingletonPage();
Loading the singleton page of a type by a parent page.
var startPage = _contentLoader.Get(ContentReference.StartPage);
var testPage2 = startPage.GetSingletonPage();
### Content editor user experience helpers/extensions
Set of extension methods and HTML helpers to improve user experience for content editors.
The goal is to reduce the need for "All properties view" in the Optimizely edit interface.
### EditButton attribute
Attribute to use on properties that you want to have editable in On Page edit mode. Typical usage is for settings properties or other properties that are normally not rendered in your view.
[EditButton(ButtonLabel = "My property")] // If you don't supply ButtonLabel, display name of the property will be used instead.
public virtual string MyProperty { get; set; }
The edit button is then rendered in the view, only when page is in edit mode, with EditButtonFor helper:
@Html.EditButtonFor(m => m.MyProperty)
You can also use the EditButtonsGroup helper to render buttons for all properties marked with the EditButtonAttribute:
@Html.EditButtonsGroup() // If view model is IContentData
@Html.EditButtonsGroup(m => m.CurrentPage) // If view model is page view model
Note: EditButtonsGroup accepts an argument named includeBuiltInProperties (defaults to false) which, if true, also renders buttons for the following built-in properties:
Category
Simple address
URLSegment
Display in navigation
Published
Update modified date
### EditorHelp attribute
Attribute to use on properties you might want an extended help text for in edit mode.
[EditorHelp("This is the main content area for blocks. The following block types are supported: My block 1, My block 2.")]
public virtual ContentArea MainContentArea { get;set; }
The help text is rendered in the view (as ul element) with EditorHelpFor helper:
@Html.EditorHelpFor(m => m.MainContentArea)
@Html.PropertyFor(m => m.MainContentArea)
You can also render a help summary for all properties marked with the EditorHelpAttribute:
@Html.EditorHelpSummary() // If view model is IContentData
@Html.EditorHelpSummary(m => m.CurrentPage) // If view model is page view model
Please note that the buttons and help texts are not styled with any CSS in this package. You will have to do that yourself.
## 🏁 Getting Started
### 📦 Prerequisites
Ensure your system is properly configured to meet all prerequisites for Geta Foundation Core listed [here](https://github.com/Geta/geta-foundation-core#%EF%B8%8F-prerequisites)
### 🐑 Cloning the repository
```bash
git clone https://github.com/Geta/geta-optimizely-extensions.git
cd geta-optimizely-extensions
git submodule update --init
```
### 🚀 Running with Aspire (Recommended)
```bash
# Windows
cd sub/geta-foundation-core/src/Foundation.AppHost
dotnet run
# Linux / MacOS
sudo env "PATH=$PATH" bash
chmod +x sub/geta-foundation-core/src/Foundation/docker/build-script/*.sh
cd sub/geta-foundation-core/src/Foundation.AppHost
dotnet run
```
### 🖥️ Running as Standalone
```bash
# Windows
cd sub/geta-foundation-core
./setup.cmd
cd ../../src/Geta.Optimizely.Extensions.Web
dotnet run
# Linux / MacOS
sudo env "PATH=$PATH" bash
cd sub/geta-foundation-core
chmod +x *.sh
./setup.sh
cd ../../src/Geta.Optimizely.Extensions.Web
dotnet run
```
If you run into any issues, check the FAQ section [here](https://github.com/Geta/geta-foundation-web?tab=readme-ov-file#faq)
---
CMS username: [email protected]
Password: Episerver123!
## Package maintainer
https://github.com/marisks