Nibble

Umbraco BE Festival, 25Th April 2014 0

After the successful BE Festival in 2011, the Belgian Umbraco User Group(buug.be) is throwing another edition.

They have some great speakers lined up including Umbraco founder Niels Hartvig and other speakers from DK,UK,SE,NL,FR and BE.

For full details please go to http://www.buug.be/en/events/umbraco-festival-2014 and get your ticket today!

5536568903_15ce073856_b

There is no spoon 1.0 Release (matrix prop editor for Umbraco v7) 0

I’ve just released a packaged version of the matrix prop editor I created as an example prop editor for Umbraco v7.

The package is available for download on http://our.umbraco.org/projects/backoffice-extensions/there-is-no-spoon (this if for Umbraco v7 only)

The settings looks like

MatrixPropEditorSettings

So you can set

  • initial number of cols and rows
  • let the content editor add/remove rows
  • Show row labels
  • define labels for rows and cols

An example of the editor (with manage rows enabled)

MatrixPropEditor

Advanced property editors for Umbraco v7, dynamic prevalue editors 0

Working with the value from 1 prevalue editor on the other, that’s easily possible with Umbraco v7 Smile

Since you can access the editorState http://umbraco.github.io/Belle/#/api/umbraco.services.editorState

As an example I’ve updated the matrix prop editor http://www.nibble.be/?p=330

What I wanted to do is to make it possible to setup headers for the rows and columns but since the amount of rows and columns isn’t fixed…

So first step is to create a new view and controller for the custom prevalue editor (just use what you know from creating prop editors)

And then use that as a prevalue editor

                {
                    label: "Labels",
                    description: "Enter the labels for the cols/rows",
                    key: "rowheaders",
                    view: "~/App_Plugins/MatrixEditor/matrixlabeleditor.html",
                    
                }

Then in the controller it’s possible to inject the editorState and access the other prevalues

    function ($scope,editorState) {
 
    $scope.current = editorState.current;
    $scope.rows = _.where($scope.current.preValues, {key: "rows"})[0];
    $scope.cols = _.where($scope.current.preValues, {key: "cols"})[0];

(using some underscore the easily fetch the correct prevalue)

So once I have the amount of rows and cols I can dynamic build up my editor

<div ng-controller="Nibble.MatrixLabelEditor" class="matrix-label-editor">
     <div>
            <h6>Column labels</h6>
            <div  ng-repeat="label in model.value.collabels track by $id($index)" class="lbl-cont">
                <input type="text" ng-model="model.value.collabels[$index]"/>
            </div >
     </div>
     <div>
         <h6>Row labels</h6>
         <div ng-repeat="label in model.value.rowlabels track by $id($index)" class="lbl-cont">
            <input type="text" ng-model="model.value.rowlabels[$index]"/>
         </div>
     </div>
 
 
</div>

collabels and rowlabels are both arrays

The end result looks like

image

And then of course the prop editor view needs to be updated to include the headers (only for cols atm)

<div ng-controller="Nibble.MatrixEditor">
     <table>
        <thead>
            <tr>
              <th ng-repeat="head in model.config.rowheaders.collabels">{{head}}</th>
            </tr>
          </thead>
        <tbody>
            <tr ng-repeat="row in model.value">
                <td ng-repeat="col in row  track by $id($index)">
                     <input type="text" ng-model="row[$index]"></td>
            </tr>
        </tbody>
    </table>
</div>

 

For a quick demo check out

As a final touch I’ll need to get rid of refreshing the page but haven’t figured that one out yet

Sourcecode is available on github https://github.com/TimGeyssens/MatrixPropEditor

Advanced property editors for Umbraco v7, prevalue editors 1

As you could see in the 2 prop editors for Umbraco examples it’s super easy to add config options to your v7 prop editors (http://www.nibble.be/?p=330, http://www.nibble.be/?p=285)

As it mentions in the manifest docs http://umbraco.github.io/Belle/#/tutorials/manifest there is a prevalues part where you can setup your config options…

So

prevalues: {
            fields: [
                {
                    label: "Number of chars",
                    description: "Enter the number of chars to limit on",
                    key: "limit",
                    view: "requiredfield",
                    validation: [
                        {
                            type: "Required" 
                        }                        
                    ]
                }
            ]
        }

Results in

Changing the type of prevalue editor

Of course you aren’t limited to a simple text input if you take a look at the available out of the box types (found in \Umbraco\Views\prevalueeditors )

You’ll find

image

So if I want to update my matrix prop editor to have numeric prevalues (since I need to define number or rows and columns)

I just need the name of the view (and don’t need the .html)

That then becomes

            fields: [
                {
                    label: "Number of columns",
                    description: "Enter the number of columns",
                    key: "cols",
                    view: "number",
                    validation: [
                        {
                            type: "Required" 
                        }                        
                    ]
                },
                {
                    label: "Number of rows",
                    description: "Enter the number of rows",
                    key: "rows",
                    view: "number",
                    validation: [
                        {
                            type: "Required" 
                        }                        
                    ]
                },

And results in

image

Using prop editors as prevalue editors

It’s also possible to plug in custom prevalue editors, all  you need to do is point it to a view and you can use a prop editor as a prevalue editor!

So adding this

                {
                    label: "Testing",
                    description: "Test",
                    key: "test",
                    view: "~/App_Plugins/MatrixEditor/matrixeditor.html",
                    validation: [
                        {
                            type: "Required" 
                        }                        
                    ]
                }

Will make it possible to use the matrix prop editor as a prevalue editor on it’s own settings

image

Currently you’ll have to manually check in your controller if the config has values or not since it’s not possible to set default values that get passed to the prevalue editor (but should be possible soon)

Autobots, Roll out! Optimus 1.2.0 Release with Umbraco v7 Compatibility is available 0

Like I mentioned during the Uk fest, adding v7 support to your packages is easy Smile (the hard part was writing this blog post)

So I’m glad to announce a new release of Optimus

If you haven’t seen it in action be sure to check out this 5 minute show and tell

If you don’t have 5 minutes to spare here are some screenshots
OptimusBundlerOptimusBundleEditorOptimusBundleFileEditor

Special thanks to Jeavon Leopold for all the hard work! If you are looking for someone to build your Umbraco site make sure to check http://www.crumpled-dog.com/

Advanced property editors for Umbraco v7, Validation 0

Look at the following example prop editor (it’s basically a port of the sample todo app on the http://angularjs.org/ homepage, a bit simplified to focus on the important bits)

image

So in this case the prop editor contains a form that will add items to a array/list

The controller

angular.module("umbraco").controller("SampleValidationController",
        function ($scope) {
 
         if(!(Object.prototype.toString.call($scope.model.value) === ‘[object Array]’)){
             $scope.model.value = new Array();
         }
 
         $scope.addTodo = function() {
            $scope.model.value.push({text:$scope.todoText, done:false});
            $scope.todoText = ;
          };
 
        });

The View

 <div ng-controller="SampleValidationController">
 
         <ul class="unstyled">
           <li ng-repeat="todo in model.value">
             <input type="checkbox" ng-model="todo.done">
             <span class="done-{{todo.done}}">{{todo.text}}</span>
           </li>
         </ul>
         <form ng-submit="addTodo()">
           <input type="text" ng-model="todoText"  size="30"
                  placeholder="add new todo here">
           <input class="btn-primary" type="submit" value="add">
      </form>
 
 </div>

Of course when people click the add we want to make sure not to add an empty item to the list….

So the easiest would be to add a required attribute to the text input.. that works

image

but doing that will interfere with the page publish

image

And that’s not what we want… so the validation only needs to happen when we hit the add not publish…

So we’ll need to create a variable in our controller that will hold the validation state (initially set this to false and the manually check if we want to proceed and change the value of the validation state…)

angular.module("umbraco").controller("SampleValidationController",
        function ($scope) {
 
        $scope.hasError = false;
 
         if(!(Object.prototype.toString.call($scope.model.value) === ‘[object Array]’)){
             $scope.model.value = new Array();
         }
 
         $scope.addTodo = function() {
            if($scope.todoText)
            {
                $scope.model.value.push({text:$scope.todoText, done:false});
                $scope.todoText = ;
                $scope.hasError = false;
            }
            else
            {
                $scope.hasError = true;
            }
          };
 
        });

 

In our view we can now use a custom directive to show a bit of feedback to the user val-highlight="hasError" (of course passing in the variable name) and getting rid of the required

<input type="text" ng-model="todoText"  size="30"
                  placeholder="add new todo here" val-highlight="hasError">

So now when I try to hit the add without filling in a value I’ll get a red border for a couple of seconds

image

And we don’t interfere with the page publish validation…

Advanced property editor for Umbraco v7, working with custom data 0

These prop editor posts just keep coming Winking smile

Is this one I’ll outline how to fetch some third party data in your prop editor

So first I’ll need to expose some data using an API controller

    [PluginController("Contour")]
    public class FormsApiController : UmbracoAuthorizedJsonController
    {
        public IEnumerable<Models.Form> GetAll()
        {
            var forms = new List<Models.Form>();
            FormStorage s = new FormStorage();
 
            foreach (var form in s.GetAllForms(false))
            {
                if (UI.Security.HasAccessToForm(form.Id))
                {
                    Models.Form f = new Models.Form();
                    f.Id = form.Id;
                    f.Name = form.Name;
                    f.Fields = GetFormFields(form);
                    forms.Add(f);
                }
            }
            s.Dispose();
 
            return forms;
        }
}

Notice that I’m using an UmbracoAuthorizedJsonController to make sure only logged in Umbraco backoffice users have access…

Then I’m simply returning a list of Forms (forms is a custom model that looks like)

 public class Form
    {
        public Guid Id { get; set; }
        public string Name { get; set; }
        public string Fields { get; set; }
    }

So I’m using Contour to fetch all forms (but since those have to much data I’m creating them as my simple form object) and then returning them a a list.

So that’s the api controller done,

Next is the angular controller

angular.module("umbraco").controller("Contour.FormPickerController",
        function ($scope, $http) {
            $scope.loading = true;
            $http({ method: ‘GET’, url: ‘Contour/FormsApi/GetAll’ })
                .success(function (data) {
                    $scope.forms  = data;
                    $scope.loading = false;
                })
                .error(function () {
                    $scope.error = "An Error has occured while loading!";
                    $scope.loading = false;
                });
        });

So it does a get request of Contour/FormsApi/GetAll (that is where we’ll find our api controller method since this is auto routed) and assigns the result to $scope.forms

And the final bit, the view looks like

 <div ng-controller="Contour.FormPickerController">
     
     <div class="radio" ng-repeat="form in forms">
         <label>
             <input ng-model="model.value" value="{{form.Id}}" type="radio" name="form">
             {{form.Name}}
             <small>{{form.Fields}}</small>
         </label>
     </div>
 
 </div>

So it’s just looping the form objects and outputting them as radiobuttons (setting model.value)

End result looks like

FormPicker

You’ll see that in this example the data is fetched async ideally I would also like to set a scope object on load, maybe that’s something for the next post Winking smile

Creating custom param editors in Umbraco v7 4

In v7 it’s super easy to create param editors (the type of control you can choose for macro params).

image

You can basically use all of the prop editor knowledge and just set a flag in the manifest to allow the prop editor to be used as param editor (if that Isn’t easy Smile )

Check the documentation for full details http://umbraco.github.io/Belle/#/tutorials/manifest

isParameterEditor enables the property editor as a macro parameter editor can be true/false

So to allow my sample prop editor http://www.nibble.be/?p=285 (char limit) to be used as a param editor all it takes is a little update of the manifest (and restart the app so the manifest changes are picked up)

{
    propertyEditors: [
        {
        alias: "Demo.CharLimitEditor",
        name: "Char limit",
        isParameterEditor: true,
        editor: {
        view: "~/App_Plugins/CharLimitEditor/charlimiteditor.html"
        },

And that’s it Smile

image

Advanced property editors for Umbraco v7 and XSLT 8

xslt

As you could see in the previous couple of posts, in umbraco v7 when creating a more advanced prop editor it will store it’s data as json. But what if you are still using xslt to output your property data to your frontend (yes there are still some folks around that prefer xslt, the sadomasochists of the Umbraco community)

Since json data is useless in xslt we added a new library method that you can use to convert json to xml Smile

<xsl:copy-of select="umbraco.library:JsonToXml($currentPage/matrix)"/>

 

In the case of the matrix prop editor you’ll end up with the following xml

<json>
<arrayitem>
    <arrayitem>xslt</arrayitem>
    <arrayitem>is</arrayitem>
</arrayitem>
<arrayitem>
    <arrayitem>not</arrayitem>
    <arrayitem>dead</arrayitem>
</arrayitem>
</json>

Advanced property editors for Umbraco v7, strongly typed values in your views using PropertyValueConverters 10

As you could see in the previous post, if we have a prop editor where the value type is set the JSON we can also iterate this in your razor views

<table>
<tbody>
@foreach(var row in CurrentPage.matrix)
{
<tr>
@foreach(var val in row)
{
<td>@val</td>
}
</tr>
            }
</tbody>
</table>

Of course the type of object in this case is dynamic but a little thing called PropertyValueConverters make it possible to convert this into a strongly typed object!

Here is an example implementation

    [PropertyValueType(typeof(Matrix))]
    [PropertyValueCache(PropertyCacheValue.All, PropertyCacheLevel.Content)]
    public class MatrixValueConverter : PropertyValueConverterBase
    {
        public override bool IsConverter(PublishedPropertyType propertyType)
        {
            return propertyType.PropertyEditorAlias.Equals("Nibble.MatrixEditor");
        }
 
        public override object ConvertDataToSource(PublishedPropertyType propertyType, object source, bool preview)
        {
            if (source == null) return null;
            var sourceString = source.ToString();
 
            if (sourceString.DetectIsJson())
            {
                try
                {
                    var obj = JsonConvert.DeserializeObject<string[][]>(sourceString);
                    var matrix = new Matrix();
                    var rows = obj.Select(r => new Row {Values = r.ToList()}).ToList();
                    matrix.Rows = rows;
                    return matrix;
                }
                catch (Exception ex)
                {
                    return null;
                }
            }
 
            return sourceString;
        }
    }

That turns our json data into a custom Matrix object that looks like

    public class Matrix
    {
        public IEnumerable<Row> Rows { get; set; }
 
        public Matrix()
        {
            Rows = new List<Row>();
        }
    }

And the Row class looks like

    public class Row
    {
        public IEnumerable<string> Values { get; set; }

        public Row()
        {
            Values = new List<string>();
        }
    }

So now when I deploy this to my site when I fetch the value of a property that is using my custom matrix prop editor I’ll get an object of type Matrix Smile

If I then cast I get intellisense in Visual studio!

Intel

or you can also use Model.Content.GetPropertyValue<type>(“propAlias”)

More

Code for this is up on github https://github.com/TimGeyssens/MatrixPropEditor/tree/master/SamplePropertyValueConverter

Just a small gotcha, currently in the RC release you’ll have to remove the JSON value type from your custom prop editor if you want to attach a custom prop value convertor but that should be solved soon http://issues.umbraco.org/issue/U4-3591

« Previous PageNext Page »