Alfred UI

A JSON-based, object-oriented, event-driven and fully macOS native UI toolkit for Alfred.

launchpad Alfred UI

Create custom user interfaces to instantly run within Alfred, or within an independently launched application.

No compilation is required, edit the JSON and the native UI is created on the fly.

Getting Started

Alfred UIs are simple to initialise from within the Alfred UI workflow object. The .alfredui package follows a straightforward Structure which contains a ui.json which you can edit in your favourite text editor.

Follow our Tutorials to be hand held through creating your first Alfred UIs, or jump straight to the Technical Documentation if you're feeling adventurous.

Trying out Alfred UI

Code snippets throughout the documentation can be pasted into the "Try Alfred UI" workflow to live try and edit the UI.

Missing Gallery Workflow: /workflows/alfredapp/tryalfredui/

Technical Documentation

Preface

Section Summary
Structure File structure for .alfredui packages
Properties Property types throughout Alfred UI
Placeholders Placeholders for the preprocessing and dynamic processing of properties

API Documentation

Section Summary
ui.json Top-level file defining the entry point JSON for an Alfred UI
Window Configure top-level Alfred UI windows
Layouts Define how components are laid out in a view
Components User Interface components for Alfred UI
Templates Configurable and reusable components
Variables Set data and values for linking back-end logic to user interfaces
Events Enable Alfred UI to respond to a number of different triggers
Actions Perform tasks and updates on an Alfred UI
Pulse Regular running of a script as part of an Alfred UI
Debug Options for debugging an Alfred UI
Log Log Alfred UI events to help with debugging