Browse API 1 documentation
GroveAPI 1preview

grove.composer.close()

Dismiss a composer utility without contributing a result.

Mango 3.1+View Markdown

Dismiss a composer utility without contributing a result.

Signature

ts
grove.composer.close(): void

Availability

Exclusive composer surface with application scope. No additional capability required.

Parameters

None.

Return value

Returns undefined.

Behavior and errors

Closes the current utility without changing the draft. Other surfaces are refused. Perform any needed persistence before closing; do not schedule work expecting the document to stay alive.

Example

js
document.querySelector('#cancel').addEventListener('click', () => {
  grove.composer.close()
})