Referensi API

Tentang Referensi Ini

Ini adalah referensi API lengkap untuk Wails v3. Referensi ini mendokumentasikan setiap tipe, metode, dan opsi publik yang tersedia dalam kerangka kerja ini.

Organisasi:

• Aplikasi - API aplikasi inti
• Jendela - Pembuatan dan pengelolaan jendela
• Menu - Menu aplikasi, konteks, dan baki sistem
• Peristiwa - Sistem peristiwa dan peristiwa bawaan
• Dialog - Dialog file dan pesan
• Runtime Frontend - API runtime frontend
• CLI - Antarmuka baris perintah

Konvensi API

if err := app.Run(); err != nil {
    log.Fatal(err)
}

func (s *MyService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error {
    // ctx is cancelled when the application is shutting down.
    return nil
}

app := application.New(application.Options{
    Name: "My App",
    Description: "A demo application",
    Services: []application.Service{
        application.NewService(&MyService{}),
    },
})

Konvensi API JavaScript

Penamaan

• Fungsi: camelCase (misalnya, setTitle())
• Konstanta: SCREAMINGSNAKECASE (misalnya, WINDOW_EVENT_FOCUS)

Asinkron secara Bawaan

Semua pemanggilan metode Go mengembalikan Promise:

// Async/await (recommended)
const result = await MyService.DoSomething()

// Promise chain
MyService.DoSomething()
    .then(result => console.log(result))
    .catch(error => console.error(error))

Penanganan Galat

Kesalahan Go menjadi pengecualian JavaScript:

try {
    await MyService.MightFail()
} catch (error) {
    console.error('Go error:', error)
}

Keamanan Tipe

Definisi TypeScript dibuat secara otomatis:

// Fully typed
import { Greet } from './bindings/GreetService'

const message: string = await Greet("World")

Struktur Paket

github.com/wailsapp/wails/v3/pkg/
├── application/          # Core application package
│   ├── application.go    # App type
│   ├── webview_window.go # Window management
│   ├── menu.go           # Menu types
│   ├── event_manager.go  # Event system
│   └── dialogs.go        # Dialog APIs
├── events/               # Event constants
└── services/             # Built-in services
    ├── dock/             # macOS dock (includes badge support)
    ├── fileserver/       # File-server service
    ├── kvstore/          # Key/value store
    ├── log/              # Structured logging service
    ├── notifications/    # Notifications service
    └── sqlite/           # SQLite service

Jalur Impor

Go

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

JavaScript

// Auto-generated bindings
import { MyMethod } from './bindings/MyService'

// Runtime APIs
import { Events, Window } from '@wailsio/runtime'

Referensi Tipe

Tipe Umum

// Application
type App struct { /* ... */ }
type Options struct { /* ... */ }

// Window
type WebviewWindow struct { /* ... */ } // implements the Window interface
type WebviewWindowOptions struct { /* ... */ }

// Menu
type Menu struct { /* ... */ }
type MenuItem struct { /* ... */ }

// Events — there is no generic Event type; events are typed by source.
type ApplicationEvent struct { /* ... */ }
type WindowEvent struct { /* ... */ }
type CustomEvent struct { /* ... */ }
type EventListener struct { /* ... */ }

// Dialogs
type OpenFileDialogOptions struct { /* ... */ }
type SaveFileDialogOptions struct { /* ... */ }

// Window runtime
interface WindowOptions {
    title?: string
    width?: number
    height?: number
    // ...
}

// Events
type EventCallback = (data: any) => void

// Bindings (auto-generated)
export function MyMethod(arg: string): Promise<string>

Perbedaan Antarplatform

Beberapa API berperilaku berbeda pada platform yang berbeda:

Perilaku khusus platform didokumentasikan di setiap bagian API.

Pembuatan Versi

Wails v3 mengikuti pembuatan versi semantik:

• Mayor (v3.x.x): Perubahan yang merusak kompatibilitas
• Minor (v3.x.x): Fitur baru, kompatibel dengan versi sebelumnya
• Patch (v3.x.x): Perbaikan bug, kompatibel dengan versi sebelumnya

Status saat ini: Beta (API stabil, penyempurnaan masih berlangsung)

Kebijakan Deprekasi

Ketika API dideprekasi:

1. Ditandai dalam dokumentasi dengan pemberitahuan penghentian penggunaan
2. Alternatif disediakan beserta panduan migrasi
3. Tetap dipelihara selama 1 versi mayor sebelum dihapus
4. Peringatan compiler (jika memungkinkan)

Stabilitas API

API Stabil ✅

API berikut stabil dan aman digunakan dalam produksi:

• API inti aplikasi
• Pengelolaan jendela
• Sistem menu
• Sistem peristiwa
• Dialog berkas
• Binding layanan

API Tidak Stabil ⚠️

API berikut dapat berubah sebelum rilis final:

• Beberapa opsi jendela tingkat lanjut
• Fitur khusus platform
• Fitur eksperimental

API yang tidak stabil ditandai dalam dokumentasi.

Mendapatkan Bantuan

Pertanyaan tentang API

1. Periksa referensi ini - Dokumentasi API lengkap
2. Periksa contoh - Contoh di GitHub
3. Cari di Discord - Server Discord
4. Tanyakan kepada komunitas - Kanal #help di Discord

Melaporkan Masalah API

Menemukan bug atau inkonsistensi?

1. Periksa masalah yang sudah ada - Masalah di GitHub
2. Buat laporan terperinci - Sertakan kode, pesan kesalahan, dan platform
3. Berikan langkah reproduksi - Contoh minimal yang menunjukkan masalah

Dokumentasi Terkait

• Tutorial - Pelajari dengan membangun aplikasi nyata
• Panduan - Panduan berorientasi tugas untuk skenario umum
• Fitur - Dokumentasi untuk setiap fitur
• Contoh - Contoh kode yang berfungsi dan tersedia di GitHub

Telusuri API: Gunakan navigasi di sebelah kiri untuk menjelajahi API tertentu.