Associações de arquivos

Plataformas relevantes: Windows macOS

As associações de arquivos permitem que seu aplicativo processe tipos específicos de arquivo quando os usuários os abrem. Isso é particularmente útil para editores de texto, visualizadores de imagens ou qualquer aplicativo que trabalhe com formatos de arquivo específicos. Este guia explica como implementar associações de arquivos em seu aplicativo Wails v3.

Visão geral

Atualmente, o suporte a associações de arquivos no Wails v3 está disponível para:

• Windows (pacotes de instalação NSIS)
• macOS (pacotes de aplicativos)

Configuração

As associações de arquivos são configuradas no arquivo config.yml, localizado no diretório build do seu projeto.

Configuração básica

Para configurar associações de arquivos:

1. Abra build/config.yml
2. Adicione suas associações de arquivos na seção fileAssociations
3. Execute wails3 update build-assets para atualizar os recursos de compilação
4. Defina o campo FileAssociations nas opções do aplicativo
5. Empacote seu aplicativo usando wails3 package

Veja um exemplo de configuração:

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

Propriedades de configuração

Escuta de eventos de abertura de arquivo

Para processar eventos de abertura de arquivo em seu aplicativo, você pode escutar o evento 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...
}

Tutorial passo a passo

Vamos configurar associações de arquivos para um editor de texto simples:

# 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