From a37be78b26020e2d79c42c2fb5edf59e19534db7 Mon Sep 17 00:00:00 2001 From: Florian Sommariva Date: Fri, 15 Dec 2023 16:58:58 +0100 Subject: [PATCH] Update doc related to activityBar --- docs/customization.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/customization.md b/docs/customization.md index 4d20fc3d0..601761269 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -46,6 +46,21 @@ In json files, you can just override the primary keys you need. You have to over - `home.json` to define homepage settings. + - `activityBar`: This is a menu showing all search types (hiking practices, outdoor practices, tourist content categories and tourist events categories). + + - `shouldDisplay`: Boolean allowing this menu to be displayed or not. Its default value is `true`. + - `numberOfItemsBeforeTruncation` The number of items displayed on the screen. To see the others, click on the "Show more" button. Its default value is `8`. + - `links`: Allows you to customize the order and display of categories links. It's an array containing an object with 3 properties: + ```typescript + { + "type" : 'trek' | 'outdoorSite' | 'touristicContent' | 'touristicEvent' ; + "grouped" : boolean ; // If set to "true", all activities of the type are grouped under a single link. + "iconUrl" : string ; // Optional, url to replace default icon. Used only if "grouped" is set to "true", + } + ``` + + More explanations in this [comments](https://github.com/GeotrekCE/Geotrek-rando-v3/issues/560#issuecomment-1858166341) (in French). + - `suggestions`: You can define blocks to display suggestions groups with treks ID, outdoor sites ID, services ID or events ID to highlight on homepage (see https://github.com/GeotrekCE/Geotrek-rando-v3/blob/main/frontend/customization/config/home.json). Each group has the following properties :