Stacks API

Come build with us.
Stacks API v13 for Stacks 5.0

< Stacks Developer API

Stack Bundles
What goes where and why inside a stack bundle.
Property List Reference
The property list is where your stack is configured.
Custom Controls Reference
The sidebar UI controls and their properties.
Templates Variable Reference
The Stacks templating system.

This content is open source. You can edit it and submit a pull request on GitHub.
This page is generated from this file.

Stack API

The Stack API is for building reusable elements that people add to a Stacks page. A stack can provide content, controls, layout, behavior and supporting resources.

Start here

Stack bundles explains the bundle structure and where files belong.
Property List Reference documents stack metadata and configuration.
Custom Controls Reference covers controls shown in the inspector.
Template Variables Reference documents values available to stack templates.

What is a stack?

A stack is one element in a Stacks layout. Every item added from the library is a stack. Stacks supplies an outside container, while the bundle supplies the inner content and defines its HTML, CSS, JavaScript, PHP, configurable properties and supporting resources.

In this documentation, Stacks refers to the application or platform, while stack refers to an individual page-building element created with the Stack API.

Where are stacks installed?

The built-in stacks reside inside the Stacks application bundle and should not be modified. Third-party stacks are installed in the Stacks application-support folder.

For development, use the .devstack extension. Stacks monitors development bundles for changes and provides additional logging. Finished products should use the .stack extension.

What is inside a stack?

A stack uses a standard macOS bundle structure. Its Contents folder contains an Info.plist and a Resources folder holding templates, libraries, assets and other files required by the stack.

Continue with stack bundles →