Ассоциации файлов

Поддерживаемые платформы: Windows macOS

Ассоциации файлов позволяют приложению обрабатывать файлы определённых типов, когда пользователи открывают их. Это особенно полезно для текстовых редакторов, программ просмотра изображений и любых других приложений, работающих с определёнными форматами файлов. В этом руководстве объясняется, как реализовать ассоциации файлов в приложении Wails v3.

Обзор

В настоящее время Wails v3 поддерживает ассоциации файлов для следующих платформ:

• Windows (установочные пакеты NSIS)
• macOS (пакеты приложений)

Настройка

Ассоциации файлов настраиваются в файле config.yml, расположенном в каталоге build вашего проекта.

Базовая настройка

Чтобы настроить ассоциации файлов:

1. Откройте build/config.yml
2. Добавьте ассоциации файлов в раздел fileAssociations
3. Выполните wails3 update build-assets, чтобы обновить ресурсы сборки
4. Задайте поле FileAssociations в параметрах приложения
5. Упакуйте приложение с помощью wails3 package

Пример конфигурации:

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

Свойства конфигурации

Обработка событий открытия файлов

Чтобы обрабатывать события открытия файлов в приложении, можно отслеживать событие 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...
}

Пошаговое руководство

Рассмотрим настройку ассоциаций файлов для простого текстового редактора:

# 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