Droppy

https://getdroppy.app/docs
Admin
Droppy is a native macOS app that turns the top of your screen into a working surface featuring a...
Tokens:97,233
Snippets:1,490
Trust Score:6.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### Setup and verification commands

Source: https://getdroppy.app/docs/droppykit/add-spm

Commands to clone the SDK, set PATH, and verify the droppykit tool; a Swift Package.swift example; and shell commands to check the link.

```bash
git clone https://gitlab.com/droppyformac1/droppykit.git
export PATH="$PWD/droppykit/Scripts:$PATH"
droppykit

```

```bash
droppykit version    # which SDK this is, which one the PATH finds, what a droplet pins
droppykit update     # pull the newest SDK; inside a droplet, move its pin too

```

```swift
// swift-tools-version: 6.2
import PackageDescription

let package = Package(
    name: "WorldClock",
    platforms: [.macOS(.v14)],
    products: [
        .library(name: "WorldClock", type: .dynamic)
    ],
    dependencies: [
        .package(url: "https://gitlab.com/droppyformac1/droppykit.git", from: "15.3.0")
    ],
    targets: [
        .target(
            name: "WorldClock",
            dependencies: ["DroppyKit"]
        )
    ]
)

```

```bash
# 0 in a correct bundle, non-zero in a broken one.
nm -u WorldClock.droplet/Contents/MacOS/WorldClock | grep -c '9DroppyKit.*vau'

# Must name the framework, and must not name libDroppyKit.
otool -L WorldClock.droplet/Contents/MacOS/WorldClock | grep DroppyKit

```

--------------------------------

### Settings Pane Examples

Source: https://getdroppy.app/docs/droppykit-handbook

Swift code examples for building a settings pane in a Droppy droplet.

```swift
extension WorldClockDroplet: SettingsPaneProviding {
    public func makeSettingsPane(context: SettingsPaneContext) -> AnyView {
        AnyView(WorldClockSettings(droplet: self))
    }

    public var settingsSearchEntries: [SettingsSearchEntry] {
        [SettingsSearchEntry(title: "Show seconds", keywords: ["time", "clock"])]
    }
}

```

```swift
VStack(alignment: .leading, spacing: DroppySpacing.lg) {
    DropletSettingsCard {
        DropletToggleRow(
            title: "Show seconds",
            subtitle: "Ticks the shelf widget every second instead of every minute.",
            isOn: droplet.showsSecondsBinding
        )
        DropletSettingsDivider()
        DropletSliderRow(
            title: "Refresh",
            value: "\(Int(interval))s",
            binding: $interval,
            range: 1...60
        )
        DropletSettingsDivider()
        DropletControlRow(title: "Clocks") {
            DropletValuePill(text: "\(droplet.clockCount)")
        }
    }
}

```

```swift
var showsSecondsBinding: Binding<Bool> {
    Binding(
        get: { self.host?.preferences.value(forKey: "showsSeconds", default: true) ?? true },
        set: { self.host?.preferences.setValue($0, forKey: "showsSeconds") }
    )
}

```

--------------------------------

### Icon and Avatar Configuration Examples

Source: https://getdroppy.app/docs/droppykit/icons

Two code examples: the structure of a .icon directory and a JSON snippet for the creator avatar configuration.

```text
WorldClock.icon/
  icon.json          the document: groups, layers, fills, specializations
  Assets/
    dial.png         every image icon.json names by `image-name`

```

```json
"creator": {
  "name": "Jane Doe",
  "kind": "community",
  "url": "https://jane.example",
  "avatar": "Creator.png"
}

```

--------------------------------

### Expanded Surface Code Examples

Source: https://getdroppy.app/docs/droppykit/expanded-surfaces

Code examples demonstrating how to declare an expanded surface, provide its size, and present it.

```swift
extension WorldClockDroplet: ExpandedSurfaceProviding {
    public var expandedSurfaces: [ExpandedSurfaceDescriptor] {
        [
            ExpandedSurfaceDescriptor(
                id: "clocks-detail",
                title: "World Clock",
                systemImage: "globe",
                suppresses: [.shelfWidgets, .autoCollapse]
            )
        ]
    }
}
```

```swift
public func expandedSurfaceSize(
    _ id: ExpandedSurfaceID,
    fitting proposal: ExpandedSurfaceSizeProposal
) -> CGSize? {
    CGSize(width: proposal.standardSize.width, height: CGFloat(clocks.count) * 44 + 64)
}
```

```swift
let presentation = host.notchSurface.presentExpandedSurface(
    ExpandedSurfacePresentationRequest(surfaceID: "clocks-detail", opensShelf: true)
)
```

--------------------------------

### DroppyKit Harness Code Examples

Source: https://getdroppy.app/docs/droppykit-handbook

Code examples from the DroppyKit handbook: a Swift harness entry point, shell commands for running the harness, and shell commands for generating screenshots.

```swift
import DroppyKit
import DroppyKitHarness

@main
struct WorldClockHarness: DropletHarnessApp {
    static func makeDroplet() -> any Droplet { WorldClockDroplet() }
}
```

```bash
droppykit run                        # or Scripts/run-harness.sh WorldClockHarness
droppykit run --page shelf-widget    # open straight onto one surface
```

```bash
droppykit run -- --shots ./shots
droppykit run -- --shots ./shots --shot-height 1900
```

--------------------------------

### Droppy Live Activity Code Examples

Source: https://getdroppy.app/docs/droppykit-handbook

Code examples from the Droppy Live Activity documentation, including publishing state, compact presentation, yielding, and interactive rows.

```swift
extension WorldClockDroplet: LiveActivityProviding {
    public var liveActivityState: AnyPublisher<LiveActivityState?, Never> {
        activitySubject.eraseToAnyPublisher()
    }

    private func publishActivity() {
        activitySubject.send(
            LiveActivityState(
                priority: 200,
                accessibilityTitle: "Amsterdam \(time)",
                isInteractive: false
            )
        )
    }
}
```

```swift
public func makeCompactLeading() -> AnyView {
    AnyView(
        Image(systemName: "globe")
            .font(.system(size: DroppyLiveActivityMetrics.iconSize, weight: .medium))
            .foregroundStyle(AdaptiveColors.notchSurfacePrimaryText)
            .padding(.trailing, DroppySpacing.sm)
    )
}

public func makeCompactTrailing() -> AnyView {
    AnyView(
        Image(systemName: "globe")
            .font(.system(size: DroppyLiveActivityMetrics.iconSize, weight: .medium))
            .foregroundStyle(AdaptiveColors.notchSurfacePrimaryText)
            .padding(.trailing, DroppySpacing.sm)
    )
}
```

```swift
host.liveActivity.yield(reason: .idle)
```

```swift
Button { skip() } label: { Image(systemName: "forward.fill") }
    .buttonStyle(DroppyLiveActivityControlStyle(prominence: .accent))
```

--------------------------------

### DroppyKit Widget Examples

Source: https://getdroppy.app/docs/droppykit-handbook

Code examples from the DroppyKit handbook demonstrating widget declaration, view body branching, and layout invalidation.

```swift
extension WorldClockDroplet: ShelfWidgetProviding {
    public var widgetDescriptors: [ShelfWidgetDescriptor] {
        [
            ShelfWidgetDescriptor(
                id: "clocks",
                title: "World Clock",
                systemImage: "globe",
                layoutTraits: ShelfWidgetLayoutTraits(
                    preferredSoloWidth: 420,
                    preferredPairedWidth: 210,
                    contentHeight: .fixed(150)
                ),
                searchKeywords: ["time", "timezone"]
            )
        ]
    }
}
```

```swift
var body: some View {
    VStack(alignment: .leading, spacing: DroppySpacing.sm) {
        header
        if context.isCompact { compactBody } else { fullBody }
    }
}
```

```swift
host.shelf.invalidateLayout(for: "clocks")
```

--------------------------------

### Creator metadata example

Source: https://getdroppy.app/docs/droppykit-handbook

Example of the creator metadata object in the icon document, specifying the creator's name, kind, URL, and avatar image file.

```json
"creator": {
  "name": "Jane Doe",
  "kind": "community",
  "url": "https://jane.example",
  "avatar": "Creator.png"
}

```

--------------------------------

### Package.swift for a DroppyKit droplet

Source: https://getdroppy.app/docs/droppykit-handbook

Example Package.swift for a droplet. The product must be a dynamic library; the harness target is for development and is not shipped.

```swift
// swift-tools-version: 6.2
import PackageDescription

let package = Package(
    name: "WorldClock",
    platforms: [.macOS(.v14)],
    products: [
        .library(name: "WorldClock", type: .dynamic, targets: ["WorldClock"])
    ],
    dependencies: [
        .package(url: "https://gitlab.com/droppyformac1/droppykit.git", from: "1.2.0")
    ],
    targets: [
        .target(
            name: "WorldClock",
            dependencies: [.product(name: "DroppyKit", package: "droppykit")]
        ),
        .executableTarget(
            name: "WorldClockHarness",
            dependencies: [
                "WorldClock",
                .product(name: "DroppyKitHarness", package: "droppykit")
            ]
        )
    ]
)
```

--------------------------------

### DroppyKit CLI Commands and Installation Path

Source: https://getdroppy.app/docs/droppykit-handbook

Commands and paths used in the DroppyKit workflow: validation, submission, and installation location.

```bash
droppykit validate
```

```bash
droppykit submit
```

```bash
~/Library/Application Support/Droppy/Droplets/<your-id>/<YourDroplet>.droplet
```

--------------------------------

### Droplet installation path

Source: https://getdroppy.app/docs/droppykit/playground

Shows the file path where a droplet bundle is copied after installation in the Playground. The path includes the droplet ID and the original bundle name.

```text
~/Library/Application Support/Droppy Playground/Droplets/<droplet-id>/<Name>.droplet
```

--------------------------------

### WorldClockDroplet implementation

Source: https://getdroppy.app/docs/droppykit/api/droplet-host

Example of a droplet class that stores the host and uses its services.

```swift
final class WorldClockDroplet: Droplet, ShelfWidgetProviding {
    static let id: DropletID = "worldclock"
    private var host: DropletHost?

    func activate(host: DropletHost) throws {
        self.host = host
        let zone = host.preferences.value(forKey: "zone", default: "UTC")
        host.log.info("activated for \(zone)")
    }

    func deactivate() { host = nil }
}
```

--------------------------------

### AdaptiveColors foreground style

Source: https://getdroppy.app/docs/droppykit-handbook

Example of using AdaptiveColors for foreground text on dark surfaces.

```swift
Text(title).foregroundStyle(AdaptiveColors.notchSurfacePrimaryText)
Text(detail).foregroundStyle(AdaptiveColors.notchSurfacePrimaryText)
```

--------------------------------

### init(priority:accessibilityTitle:isInteractive:joinsPersistentActivitySet:compactPresentation:)

Source: https://getdroppy.app/docs/droppykit/api/live-activity-state

Creates an activity state, optionally describing a product-owned leading compact accessory that the host may hoist safely. This is the 0.6.2 ABI entry point.

```APIDOC
## init(priority:accessibilityTitle:isInteractive:joinsPersistentActivitySet:compactPresentation:)

### Description
Creates an activity state, optionally describing a product-owned leading compact accessory that the host may hoist safely. This is the 0.6.2 ABI entry point.

### Method
Initializer

### Signature
`init(priority: Int, accessibilityTitle: String, isInteractive: Bool = false, joinsPersistentActivitySet: Bool = false, compactPresentation: CompactLiveActivityPresentationMetadata?)`

### Parameters
- **priority** (Int) - Required - Priority when several droplets want the compact slot at once. Higher wins; the host resolves ties in registration order.
- **accessibilityTitle** (String) - Required - Accessibility title for the activity pill.
- **isInteractive** (Bool) - Optional - True when the expanded activity accepts pointer interaction. Defaults to `false`.
- **joinsPersistentActivitySet** (Bool) - Optional - True when the activity joins the host's persistent live-activity set. Defaults to `false`.
- **compactPresentation** (CompactLiveActivityPresentationMetadata?) - Optional - Product-neutral metadata for a host that mounts a shadowing droplet's leading compact accessory outside the clipping surface. `nil` means the activity uses the ordinary compact mount only.
```

--------------------------------

### init()

Source: https://getdroppy.app/docs/droppykit/api/droppy-markdown-editor-commands

Creates an unbound command bus.

```APIDOC
## init()

### Description
Creates an unbound command bus.

### Method
init

### Signature
`@MainActor init()`

### Parameters
None.

### Return Value
A new instance of DroppyMarkdownEditorCommands.

### Example
```swift
let commands = DroppyMarkdownEditorCommands()
```
```

--------------------------------

### init(preferredSoloWidth:preferredPairedWidth:pairWeight:minimumWidth:contentHeight:)

Source: https://getdroppy.app/docs/droppykit/api/shelf-widget-layout-traits

Initializer for creating layout traits for a shelf widget.

```APIDOC
## init(preferredSoloWidth:preferredPairedWidth:pairWeight:minimumWidth:contentHeight:)

### Description
Creates layout traits for a shelf widget. The optional width defaults preserve existing source and binary call sites, but they do not create a host-layout fallback. A current Droppy host refuses a widget descriptor unless both `preferredSoloWidth` and `preferredPairedWidth` are explicit.

### Method
Initializer

### Signature
`init(preferredSoloWidth: CGFloat? = nil, preferredPairedWidth: CGFloat? = nil, pairWeight: Double = 1, minimumWidth: CGFloat? = nil, contentHeight: ShelfWidgetContentHeight = .standard)`

### Parameters
- **preferredSoloWidth** (CGFloat?) - Optional - Preferred width in points when the widget is shown alone. Must be explicit for current Droppy hosts.
- **preferredPairedWidth** (CGFloat?) - Optional - Preferred width in points when the widget shares a row with one to three other widgets. Must be explicit for current Droppy hosts.
- **pairWeight** (Double) - Optional - Relative weight when the shelf splits space across a grouped row. Default is 1 (even share).
- **minimumWidth** (CGFloat?) - Optional - Hard minimum width in points. `nil` uses the shelf's floor.
- **contentHeight** (ShelfWidgetContentHeight) - Optional - Content height request. Default is `.standard`.

### Return Value
A `ShelfWidgetLayoutTraits` instance.
```

--------------------------------

### init(surface:seat:slotSize:)

Source: https://getdroppy.app/docs/droppykit/api/compact-live-activity-context

Creates a compact context with the given surface kind, seat type, and slot size. This initializer is constructed by hosts and read by droplets.

```APIDOC
## init(surface:seat:slotSize:)

### Description
Creates a compact context. Constructed by hosts, read by droplets.

### Signature
`init(surface: DropletSurfaceKind, seat: DropletLiveActivitySeat, slotSize: CGSize)`

### Parameters
- **surface** (DropletSurfaceKind) - The surface family hosting the accessory.
- **seat** (DropletLiveActivitySeat) - The seat the accessory is being rendered for.
- **slotSize** (CGSize) - The resolved content slot, in points.

### Notes
- The seat `.compact` is the island/notch owner seat; `.secondary` is the detached companion pill.
- For the companion pill, slotSize is the round content area inside the puck; for owner wings, it is the wing rect the accessory may fill.
```

--------------------------------

### Run the droplet

Source: https://getdroppy.app/docs/droppykit/first-droplet

Run the droplet in the harness to preview it.

```shell
droppykit run

```

--------------------------------

### Build, validate, and submit

Source: https://getdroppy.app/docs/droppykit/first-droplet

Build, validate, and submit the droplet using the CLI.

```shell
droppykit build      # produces WorldClock.droplet
droppykit validate   # the same checks the submission runs
droppykit submit     # open the submission form, filled in from this checkout

```

--------------------------------

### init(rawValue:)

Source: https://getdroppy.app/docs/droppykit/api/grouped-corners

Creates an option set from raw bits.

```APIDOC
## init(rawValue:)

### Description
Creates an option set from raw bits.

### Signature
`init(rawValue: UInt8)`

### Parameters
- **rawValue** (UInt8) - The raw bits to initialize the option set.

```

--------------------------------

### Handle HUD presentation refusal

Source: https://getdroppy.app/docs/droppykit/host-support

Example of handling a refusal when presenting a HUD surface, showing that a failed presentation is not an error and should not be retried.

```unknown
if !host.hud.present(request) {
    // Not an error. The surface was taken, or this Droppy does not
    // mount it. Either way the moment has passed; do not retry.
    host.log.debug("HUD not shown")
}
```

--------------------------------

### init(availableSize:surface:displayID:isHostShelfTransitioning:isPreview:presentation:)

Source: https://getdroppy.app/docs/droppykit/api/expanded-surface-context

Creates an ExpandedSurfaceContext instance. This initializer is constructed by hosts and read by droplets, providing contextual information about the surface mount.

```APIDOC
## init(availableSize:surface:displayID:isHostShelfTransitioning:isPreview:presentation:)

### Description
Creates a context. Constructed by hosts, read by droplets.

### Method
Initializer

### Signature
`init(availableSize: CGSize, surface: DropletSurfaceKind = .builtInNotch, displayID: UInt32, isHostShelfTransitioning: Bool = false, isPreview: Bool = false, presentation: ExpandedSurfacePresentation)`

### Parameters
- **availableSize** (CGSize) - Required - The size the host is laying the surface out at.
- **surface** (DropletSurfaceKind) - Optional - Defaults to `.builtInNotch`. The surface kind hosting it.
- **displayID** (UInt32) - Required - The display hosting it.
- **isHostShelfTransitioning** (Bool) - Optional - Defaults to `false`. True while the shelf's open or close spring is in flight.
- **isPreview** (Bool) - Optional - Defaults to `false`. True when the view is mounted in a non-interactive preview.
- **presentation** (ExpandedSurfacePresentation) - Required. The presentation this mount belongs to.

### Example
```swift
let context = ExpandedSurfaceContext(
    availableSize: CGSize(width: 320, height: 200),
    surface: .builtInNotch,
    displayID: 1,
    isHostShelfTransitioning: false,
    isPreview: false,
    presentation: someExpandedSurfacePresentation
)
```
```

--------------------------------

### static func isValid(_:)

Source: https://getdroppy.app/docs/droppykit/api/droplet-id

Whether `rawValue` is a usable droplet id. The rule: 3 to 40 characters, ASCII letters, digits and hyphens only, starting with a letter and ending with a letter or digit.

```APIDOC
## static func isValid(_:)

### Description
Whether `rawValue` is a usable droplet id. The rule: 3 to 40 characters, ASCII letters, digits and hyphens only, starting with a letter and ending with a letter or digit.

### Signature
`static func isValid(_ rawValue: String) -> Bool`

### Parameters
- **rawValue** (String) - The string to validate.

### Returns
`true` if the string is a valid droplet id, otherwise `false`.

### Validation Rules
- Length: 3 to 40 characters inclusive.
- Characters: ASCII letters, digits, and hyphens only.
- Must start with a letter and end with a letter or digit.
- Rejects `/`, `\`, `.`, spaces, leading/trailing hyphens, and empty string.
```

--------------------------------

### init(stringLiteral:)

Source: https://getdroppy.app/docs/droppykit/api/droplet-id

String-literal convenience initializer, so `static let id: DropletID = "worldclock"` reads naturally.

```APIDOC
## init(stringLiteral:)

### Description
String-literal convenience initializer, so `static let id: DropletID = "worldclock"` reads naturally.

### Signature
`init(stringLiteral value: String)`

### Parameters
- **value** (String) - The string literal value.
```

--------------------------------

### Settings pane UI components

Source: https://getdroppy.app/docs/droppykit/settings-panes

Build the settings pane UI using SDK components like DropletSettingsCard, DropletToggleRow, DropletSliderRow, and DropletControlRow. The example shows a VStack with a card containing a toggle, slider, and a control row with a value pill.

```swift
VStack(alignment: .leading, spacing: DroppySpacing.lg) {
    DropletSettingsCard {
        DropletToggleRow(
            title: "Show seconds",
            subtitle: "Ticks the shelf widget every second instead of every minute.",
            isOn: droplet.showsSecondsBinding
        )
        DropletSettingsDivider()
        DropletSliderRow(
            title: "Refresh",
            value: "\(Int(interval))s",
            binding: $interval,
            range: 1...60
        )
        DropletSettingsDivider()
        DropletControlRow(title: "Clocks") {
            DropletValuePill(text: "\(droplet.clockCount)")
        }
    }
}

```

--------------------------------

### init(closedWidth:closedHeight:cornerRadius:isHardwareNotch:displayID:)

Source: https://getdroppy.app/docs/droppykit/api/droplet-notch-geometry

Initializes a DropletNotchGeometry instance with the specified closed width, closed height, corner radius, hardware notch flag, and display ID.

```APIDOC
## init(closedWidth:closedHeight:cornerRadius:isHardwareNotch:displayID:)

### Description
Initializes a DropletNotchGeometry instance with the specified closed width, closed height, corner radius, hardware notch flag, and display ID.

### Method
Initializer

### Parameters
- **closedWidth** (CGFloat) - Required - Width of the closed notch, in points.
- **closedHeight** (CGFloat) - Required - Height of the closed notch, in points.
- **cornerRadius** (CGFloat) - Required - Corner radius the host rounds its surfaces to.
- **isHardwareNotch** (Bool) - Required - Whether this display has a real hardware notch. `false` means the host is drawing a simulated island near the top edge.
- **displayID** (UInt32) - Required - The display this geometry describes.

### Response
No return value.
```

--------------------------------

### ShelfWidgetContext Initializers

Source: https://getdroppy.app/docs/droppykit/api/shelf-widget-context

Initializers for creating a ShelfWidgetContext instance.

```APIDOC
## init(availableSize:isPaired:isShelfTransitioning:isPreview:surface:)

### Description
Creates a context. Constructed by hosts, read by droplets.

### Method
init

### Parameters
- **availableSize** (CGSize) - Required - The host-owned layout size for this widget mount.
- **isPaired** (Bool) - Optional - Defaults to `false`. True when the widget shares its row with one to three other widgets.
- **isShelfTransitioning** (Bool) - Optional - Defaults to `false`. True while the shelf itself is animating open or closed.
- **isPreview** (Bool) - Optional - Defaults to `false`. True when the view is mounted in a non-interactive preview.
- **surface** (DropletSurfaceKind) - Optional - Defaults to `.builtInNotch`. The surface kind hosting the widget.

### Example
```swift
ShelfWidgetContext(availableSize: CGSize(width: 100, height: 50), isPaired: true, isShelfTransitioning: false, isPreview: false, surface: .builtInNotch)
```

```

```APIDOC
## init(availableSize:isPaired:placement:isCompact:isShelfTransitioning:isPreview:surface:usesIslandCurvature:usesAdaptiveForegrounds:)

### Description
Creates a context with the complete host-owned presentation facts. The legacy initializer above remains intact for already compiled droplets and older source clients.

### Method
init

### Parameters
- **availableSize** (CGSize) - Required - The host-owned layout size for this widget mount.
- **isPaired** (Bool) - Required - True when the widget shares its row with one to three other widgets.
- **placement** (ShelfWidgetPlacement) - Required - The widget's exact row placement.
- **isCompact** (Bool) - Required - Whether the host requested the widget's compact composition.
- **isShelfTransitioning** (Bool) - Required - True while the shelf itself is animating open or closed.
- **isPreview** (Bool) - Required - True when the view is mounted in a non-interactive preview.
- **surface** (DropletSurfaceKind) - Required - The surface kind hosting the widget.
- **usesIslandCurvature** (Bool) - Required - Whether a solo card sits inside the dynamic-island curvature.
- **usesAdaptiveForegrounds** (Bool) - Required - Whether the shelf is drawn over a transparent notch material and the product should select adaptive foreground colors.

### Example
```swift
ShelfWidgetContext(availableSize: CGSize(width: 100, height: 50), isPaired: true, placement: .middle, isCompact: true, isShelfTransitioning: false, isPreview: false, surface: .builtInNotch, usesIslandCurvature: true, usesAdaptiveForegrounds: true)
```

```

--------------------------------

### ShelfWidgetDynamicLayoutProviding

Source: https://getdroppy.app/docs/droppykit/api/shelf-widget-dynamic-layout-providing

Documentation for the ShelfWidgetDynamicLayoutProviding protocol, including methods and properties that can be called directly.

```APIDOC
## GET /shelf-widget-dynamic-layout-providing

### Description
Provides dynamic layout traits for shelf widgets. This protocol allows a product to supply layout traits that override the static descriptor traits, and to signal when those traits change.

### Method
GET

### Endpoint
/shelf-widget-dynamic-layout-providing

### Parameters
#### Query Parameters
- **id** (ShelfWidgetID) - Required - The identifier of the widget whose layout traits are requested.

### Response
#### Success Response (200)
- **traits** (ShelfWidgetLayoutTraits?) - The current layout traits for the widget, or null to keep the descriptor's static traits.

#### Response Example
```json
{
  "traits": {
    "width": 200,
    "height": 100
  }
}
```

## GET /shelf-widget-layout-invalidation-publisher

### Description
Provides a publisher that emits when a product-owned layout input changes. The emitted value identifies the widget whose traits the host should re-read.

### Method
GET

### Endpoint
/shelf-widget-layout-invalidation-publisher

### Parameters
#### Query Parameters
- **id** (ShelfWidgetID) - Required - The identifier of the widget whose layout invalidation is being observed.

### Response
#### Success Response (200)
- **publisher** (AnyPublisher<ShelfWidgetID, Never>) - A publisher that emits the widget ID when layout inputs change.

#### Response Example
```json
{
  "publisher": "AnyPublisher<ShelfWidgetID, Never>"
}
```

```

--------------------------------

### Running the harness

Source: https://getdroppy.app/docs/droppykit/harness

Commands to run the harness and write a JSON report, optionally with screenshots.

```bash
droppykit run -- --shots ./shots --report ./shots/report.json
```

```bash
droppykit run -- --report ./report.json
```
Tokens:
Raw