Associations de fichiers

Plateformes concernées : Windows macOS

Les associations de fichiers permettent à votre application de gérer certains types de fichiers lorsque les utilisateurs les ouvrent. Elles sont particulièrement utiles pour les éditeurs de texte, les visionneuses d’images ou toute application qui traite des formats de fichiers particuliers. Ce guide explique comment implémenter des associations de fichiers dans votre application Wails v3.

Vue d’ensemble

Dans Wails v3, les associations de fichiers sont actuellement prises en charge pour :

• Windows (paquets d’installation NSIS)
• macOS (paquets d’application)

Configuration

Les associations de fichiers se configurent dans le fichier config.yml situé dans le répertoire build de votre projet.

Configuration de base

Pour configurer les associations de fichiers :

1. Ouvrez build/config.yml
2. Ajoutez vos associations de fichiers dans la section fileAssociations
3. Exécutez wails3 update build-assets pour mettre à jour les ressources de compilation
4. Définissez le champ FileAssociations dans les options de l’application
5. Créez le paquet de votre application avec wails3 package

Voici un exemple de configuration :

fileAssociations:
  - ext: myapp
    name: MyApp Document
    description: MyApp Document File
    iconName: myappFileIcon
    role: Editor
  - ext: custom
    name: Custom Format
    description: Custom File Format
    iconName: customFileIcon
    role: Editor

Propriétés de configuration

Écoute des événements d’ouverture de fichiers

Pour gérer les événements d’ouverture de fichiers dans votre application, vous pouvez écouter l’événement events.Common.ApplicationOpenedWithFile :

package main

import (
    "github.com/wailsapp/wails/v3/pkg/application"
    "github.com/wailsapp/wails/v3/pkg/events"
)

func main() {
    app := application.New(application.Options{
        Name: "MyApp",
        FileAssociations: []string{".txt", ".md"}, // Specify supported extensions
    })

    // Listen for files being used to open the application
    app.Event.OnApplicationEvent(events.Common.ApplicationOpenedWithFile, func(event *application.ApplicationEvent) {
        associatedFile := event.Context().Filename()
        app.Dialog.Info().SetMessage("Application opened with file: " + associatedFile).Show()
    })

    // Create your window and run the app...
}

Tutoriel pas à pas

Voyons comment configurer les associations de fichiers pour un éditeur de texte simple :

# build/config.yml
fileAssociations:
  - ext: txt
    name: Text Document
    description: Plain Text Document
    iconName: textFileIcon
    role: Editor

wails3 update build-assets

app := application.New(application.Options{
  Name: "MyApp",
  FileAssociations: []string{".txt", ".md"}, // Specify supported extensions
})

wails3 package