https://github.com/framasoft/framanav
Barre de navigation commune aux sites du réseau
https://github.com/framasoft/framanav
Last synced: 10 months ago
JSON representation
Barre de navigation commune aux sites du réseau
- Host: GitHub
- URL: https://github.com/framasoft/framanav
- Owner: framasoft
- License: other
- Created: 2013-02-22T17:50:07.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T21:42:56.000Z (over 3 years ago)
- Last Synced: 2025-07-12T07:32:04.818Z (10 months ago)
- Language: CSS
- Size: 23 MB
- Stars: 4
- Watchers: 4
- Forks: 3
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://framagit.org)
 **Framasoft uses GitLab** for the development of its free softwares. Our Github repositories are only mirrors.
If you want to work with us, **fork us on [framagit.org](https://framagit.org)**. (no registration needed, you can sign in with your Github account)
 **Framasoft utilise GitLab** pour le développement de ses logiciels libres. Nos dépôts Github ne sont que des miroirs.
Si vous souhaitez travailler avec nous, **forkez-nous sur [framagit.org](https://framagit.org)**. (l'inscription n'est pas nécessaire, vous pouvez vous connecter avec votre compte Github)
* * *
Framanav
========
Barre de navigation commune aux sites du réseau
+ Pied de page
+ Modale de don
+ Modale d’info
+ Bandeau d’info
+ Inscription à la newsletter en optin
+ CSS custom
+ Scripts custom
Installation
--------------------
1) Héberger la nav
```bash
cd /var/www/framasoft.org/
git clone https://framagit.org/framasoft/framanav.git nav
```
2) Configurer le serveur pour autoriser les requête Cross-domain
3) Ajouter le script `nav.js` à la fin du `` du site :
```html
```
Dans certain cas, le CMS utilisé compresse à la volée le javascript,
il faut alors utiliser ce code là :
```html
const s = document.createElement('script');
s.src="https://framasoft.org/nav/nav.js";
document.getElementsByTagName('head')[0].appendChild(script);
```
Tester/Configurer
--------------------
### Config
Par défaut, chaque composant (bandeau, modale, etc) de la nav contient
une methode `siteConfig()` avec les paramètres requis pour un affichage
contextualisé en fonction du site (dans le `switch … case`).
Il est également possible de passer la configuration des composants directement
dans la page où se trouve la nav (exemple dans `app/assets/test/verbose.html`).
Cette config sera prioritaire.
### Tests
De même, lorsqu’on modifie le cœur de la nav, une série de pages d’exemple dans
le dossier `test` permettent de vérifier grossièrement que rien ne sera cassé.
### Débuggage
Il est fortement recommandé d’utiliser l’extension
[VueJS devtools](https://addons.mozilla.org/fr/firefox/addon/vue-js-devtools/)
pour facilement voir l’état des variables de chaque composant.