|
|
@@ -0,0 +1,302 @@
|
|
|
+# KServerBrowser v1.2.0
|
|
|
+
|
|
|
+## 📋 Description
|
|
|
+
|
|
|
+**KServerBrowser** est un composant de navigateur de fichiers simple et moderne pour les applications web. Il permet de parcourir une arborescence de fichiers et dossiers, de sélectionner des fichiers avec prévisualisation, et de gérer la navigation avec un système de breadcrumbs.
|
|
|
+
|
|
|
+## 🚀 Fonctionnalités
|
|
|
+
|
|
|
+### ✨ Navigation
|
|
|
+- **Navigation par dossiers** : Parcours hiérarchique des dossiers
|
|
|
+- **Breadcrumbs intelligents** : Affichage du chemin de navigation avec raccourcis
|
|
|
+- **Historique de navigation** : Bouton retour pour revenir aux dossiers précédents
|
|
|
+- **Masquage automatique** : Option pour masquer les dossiers vides
|
|
|
+
|
|
|
+### 🎯 Sélection de fichiers
|
|
|
+- **Filtrage par extension** : Support des types de fichiers acceptés
|
|
|
+- **Prévisualisation d'images** : Modal de prévisualisation pour les images
|
|
|
+- **Sélection unique** : Interface de sélection avec validation
|
|
|
+- **Icônes contextuelles** : Icônes spécifiques selon le type de fichier
|
|
|
+
|
|
|
+### 🌍 Internationalisation
|
|
|
+- **Support multilingue** : Français, Anglais, Espagnol, Allemand
|
|
|
+- **Pack de langues personnalisables** : Possibilité d'ajouter des traductions
|
|
|
+- **Détection automatique** : Utilise la langue du document HTML
|
|
|
+
|
|
|
+### 🎨 Thèmes
|
|
|
+- **Thèmes prédéfinis** : Support des thèmes CSS
|
|
|
+- **Thèmes personnalisés** : Chargement de fichiers CSS externes
|
|
|
+- **Icônes personnalisables** : Remplacement des icônes par défaut
|
|
|
+
|
|
|
+## 📦 Installation
|
|
|
+
|
|
|
+### Méthode 1 : Script classique
|
|
|
+```html
|
|
|
+<script src="kserver.js"></script>
|
|
|
+```
|
|
|
+
|
|
|
+### Méthode 2 : ES6 Module
|
|
|
+```javascript
|
|
|
+import { NSEServerBrowser } from './kserver.js';
|
|
|
+```
|
|
|
+
|
|
|
+## 🔧 Utilisation
|
|
|
+
|
|
|
+### Configuration de base
|
|
|
+```javascript
|
|
|
+const browser = new NSEServerBrowser({
|
|
|
+ containerId: 'my-container',
|
|
|
+ dataSource: '/api/files',
|
|
|
+ theme: 'primary',
|
|
|
+ lang: 'fr',
|
|
|
+ acceptedTypeFiles: ['jpg', 'png', 'pdf'],
|
|
|
+ onValidate: (file) => {
|
|
|
+ console.log('Fichier sélectionné:', file);
|
|
|
+ }
|
|
|
+});
|
|
|
+
|
|
|
+// Ouvrir le navigateur
|
|
|
+browser.open();
|
|
|
+```
|
|
|
+
|
|
|
+### Configuration avancée
|
|
|
+```javascript
|
|
|
+const browser = new NSEServerBrowser({
|
|
|
+ // Conteneur (obligatoire)
|
|
|
+ containerId: 'file-browser', // ID du conteneur HTML
|
|
|
+
|
|
|
+ // Source de données (obligatoire)
|
|
|
+ dataSource: '/api/files', // URL ou tableau de données
|
|
|
+
|
|
|
+ // Apparence
|
|
|
+ theme: 'primary', // Thème CSS ou URL de fichier CSS
|
|
|
+ icons: {
|
|
|
+ folder: '📁',
|
|
|
+ file: '📄',
|
|
|
+ image: '🖼️'
|
|
|
+ },
|
|
|
+
|
|
|
+ // Comportement
|
|
|
+ lang: 'fr', // Langue (fr, en, es, de)
|
|
|
+ langModule: {
|
|
|
+ validate: 'Confirmer',
|
|
|
+ back: 'Retour'
|
|
|
+ },
|
|
|
+ acceptedTypeFiles: ['jpg', 'png', 'pdf'], // Extensions acceptées
|
|
|
+ autoHideEmptyFolders: true, // Masquer les dossiers vides
|
|
|
+
|
|
|
+ // Callbacks
|
|
|
+ onValidate: (file) => {
|
|
|
+ // Fichier sélectionné et validé
|
|
|
+ console.log('Fichier:', file.file);
|
|
|
+ console.log('Dossier:', file.folder);
|
|
|
+ },
|
|
|
+ onFileClick: (file) => {
|
|
|
+ // Fichier cliqué (avant validation)
|
|
|
+ console.log('Fichier cliqué:', file);
|
|
|
+ }
|
|
|
+});
|
|
|
+```
|
|
|
+
|
|
|
+## 📊 Structure des données
|
|
|
+
|
|
|
+### Format de données attendu
|
|
|
+```json
|
|
|
+{
|
|
|
+ "data": [
|
|
|
+ {
|
|
|
+ "type": "folder",
|
|
|
+ "name": "images",
|
|
|
+ "children": [
|
|
|
+ {
|
|
|
+ "type": "file",
|
|
|
+ "name": "photo.jpg",
|
|
|
+ "previewURL": "/thumbnails/photo.jpg",
|
|
|
+ "url": "/files/photo.jpg"
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+### Propriétés des nœuds
|
|
|
+| Propriété | Type | Description |
|
|
|
+|-----------|------|-------------|
|
|
|
+| `type` | string | `"folder"` ou `"file"` |
|
|
|
+| `name` | string | Nom du fichier/dossier |
|
|
|
+| `children` | array | Enfants du dossier (dossiers uniquement) |
|
|
|
+| `previewURL` | string | URL de prévisualisation (fichiers) |
|
|
|
+| `url` | string | URL du fichier (fichiers) |
|
|
|
+| `disabled` | boolean | Désactiver l'élément |
|
|
|
+
|
|
|
+## 🎨 CSS et thèmes
|
|
|
+
|
|
|
+### Classes CSS principales
|
|
|
+```css
|
|
|
+.kcontainer { /* Conteneur principal */ }
|
|
|
+.kheader { /* En-tête avec breadcrumbs */ }
|
|
|
+.k-breadcrumb { /* Fil d'Ariane */ }
|
|
|
+.kfile-tree { /* Arbre de fichiers */ }
|
|
|
+.kfolder { /* Dossier */ }
|
|
|
+.kfile { /* Fichier */ }
|
|
|
+.kfile.selected { /* Fichier sélectionné */ }
|
|
|
+.kfooter { /* Pied de page avec boutons */ }
|
|
|
+.k-validate-btn { /* Bouton de validation */ }
|
|
|
+.k-preview-btn { /* Bouton de prévisualisation */ }
|
|
|
+```
|
|
|
+
|
|
|
+### Thèmes disponibles
|
|
|
+- `primary` : Thème principal
|
|
|
+- `secondary` : Thème secondaire
|
|
|
+- `dark` : Thème sombre
|
|
|
+- URL personnalisée : `'https://example.com/theme.css'`
|
|
|
+
|
|
|
+## 🔌 API
|
|
|
+
|
|
|
+### Méthodes publiques
|
|
|
+
|
|
|
+#### `open()`
|
|
|
+Ouvre le navigateur de fichiers
|
|
|
+```javascript
|
|
|
+browser.open();
|
|
|
+```
|
|
|
+
|
|
|
+#### `destroy()`
|
|
|
+Ferme le navigateur et nettoie les ressources
|
|
|
+```javascript
|
|
|
+browser.destroy();
|
|
|
+```
|
|
|
+
|
|
|
+#### `getSelectedFiles()`
|
|
|
+Retourne le fichier actuellement sélectionné
|
|
|
+```javascript
|
|
|
+const selectedFile = browser.getSelectedFiles();
|
|
|
+```
|
|
|
+
|
|
|
+#### `goBack()`
|
|
|
+Retourne au dossier précédent
|
|
|
+```javascript
|
|
|
+browser.goBack();
|
|
|
+```
|
|
|
+
|
|
|
+### Événements
|
|
|
+
|
|
|
+#### `kserverbrowser:closed`
|
|
|
+Déclenché quand le navigateur est fermé
|
|
|
+```javascript
|
|
|
+document.addEventListener('kserverbrowser:closed', (e) => {
|
|
|
+ console.log('Navigateur fermé pour:', e.detail.containerId);
|
|
|
+});
|
|
|
+```
|
|
|
+
|
|
|
+## 🌍 Internationalisation
|
|
|
+
|
|
|
+### Langues supportées
|
|
|
+- **Français** (`fr`) : Valider, Retour, Prévisualiser, Fermer, Racine
|
|
|
+- **Anglais** (`en`) : Validate, Back, Preview, Close, Root
|
|
|
+- **Espagnol** (`es`) : Confirmar, Atrás, Vista previa, Cerrar, Raíz
|
|
|
+- **Allemand** (`de`) : Bestätigen, Zurück, Vorschau, Schließen, Wurzel
|
|
|
+
|
|
|
+### Ajout de traductions personnalisées
|
|
|
+```javascript
|
|
|
+const browser = new NSEServerBrowser({
|
|
|
+ lang: 'fr',
|
|
|
+ langModule: {
|
|
|
+ validate: 'Confirmer',
|
|
|
+ back: 'Précédent',
|
|
|
+ preview: 'Aperçu'
|
|
|
+ }
|
|
|
+});
|
|
|
+```
|
|
|
+
|
|
|
+## 🎯 Exemples d'utilisation
|
|
|
+
|
|
|
+### Exemple 1 : Sélecteur d'images
|
|
|
+```javascript
|
|
|
+const imageBrowser = new NSEServerBrowser({
|
|
|
+ containerId: 'image-selector',
|
|
|
+ dataSource: '/api/images',
|
|
|
+ acceptedTypeFiles: ['jpg', 'png', 'gif', 'webp'],
|
|
|
+ theme: 'primary',
|
|
|
+ lang: 'fr',
|
|
|
+ onValidate: (file) => {
|
|
|
+ // Insérer l'image dans un éditeur
|
|
|
+ insertImageIntoEditor(file.file);
|
|
|
+ }
|
|
|
+});
|
|
|
+```
|
|
|
+
|
|
|
+### Exemple 2 : Gestionnaire de documents
|
|
|
+```javascript
|
|
|
+const docBrowser = new NSEServerBrowser({
|
|
|
+ containerId: 'doc-manager',
|
|
|
+ dataSource: '/api/documents',
|
|
|
+ acceptedTypeFiles: ['pdf', 'doc', 'docx'],
|
|
|
+ autoHideEmptyFolders: true,
|
|
|
+ onValidate: (file) => {
|
|
|
+ // Ouvrir le document
|
|
|
+ window.open(file.file.url, '_blank');
|
|
|
+ }
|
|
|
+});
|
|
|
+```
|
|
|
+
|
|
|
+## 🐛 Dépannage
|
|
|
+
|
|
|
+### Erreurs courantes
|
|
|
+
|
|
|
+#### "Container not found"
|
|
|
+```javascript
|
|
|
+// Vérifier que l'élément existe
|
|
|
+const container = document.getElementById('my-container');
|
|
|
+if (!container) {
|
|
|
+ console.error('Conteneur non trouvé');
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+#### "Unable to load data from URL"
|
|
|
+```javascript
|
|
|
+// Vérifier l'URL et la structure des données
|
|
|
+fetch('/api/files')
|
|
|
+ .then(response => response.json())
|
|
|
+ .then(data => console.log(data));
|
|
|
+```
|
|
|
+
|
|
|
+#### "No callback onValidate was define"
|
|
|
+```javascript
|
|
|
+// Toujours définir le callback onValidate
|
|
|
+const browser = new NSEServerBrowser({
|
|
|
+ // ... autres options
|
|
|
+ onValidate: (file) => {
|
|
|
+ console.log('Fichier sélectionné:', file);
|
|
|
+ }
|
|
|
+});
|
|
|
+```
|
|
|
+
|
|
|
+## 📝 Changelog
|
|
|
+
|
|
|
+### v1.2.0 (2025-09-18)
|
|
|
+- Version initiale créée par rétro-ingénierie
|
|
|
+- Support complet de la navigation et sélection
|
|
|
+- Internationalisation multilingue
|
|
|
+- Système de thèmes
|
|
|
+- Prévisualisation d'images
|
|
|
+
|
|
|
+## 📄 Licence
|
|
|
+
|
|
|
+Ce composant est développé pour le projet NewSiteEditor et est destiné à un usage interne.
|
|
|
+
|
|
|
+## 🤝 Contribution
|
|
|
+
|
|
|
+Pour contribuer à ce composant :
|
|
|
+1. Identifier les améliorations nécessaires
|
|
|
+2. Tester les modifications
|
|
|
+3. Documenter les changements
|
|
|
+4. Soumettre les modifications
|
|
|
+
|
|
|
+## 📞 Support
|
|
|
+
|
|
|
+Pour toute question ou problème :
|
|
|
+- Vérifier la console pour les erreurs
|
|
|
+- Consulter la documentation des callbacks
|
|
|
+- Tester avec des données de structure correcte
|