Koben.Iconic 1.4.0

Iconic

Highly configurable icon picker for Umbraco. With Iconic you will be able to create a property editor that can use virtually any font package out there and not only that, you will be able to select your icon from more than one package on the same property.

Install-Package Koben.Iconic -Version 1.4.0
dotnet add package Koben.Iconic --version 1.4.0
paket add Koben.Iconic --version 1.4.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Iconic

Highly configurable icon picker for Umbraco.

Introduction

With Iconic you will be able to create a property editor that can use virtually any font package out there and not only that, you will be able to select your icon from more than one package on the same property.

Installation

Nuget

NuGet

Umbraco Package

Umb

Manually

Download the code and copy it into you App_Plugin folder.

Configuration

Once the plugin is installed is time to configure it to your needs.

Create a new DataType

You have to create a new datatype from the Iconic editor:

  1. Go to the Developer section.
  2. Right click on DataTypes, click Create and click on New data type.
  3. Enter a name for your datatype and select Iconic from the Property Editor dropdown.

<img src="https://github.com/KOBENDigital/Iconic/blob/master/Documentation/datatype.png" width="600" alt="Create datatype" >

At this point I would recommend you to save your datatype as the configuration can take a bit of trial an error as you will need to deal with some regex and urls.

Iconic Configuration

On the Packages Configuration property, click the Add button. This will display a new form that you will use to configure your new font package.

  1. Enter the name for your package

  2. Create your selector. This will use regex to extract your icons css from the font package.

  3. Source file path. This file will contains the specific configuration for each icon.
    To extract the rules the previous regex rule will be used. This file will normally be a CSS file where the rules are contained. You can use absolute or relative paths. See below.

  4. Path to your font package css file.

    • You can use absolute paths: http:\www.yoursite.com\sytles\fonts\my-font-package.css. This allows you to use external files, like the ones from a CDN.
    • Or relative to the root: \styles\fonts\my-font-package.css
      This file will be loaded in the head of your backoffice and will affect the whole view so be careful of what you load there. Check the Known Issues section for some more info.
  5. Template. This will be the template your icon will be based on. You can use the value {icon} as placeholder for your icon specific rule. For instance, for Font Awesome you should enter something like: <i class="fa {icon}"></i>

  6. Click Add Package to add the configuration to your packages listing. Before adding the package, Iconic will extract the css rules from the file using the regex selector. Some checking is ran that will let you know if something went wrong with your configuration.

<img src="https://github.com/KOBENDigital/Iconic/blob/master/Documentation/addPackage2.png" width="600" alt="Add package" >

Icons source file

Some packages like Font Awesome use css rules to apply the specific icon:

<i class="fa fa-glass"></i> (Template: <i class="fa {icon}"></i>)

Other packages like Material Icons use the glyph codes or even ligatures to display the icon instead a specific css selector.

<i class="material-icons">alarm</i> (Template: <i class="material-icons">{icon}</i>)

So this file can be the same css file or another files use to extrac the icons property. In the case of Material Icons for instance there is a file called <a href="https://github.com/google/material-design-icons/blob/master/iconfont/codepoints">codepoints</a> where you can extract the icons names from.

Pre configured packages

To make your life easier I have included some help to configure your packages in the form of pre-configured packages. If you select Pre-Configured when creating your package, you will have access to a list of pre-configured ones. You will still have to enter your css file path.

<img src="https://github.com/KOBENDigital/Iconic/blob/master/Documentation/addPreConfig.png" width="600" alt="Pre-configured package" >

You can add as many packages you like. You can also arrange their order or remove those you don't want to use anymore.

Note: the regex included in the preconfigs are valid for the minimised versions of them.

Reviewing your configuration

Once you have added your configuration, this will be added to the configurations list. You add add as many as you want. To review the details of your configured package just click on them:

<img src="https://github.com/KOBENDigital/Iconic/blob/master/Documentation/configDetails.png" width="600" alt="See configuration details" >

You will get a read-only list of your values. To edit them just click on the Edit Package option.

Using the DataType

Once you have configured your datatype, you can use it as a property editor.

<img src="https://github.com/KOBENDigital/Iconic/blob/master/Documentation/select-editor.png" width="300" alt="Create property" >

To add or modify your icon just click on the placeholder, this will open a dialog where you can select form your configured packages. Once a package is selected, all the icons will be displayed below.
<img src="https://github.com/KOBENDigital/Iconic/blob/master/Documentation/using-iconic.png" width="600" alt="Using Iconic" >

Displaying the icon

Iconic comes with a value converter that will return a HtmlString containing the icon html. So you just have to use the model of your template like so:

@Html.Raw(Model.Content.MyIcon)

Remember to wrap the icon in Html.Raw so Razor displays the returned html properly.

Known issues

Glyphicons

If you try to use Glyphicons as part of the Bootstrap package, you will realise that the whole css file will be loaded on your backoffice. This might brake some of the backoffice functionality, i.e. buttons or the grid editor. To avoid this you should export the Glyphicons classes into their own separate file. You can do this from this link and select only Glyphicons from the Components section.

Umbraco Versions

Iconic has been tested with Umbraco 7.6 and 7.7.

Changelog

  • 1.3

    • Support globalization. en and es included.
    • Supports IE11
    • Added Simple Line Icons preconfiguration
    • Returns empty string instead empty object if not configured
    • Little fixes
  • 1.2.3

    • #7 Fixed compatibility with Nested Content.
  • 1.2.1

    • #4. When re-opening the Icon picker, the selected Icon should be highlighted
    • #5. If only one library is selected, the dropdown should default to this / default to first library
    • #6. Shows icon name on editor.
  • 1.2

    • Added preconfig for Material Icons.
    • Existing packages can be edited.
    • Icon source file separate from css file.
    • Forms using better Angular validation.

Handmade by Mario Lopez - 2017 @KobenDigital

Iconic

Highly configurable icon picker for Umbraco.

Introduction

With Iconic you will be able to create a property editor that can use virtually any font package out there and not only that, you will be able to select your icon from more than one package on the same property.

Installation

Nuget

NuGet

Umbraco Package

Umb

Manually

Download the code and copy it into you App_Plugin folder.

Configuration

Once the plugin is installed is time to configure it to your needs.

Create a new DataType

You have to create a new datatype from the Iconic editor:

  1. Go to the Developer section.
  2. Right click on DataTypes, click Create and click on New data type.
  3. Enter a name for your datatype and select Iconic from the Property Editor dropdown.

<img src="https://github.com/KOBENDigital/Iconic/blob/master/Documentation/datatype.png" width="600" alt="Create datatype" >

At this point I would recommend you to save your datatype as the configuration can take a bit of trial an error as you will need to deal with some regex and urls.

Iconic Configuration

On the Packages Configuration property, click the Add button. This will display a new form that you will use to configure your new font package.

  1. Enter the name for your package

  2. Create your selector. This will use regex to extract your icons css from the font package.

  3. Source file path. This file will contains the specific configuration for each icon.
    To extract the rules the previous regex rule will be used. This file will normally be a CSS file where the rules are contained. You can use absolute or relative paths. See below.

  4. Path to your font package css file.

    • You can use absolute paths: http:\www.yoursite.com\sytles\fonts\my-font-package.css. This allows you to use external files, like the ones from a CDN.
    • Or relative to the root: \styles\fonts\my-font-package.css
      This file will be loaded in the head of your backoffice and will affect the whole view so be careful of what you load there. Check the Known Issues section for some more info.
  5. Template. This will be the template your icon will be based on. You can use the value {icon} as placeholder for your icon specific rule. For instance, for Font Awesome you should enter something like: <i class="fa {icon}"></i>

  6. Click Add Package to add the configuration to your packages listing. Before adding the package, Iconic will extract the css rules from the file using the regex selector. Some checking is ran that will let you know if something went wrong with your configuration.

<img src="https://github.com/KOBENDigital/Iconic/blob/master/Documentation/addPackage2.png" width="600" alt="Add package" >

Icons source file

Some packages like Font Awesome use css rules to apply the specific icon:

<i class="fa fa-glass"></i> (Template: <i class="fa {icon}"></i>)

Other packages like Material Icons use the glyph codes or even ligatures to display the icon instead a specific css selector.

<i class="material-icons">alarm</i> (Template: <i class="material-icons">{icon}</i>)

So this file can be the same css file or another files use to extrac the icons property. In the case of Material Icons for instance there is a file called <a href="https://github.com/google/material-design-icons/blob/master/iconfont/codepoints">codepoints</a> where you can extract the icons names from.

Pre configured packages

To make your life easier I have included some help to configure your packages in the form of pre-configured packages. If you select Pre-Configured when creating your package, you will have access to a list of pre-configured ones. You will still have to enter your css file path.

<img src="https://github.com/KOBENDigital/Iconic/blob/master/Documentation/addPreConfig.png" width="600" alt="Pre-configured package" >

You can add as many packages you like. You can also arrange their order or remove those you don't want to use anymore.

Note: the regex included in the preconfigs are valid for the minimised versions of them.

Reviewing your configuration

Once you have added your configuration, this will be added to the configurations list. You add add as many as you want. To review the details of your configured package just click on them:

<img src="https://github.com/KOBENDigital/Iconic/blob/master/Documentation/configDetails.png" width="600" alt="See configuration details" >

You will get a read-only list of your values. To edit them just click on the Edit Package option.

Using the DataType

Once you have configured your datatype, you can use it as a property editor.

<img src="https://github.com/KOBENDigital/Iconic/blob/master/Documentation/select-editor.png" width="300" alt="Create property" >

To add or modify your icon just click on the placeholder, this will open a dialog where you can select form your configured packages. Once a package is selected, all the icons will be displayed below.
<img src="https://github.com/KOBENDigital/Iconic/blob/master/Documentation/using-iconic.png" width="600" alt="Using Iconic" >

Displaying the icon

Iconic comes with a value converter that will return a HtmlString containing the icon html. So you just have to use the model of your template like so:

@Html.Raw(Model.Content.MyIcon)

Remember to wrap the icon in Html.Raw so Razor displays the returned html properly.

Known issues

Glyphicons

If you try to use Glyphicons as part of the Bootstrap package, you will realise that the whole css file will be loaded on your backoffice. This might brake some of the backoffice functionality, i.e. buttons or the grid editor. To avoid this you should export the Glyphicons classes into their own separate file. You can do this from this link and select only Glyphicons from the Components section.

Umbraco Versions

Iconic has been tested with Umbraco 7.6 and 7.7.

Changelog

  • 1.3

    • Support globalization. en and es included.
    • Supports IE11
    • Added Simple Line Icons preconfiguration
    • Returns empty string instead empty object if not configured
    • Little fixes
  • 1.2.3

    • #7 Fixed compatibility with Nested Content.
  • 1.2.1

    • #4. When re-opening the Icon picker, the selected Icon should be highlighted
    • #5. If only one library is selected, the dropdown should default to this / default to first library
    • #6. Shows icon name on editor.
  • 1.2

    • Added preconfig for Material Icons.
    • Existing packages can be edited.
    • Icon source file separate from css file.
    • Forms using better Angular validation.

Handmade by Mario Lopez - 2017 @KobenDigital

Release Notes

Fixed some missing translations

Version History

Version Downloads Last updated
1.4.0 (current) 175 3/19/2018
1.3.1 389 11/14/2017
1.2.0 86 10/6/2017
1.0.2 77 9/28/2017