Skip to content

Commit

Permalink
docs: Small note to custom scripts page (#6992)
Browse files Browse the repository at this point in the history
Co-authored-by: caitlinwheeless <[email protected]>
  • Loading branch information
caitlinwheeless and caitlinwheeless authored Jan 31, 2025
1 parent 17499d4 commit fe6d0c4
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/source/guide/scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,9 @@ Subscription to listen to events related to the Label Studio Frontend. Handlers

For a list of all available events, see our [Frontend reference](frontend_reference#Available-events).

!!! note
Top-level events such as `labelStudioLoad` and `storageInitialized` cannot be used with custom scripts, as they execute before the script is initialized.

| Parameter &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; | Type | Description |
|--------------------------|--------------------|--------------------------|
| `eventName` | string | A case-sensitive string representing the event type to listen for. |
Expand Down

0 comments on commit fe6d0c4

Please sign in to comment.