v2.3.0

What's Changed

• [minor] 200 - Create Aside component for sidebars by @mguihal in #201
• [Minor] 200 - Move view components to common layout folder by @mguihal in #202
• [Minor] 200 - Move existing layout to create new "leftMenu" layout by @mguihal in #203
• [Minor] 200 - Add "topMenu" Layout by @mguihal in #205
• [Minor] 200 - Add documentation for layouts by @mguihal in #207
• [Patch] 200 - Mobile form toolbar hidden behind bottom navigation by @mguihal in #208

Full Changelog: v2.2.1...v2.3.0

Guide de migration

1/ Fichier de configuration

Le fichier de configuration a changé, il faut désormais ajouter les attributs suivants :

{
  title: "Nom de l'app", // auparavant dans /frontend/src/App.jsx
  layout: {
    name: "leftMenu",
    options: {},
  },
}

Il est également possible de renforcer le typage de la configuration en incluant ce code dans le fichier de configuration

import { LayoutOptions } from "../layouts/LayoutContext";

interface ConfigInterface {
  middlewareUrl: string;
  mapboxAccessToken: string;
  importableResources: string[];
  title: string;
  layout: LayoutOptions;
}

const config: ConfigInterface = {
  ...
}

Toute la documentation pour le fichier de configuration est ici : https://github.com/assemblee-virtuelle/archipelago/blob/master/docs/configuration.md

2/ Modification de App.jsx

Si vous avez surchargé le fichier /frontend/src/App.jsx, il est nécessaire de le modifier en rajoutant ces lignes

import CssBaseline from '@mui/material/CssBaseline';
import config from './config/config';
import { Layout } from './common/layout'; // Le chemin du fichier à importer a changé
import { LayoutProvider } from './layouts/LayoutProvider';

...
<ThemeProvider theme={customTheme}>
  <CssBaseline />
  <LayoutProvider layoutOptions={config.layout}>
    <Admin 
      ...
      title={config.title}
      ...
    >
      ...
    </Admin>
  </LayoutProvider>
</ThemeProvider>
...

3/ Customisation du layout

Si vous avez surchargé des fichiers dans /frontend/src/layout, vous pouvez suivre la documentation pour utiliser un des deux layouts proposés : https://github.com/assemblee-virtuelle/archipelago/blob/master/docs/layouts.md

4/ Autres fichiers modifiés

Si vous avez surchargés d'autres fichiers, notamment ceux dans /frontend/src/resources, il est nécessaire de changer les imports des composants Create, Edit, Show, List. Une lecture attentive des fichiers modifiés est nécessaire pour voir quels changements sont appropriés à votre cas.