Allow to customize which items get shown on the homepage and in which order

This fixes issue #470 and #894

Author: jbtronics

src/Settings/SystemSettings/CustomizationSettings.php

@@ -28,10 +28,13 @@
 use App\Settings\SettingsIcon;
 use App\Validator\Constraints\ValidTheme;
 use Jbtronics\SettingsBundle\Metadata\EnvVarMode;
+use Jbtronics\SettingsBundle\ParameterTypes\ArrayType;
+use Jbtronics\SettingsBundle\ParameterTypes\EnumType;
 use Jbtronics\SettingsBundle\Settings\Settings;
 use Jbtronics\SettingsBundle\Settings\SettingsParameter;
 use Jbtronics\SettingsBundle\Settings\SettingsTrait;
 use Symfony\Component\Translation\TranslatableMessage as TM;
+use Symfony\Component\Validator\Constraints as Assert;
 
 #[Settings(name: "customization", label: new TM("settings.system.customization"))]
 #[SettingsIcon("fa-paint-roller")]
@@ -46,17 +49,31 @@ class CustomizationSettings
     )]
     public string $instanceName = "Part-DB";
 
+    #[SettingsParameter(
+        label: new TM("settings.system.customization.theme"),
+        formType: ThemeChoiceType::class, formOptions: ['placeholder' => false]
+    )]
+    #[ValidTheme]
+    public string $theme = 'bootstrap';
+
     #[SettingsParameter(
         label: new TM("settings.system.customization.banner"),
         formType: RichTextEditorType::class, formOptions: ['mode' => 'markdown-full'],
         envVar: "BANNER", envVarMode: EnvVarMode::OVERWRITE,
     )]
     public ?string $banner = null;
 
-    #[SettingsParameter(
-        label: new TM("settings.system.customization.theme"),
-        formType: ThemeChoiceType::class, formOptions: ['placeholder' => false]
+    /**
+     * @var HomepageItems[] The items to show in the sidebar.
+     */
+    #[SettingsParameter(ArrayType::class,
+        label: new TM("settings.behavior.hompepage.items"),
+        description: new TM("settings.behavior.homepage.items.help"),
+        options: ['type' => EnumType::class, 'options' => ['class' => HomepageItems::class]],
+        formType: \Symfony\Component\Form\Extension\Core\Type\EnumType::class,
+        formOptions: ['class' => HomepageItems::class, 'multiple' => true, 'ordered' => true]
     )]
-    #[ValidTheme]
-    public string $theme = 'bootstrap';
+    #[Assert\NotBlank()]
+    #[Assert\Unique()]
+    public array $homepageitems = [HomepageItems::SEARCH, HomepageItems::BANNER, HomepageItems::FIRST_STEPS, HomepageItems::LICENSE, HomepageItems::LAST_ACTIVITY];
 }

src/Settings/SystemSettings/HomepageItems.php

@@ -0,0 +1,51 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2025 Jan Böhmer (https://github.com/jbtronics)
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published
+ *  by the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+
+namespace App\Settings\SystemSettings;
+
+use Symfony\Contracts\Translation\TranslatableInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+use function Symfony\Component\Translation\t;
+
+enum HomepageItems: string implements TranslatableInterface
+{
+    case SEARCH = 'search';
+    case BANNER = 'banner';
+    case LICENSE = 'license';
+    case FIRST_STEPS = 'first_steps';
+    case LAST_ACTIVITY = 'last_activity';
+
+    public function trans(TranslatorInterface $translator, ?string $locale = null): string
+    {
+        $key = match($this) {
+            self::SEARCH => 'search.placeholder',
+            self::BANNER => 'settings.system.customization.banner',
+            self::LICENSE => 'homepage.license',
+            self::FIRST_STEPS => 'homepage.first_steps.title',
+            self::LAST_ACTIVITY => 'homepage.last_activity',
+        };
+
+        return $translator->trans($key, locale: $locale);
+    }
+}

templates/homepage.html.twig

@@ -4,18 +4,13 @@
 {% import "components/search.macro.html.twig" as search %}
 {% import "vars.macro.twig" as vars %}
 
-{% block content %}
-
-    {% if is_granted('@system.show_updates') %}
-        {{ nv.new_version_alert(new_version_available, new_version, new_version_url) }}
-    {% endif %}
-
+{% block item_search %}
     {% if is_granted('@parts.read') %}
         {{ search.search_form("standalone") }}
-        <div class="mb-2"></div>
     {% endif %}
+{% endblock %}
 
-
+{% block item_banner %}
     <div class="rounded p-4 bg-body-secondary">
         <h1 class="display-3">{{ vars.partdb_title() }}</h1>
         <h4>
@@ -31,9 +26,11 @@
             </div>
         {% endif %}
     </div>
+{% endblock %}
 
+{% block item_first_steps %}
     {% if show_first_steps %}
-        <div class="card border-info mt-3">
+        <div class="card border-info">
             <div class="card-header bg-info ">
                 <h4><i class="fa fa-circle-play fa-fw " aria-hidden="true"></i> {% trans %}homepage.first_steps.title{% endtrans %}</h4>
             </div>
@@ -51,8 +48,10 @@
             </div>
         </div>
     {% endif %}
+{% endblock %}
 
-    <div class="card border-primary mt-3">
+{% block item_license %}
+    <div class="card border-primary">
         <div class="card-header bg-primary text-white">
             <h4><i class="fa fa-book fa-fw" aria-hidden="true"></i> {% trans %}homepage.license{% endtrans %}</h4>
         </div>
@@ -68,14 +67,35 @@
             <strong><i class="fas fa-comments fa-fw"></i> {% trans %}homepage.forum.caption{% endtrans %}:</strong> {% trans with {'%href%': 'https://github.com/Part-DB/Part-DB-server/discussions'}%}homepage.forum.text{% endtrans %}<br>
         </div>
     </div>
+{% endblock %}
 
+{% block item_last_activity %}
     {% if datatable is not null %}
-        <div class="card mt-3">
+        <div class="card">
             <div class="card-header"><i class="fas fa-fw fa-history"></i> {% trans %}homepage.last_activity{% endtrans %}</div>
             <div class="card-body">
                 {% import "components/history_log_macros.html.twig" as log %}
                 {{ log.last_activity_component(datatable) }}
             </div>
         </div>
     {% endif %}
-{% endblock %}
+{% endblock %}
+
+{% block content %}
+
+    {% if is_granted('@system.show_updates') %}
+        {{ nv.new_version_alert(new_version_available, new_version, new_version_url) }}
+    {% endif %}
+
+    {% for item in settings_instance('customization').homepageitems %}
+        {% if block('item_' ~ item.value) is defined %}
+            {{ block('item_' ~ item.value) }}
+            <div class="mb-2"></div>
+        {% else %}
+            <div class="alert alert-warning mt-3" role="alert">
+                Alert: The homepage item "{{ item.value }}" is not defined!
+            </div>
+        {% endif %}
+    {% endfor %}
+
+{% endblock %}

translations/messages.en.xlf

@@ -13441,5 +13441,17 @@ Please note, that you can not impersonate a disabled user. If you try you will g
         <target>Label profile updated successfully.</target>
       </segment>
     </unit>
+    <unit id="7lgFa7I" name="settings.behavior.hompepage.items">
+      <segment>
+        <source>settings.behavior.hompepage.items</source>
+        <target>Homepage items</target>
+      </segment>
+    </unit>
+    <unit id="FsrRdkp" name="settings.behavior.homepage.items.help">
+      <segment>
+        <source>settings.behavior.homepage.items.help</source>
+        <target><![CDATA[The items to show at the homepage. Order can be changed via drag & drop.]]></target>
+      </segment>
+    </unit>
   </file>
 </xliff>