Merge pull request #8 from liquidlight/7-add-icon-library

Create Icon Library

Configuration/Icons.php

@@ -0,0 +1,24 @@
+<?php
+
+return [
+	'modulegroup-datalisting' => [
+		'provider' => \TYPO3\CMS\Core\Imaging\IconProvider\SvgIconProvider::class,
+		'source' => 'EXT:module_data_listing/Resources/Public/Icons/Modulegroup.svg',
+	],
+	'module-listing-company' => [
+		'provider' => \TYPO3\CMS\Core\Imaging\IconProvider\SvgIconProvider::class,
+		'source' => 'EXT:module_data_listing/Resources/Public/Icons/Company.svg',
+	],
+	'module-listing-map' => [
+		'provider' => \TYPO3\CMS\Core\Imaging\IconProvider\SvgIconProvider::class,
+		'source' => 'EXT:module_data_listing/Resources/Public/Icons/Map.svg',
+	],
+	'module-listing-tools' => [
+		'provider' => \TYPO3\CMS\Core\Imaging\IconProvider\SvgIconProvider::class,
+		'source' => 'EXT:module_data_listing/Resources/Public/Icons/Tools.svg',
+	],
+	'module-listing-users' => [
+		'provider' => \TYPO3\CMS\Core\Imaging\IconProvider\SvgIconProvider::class,
+		'source' => 'EXT:module_data_listing/Resources/Public/Icons/Users.svg',
+	],
+];

README.md

@@ -96,3 +96,24 @@ module.tx_moduledatalisting {
 	}
 }
 ```
+
+## Icons
+
+The Module Data Listing package comes with several pre-packaged icons you can use for your custom modules. We always welcome more additions, so if you create an icon and would like it included as standard, please create an issue or submit a PR.
+
+### Usage
+
+To use an icon, use the `iconIdentifier` from the table below when using the `registerModule` method.
+
+The `module-listing-users` icon is used with the default `tx_module_data_listing_feusers` module.
+
+### Available Icons
+
+The icons currently available are:
+
+| iconIdentifier | preview |
+|---|---|
+| `module-listing-company` | ![module-listing-company](./Resources/Public/Icons/Company.svg) |
+| `module-listing-map` | ![module-listing-mao](./Resources/Public/Icons/Map.svg) |
+| `module-listing-tools` | ![module-listing-tools](./Resources/Public/Icons/Tools.svg) |
+| `module-listing-users` | ![module-listing-users](./Resources/Public/Icons/Users.svg) |

ext_tables.php

@@ -12,6 +12,7 @@
 		[
 			'access' => 'user,group',
 			'name' => 'datalisting',
+			'iconIdentifier' => 'modulegroup-datalisting',
 			'labels' => 'LLL:EXT:module_data_listing/Resources/Private/Language/locallang_mod_datalisting.xlf',
 		]
 	);
@@ -39,7 +40,7 @@
 		],
 		[
 			'access' => 'user,group',
-			'icon' => 'EXT:module_data_listing/Resources/Public/Icons/FeUsers.svg',
+			'iconIdentifier' => 'module-listing-users',
 			'labels' => 'LLL:EXT:module_data_listing/Resources/Private/Language/locallang_feusers.xlf',
 			'navigationComponentId' => '',
 			'inheritNavigationComponentFromMainModule' => false,