Skip to content

karibsen-studio/kserver

Repository files navigation

📁 KServerBrowser – Documentation du module

KServerBrowser est un explorateur de fichiers JavaScript modulaire et personnalisable, intégrable sur n'importe quel site web.


⚙️ Configuration – Attributs disponibles

Vous devez fournir un objet de configuration au constructeur :

new ServerBrowser({ ... });

🔹 containerId (obligatoire)

  • Type : string | HTMLElement
  • Description : ID ou élément HTML dans lequel injecter l'explorateur.

🔹 dataSource (obligatoire)

  • Type : string | FileItem[]
  • Description : URL d'une API ou tableau JSON décrivant les fichiers/dossiers.

🔹 theme

  • Type : 'primary' | 'normal' | string
  • Description : Thème de l’interface, ou lien direct vers une feuille de style.

🔹 icons

  • Type : FileExplorerIcons
  • Description : Personnalisation des icônes par type de fichier (image, vidéo, dossier...).

🔹 fileTypes

  • Type : FileTypesOptions
  • Description : Activer ou désactiver la preview des images, vidéos, PDF, etc.

🔹 lang

  • Type : keyof typeof availableLangs
  • Description : Langue à utiliser parmi celles fournies (fr, en, es, de...).

🔹 langModule

  • Type : LangModule
  • Description : Module personnalisé de traduction (surcharge de lang).

🔹 acceptedTypeFiles

  • Type : string[]
  • Description : Liste blanche d’extensions de fichiers autorisées (ex. ['png', 'mp4']).

🔹 autoHideEmptyFolders

  • Type : boolean
  • Description : Masquer les dossiers vides ou sans fichiers acceptés.

🔹 onValidate

  • Type : (file: string) => void
  • Description : Callback déclenché lorsque l'utilisateur clique sur “Valider”.

🔹 onFileClick

  • Type : (file: FileItem) => void
  • Description : Callback déclenché au clic sur un fichier.

Exemple

    const explorer = new Karibsen.ServerBrowser({
      containerId: 'explorer-container',
      dataSource: '/api/test',
      theme: 'primary',
      lang: 'fr',
      langModule: Lang_fr,

      acceptedTypeFiles: ['png', 'jpg', 'jpeg'],
      autoHideEmptyFolders: true,

      onValidate: function(fileUrl) {
        alert('Fichier validé : ' + fileUrl);
      },

      onFileClick: function(file) {
        console.log('Fichier sélectionné :', file);
      }
    });

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published