canHandwrite - Supernote

Queries whether the currently open note or document view can accept EMR handwriting right now. Calling this API does not turn handwriting on or off. It only checks whether a pen stroke on the page will be received by the host. Call it before a flow that needs the user to write on the page. If result === false, tell the user handwriting is not available in the current view instead of waiting for strokes. Currently, only note content pages and document content pages support handwriting. Other views do not.

static canHandwrite(): Promise<APIResponse<boolean>>;

Returns

APIResponse<boolean>:
- result === true: the current view can accept handwriting
- result === false: the current view cannot accept handwriting

Notes

This checks the current host view, not whether the device has a stylus
The result can change with UI state, so do not cache it for long. Query again after showing or closing the plugin view, or after changing pages

Example

import { PluginCommAPI } from 'sn-plugin-lib';

/**
 * Confirm the current view can accept handwriting before starting a writing flow.
 */
export async function exampleCanHandwrite() {
  const res = await PluginCommAPI.canHandwrite();
  if (!res.success) {
    console.log('canHandwrite failed', res.error);
    throw new Error(res.error?.message ?? 'canHandwrite call failed');
  }
  if (!res.result) {
    console.log('current view cannot handwrite');
    return false;
  }
  return true;
}

​Example

Example