Skip to main content

ScheduleMenuProps

Agent Runtimes

Agent Runtimes / components/scheduler/ScheduleMenu / ScheduleMenuProps

Type Alias: ScheduleMenuProps

ScheduleMenuProps = object

Defined in: src/components/scheduler/ScheduleMenu.tsx:40

Props for the self-contained ScheduleMenu component.

The component performs the scheduler service calls internally. Provide the notebookUid, an authentication token, and the scheduler service baseUrl (configurable via props) to enable scheduling.

Properties​

ariaLabel?​

optional ariaLabel?: string

Defined in: src/components/scheduler/ScheduleMenu.tsx:59

Accessible label for the anchor button.

baseUrl?​

optional baseUrl?: string

Defined in: src/components/scheduler/ScheduleMenu.tsx:51

Base URL of the scheduler service. Defaults to the production service.

enabled?​

optional enabled?: boolean

Defined in: src/components/scheduler/ScheduleMenu.tsx:53

Force-disable the menu. When omitted, the menu is enabled if a token and notebook uid are present.

icon?​

optional icon?: Icon

Defined in: src/components/scheduler/ScheduleMenu.tsx:55

Icon shown on the anchor button (replaced by a spinner while saving).

iconColor?​

optional iconColor?: string

Defined in: src/components/scheduler/ScheduleMenu.tsx:57

Optional color for the anchor icon.

initialCronExpression?​

optional initialCronExpression?: string

Defined in: src/components/scheduler/ScheduleMenu.tsx:63

Initial cron expression.

initialPreset?​

optional initialPreset?: SchedulePreset

Defined in: src/components/scheduler/ScheduleMenu.tsx:61

Initial preset selection.

notebookUid?​

optional notebookUid?: string

Defined in: src/components/scheduler/ScheduleMenu.tsx:42

Target notebook uid to schedule (used to create/update a schedule).

onDeleted?​

optional onDeleted?: (schedule) => void

Defined in: src/components/scheduler/ScheduleMenu.tsx:67

Called after a schedule is successfully deleted/disabled.

Parameters​

schedule​

ScheduleDoc

Returns​

void

onError?​

optional onError?: (error) => void

Defined in: src/components/scheduler/ScheduleMenu.tsx:69

Called when saving a schedule fails.

Parameters​

error​

unknown

Returns​

void

onSaved?​

optional onSaved?: (schedule) => void

Defined in: src/components/scheduler/ScheduleMenu.tsx:65

Called after a schedule is successfully saved.

Parameters​

schedule​

ScheduleDoc

Returns​

void

scheduleUid?​

optional scheduleUid?: string

Defined in: src/components/scheduler/ScheduleMenu.tsx:47

Existing schedule uid to update in place. When provided, changes are persisted with a PUT update instead of a notebook upsert.

token?​

optional token?: string

Defined in: src/components/scheduler/ScheduleMenu.tsx:49

Authentication token used for scheduler API calls.