README

sevengroupfrance/sulu-icon-picker-bundle

What is this bundle's goal?

Importing a custom fonctionality into sulu, in this example, a custom content type.
This bundle will use an icon library from IcoMoon.

Installation

Download the package in your project with the following command line:
composer require sevengroupfrance/sulu-icon-picker-bundle.
In config/bundles.php add the following code:
SevenGroupFrance\SuluIconPickerBundle\FontIconPickerBundle::class => ['all' => true].
In assets/admin/package.json, add the following line in the "dependencies" object:
"sulu-icon-picker-bundle": "file:node_modules/@sulu/vendor/sevengroupfrance/sulu-icon-picker-bundle/src/Resources/js".
In assets/admin, npm install to initialize the bundle's symlink directory.
In assets/admin/index.js, add this line:
import 'sulu-icon-picker-bundle'.
In assets/admin, npm run watch or npm run build

Create your own icon list with IcoMoon

From this page, we can choose whatever icons we want to use. If you want to import a library, click here:

From here, you can choose whatever library you want by clicking on the + Add button.

Then, choose the icons you want to use in your project by clicking on them or select all in the menu on the top right side of your selection. In the bottom menu, click on the Generate SVG & More button.
From here, you may want to name your icons accordingly as there is a search functionality to this icon picker. Once done, click on the "download" button.

In the file you just downloaded, you'll need two files: selection.json and symbol-defs. Replace the bundle's selection.json file content with your own, and replace the bundle's Iconlist.js file's <defs> tags content with your own. If you want to put the entire SVG in Iconlist.js's return function, please be careful to convert inline style with react style (from string to object).

Configure your own list (since 1.0.4)

First, create a iconlist folder in your assets/admin folder. Then, create a Iconlist.js where you'll create a React functionnal component:

import * as React from 'react';

const Iconlist = () => {
}

export default Iconlist

Then, add the svg file content directly in a return function, like this:

import * as React from 'react';

const Iconlist = () => {
  return(
    <svg aria-hidden="true" className="iconlist" style={{ position: "absolute", width: 0, height: 0, overflow: "hidden" }} version="1.1" xmlns="http://www.w3.org/2000/svg">
      <defs>
        **your <symbol> here**
      </defs>
    </svg>
  )
}

export default Iconlist

ALWAYS REMEMBER TO CONVERT YOUR HTML PROPERTIES TO REACT PROPERTIES SYNTAX

example: <path style="fill: '#969695'" ... to <path style={{ fill: "#969695" }} ...

Load your SVG in your application's front

In your project's templates directory, create a new twig template. In this template, paste the symbol-defs file content. Once done, import your twig template in your base twig template right after the <body> tag:
{% include "yourtemplate.html.twig" %}

Use in your template files

Once installed, to use this new content type, you'll have to create a new property with the type font_icon_picker.

<property name="icon" type="font_icon_picker">
  <meta>
    <title lang="en">Section's Icon</title>
  </meta>
</property>

Also, to load the SVG on your back application, you'll have to create a new property with the type icon_list at the very top of your properties list.

<property name="your_icon_list" type="icon_list">
  <meta>
    <title lang="en"></title>
  </meta>
</property>

As the icon property returns an array, in your twig template, you will need to precise the first parameter of this array, for example:

{% if block.icon %}
  <svg class="{{block.icon[0]}}" aria-hidden="true" focusable="false">
    <use xlink:href='#{{block.icon[0]}}'/>
  </svg>
{% endif %}

Known issues

The icon picker cannot read an icon's <path> with style attribute on them. This is because we try to render an SVG within a react component, thus the style attribute should be an object, and the several kebab-case attributes should be converted to camelCase.

sevengroupfrance / sulu-icon-picker-bundle

Maintainers

Details