The *Cotton Candy* extension
==========================
The ``cotton-candy`` extension provides Betty's legacy theme.

.. important::
    This extension requires :ref:`Node.js <installation-requirements-nodejs>`.

Enable this extension in your project's :doc:`configuration file </usage/project/configuration>` as follows:

.. tab-set::

   .. tab-item:: YAML

      .. code-block:: yaml

          extensions:
            cotton-candy: {}

   .. tab-item:: JSON

      .. code-block:: json

          {
            "extensions": {
              "cotton-candy": {}
            }
          }

Configuration
-------------
This extension is configurable:

.. tab-set::

   .. tab-item:: YAML

      .. code-block:: yaml

          extensions:
            cotton-candy:
              configuration:
                primary_inactive_color: '#ffc0cb'
                primary_active_color: '#ff69b4'
                link_inactive_color: '#149988'
                link_active_color: '#2a615a'
                featured_entities:
                  - entity_type: person
                    entity: P123
                  - entity_type: place
                    entity: Amsterdam

   .. tab-item:: JSON

      .. code-block:: json

          {
            "extensions": {
              "cotton-candy": {
                "configuration" : {
                  "primary_inactive_color": "#ffc0cb",
                  "primary_active_color": "#ff69b4",
                  "link_inactive_color": "#149988",
                  "link_active_color": "#2a615a",
                  "featured_entities": [
                    {
                      "entity_type": "person",
                      "entity": "P123"
                    },
                    {
                      "entity_type": "place",
                      "entity": "Amsterdam"
                    }
                  ],
                }
              }
            }
          }

``primary_inactive_color``
^^^^^^^^^^^^^^^^^^^^^^^^^^
:sup:`optional`

The case-insensitive hexadecimal code for the primary color. Defaults to ``#ffc0cb``.

``primary_active_color``
^^^^^^^^^^^^^^^^^^^^^^^^
:sup:`optional`

The case-insensitive hexadecimal code for the primary color for actively engaged elements. Defaults to ``#ff69b4``.

``link_inactive_color``
^^^^^^^^^^^^^^^^^^^^^^^
:sup:`optional`

The case-insensitive hexadecimal code for the link color. Defaults to ``#149988``.

``link_active_color``
^^^^^^^^^^^^^^^^^^^^^
:sup:`optional`

The case-insensitive hexadecimal code for the color of actively engaged links. Defaults to ``#2a615a``.

``featured_entities``
^^^^^^^^^^^^^^^^^^^^^
:sup:`optional`

A list of entities to feature on the front page. Each item has the following configuration:

``featured_entities[].entity_type``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:sup:`required`

The **entity type ID** of the entity (type) to feature, e.g. ``person``.

``featured_entities[].entity``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:sup:`required`

The **entity ID** of the entity to feature, e.g. ``P123``.

Templating
----------

Filters
^^^^^^^

- :py:func:`associated_file_references <betty.project.extension._theme.associated_file_references>`
- :py:func:`person_descendant_families <betty.project.extension._theme.person_descendant_families>`
- :py:func:`person_timeline_events <betty.project.extension._theme.person_timeline_events>`