.. include:: /Includes.rst.txt

.. _installation:

============
Installation
============

.. rst-class:: bignums-tip

#. Install this extension from TER or with Composer:

   .. code-block:: bash

      composer require quellenform/t3x-iconpack

#. Install one of the existing iconpack providers:

   .. rst-class:: compact-list

   - `Bootstrap Icons <https://extensions.typo3.org/extension/iconpack_bootstrap>`_
   - `Boxicons <https://extensions.typo3.org/extension/iconpack_boxicons>`_
   - `Dripicons <https://extensions.typo3.org/extension/iconpack_dripicons>`_
   - `Elegant Icons <https://extensions.typo3.org/extension/iconpack_elegant>`_
   - `Feather Icons <https://extensions.typo3.org/extension/iconpack_feather>`_
   - `Font Awesome <https://extensions.typo3.org/extension/iconpack_fontawesome>`_
   - `Helium Icons <https://extensions.typo3.org/extension/iconpack_helium>`_
   - `Ikons vector icons <https://extensions.typo3.org/extension/iconpack_ikons>`_
   - `Ionicons <https://extensions.typo3.org/extension/iconpack_ionicons>`_
   - `Linea Icons <https://extensions.typo3.org/extension/iconpack_linea>`_
   - `Linearicons <https://extensions.typo3.org/extension/iconpack_linearicons>`_
   - `Lineicons <https://extensions.typo3.org/extension/iconpack_lineicons>`_
   - `Octicons <https://extensions.typo3.org/extension/iconpack_octicons>`_
   - `Themify Icons <https://extensions.typo3.org/extension/iconpack_themify>`_

   .. rst-class:: horizbuttons-tip-m

      - :ref:`...or create your own iconpack provider <customIconpack>`

#. Add the provided TypoScript to your template

#. [Optional] Install the `Iconpack for Bootstrap Package
   <https://extensions.typo3.org/extension/bootstrap_package_iconpack>`_
   extension

   ...if you want to use Iconpack with `Bootstrap Package
   <https://extensions.typo3.org/extension/bootstrap_package>`_ and want to
   replace the hard-coded icons with a better and flexible system.