Skip to main content

Interface: Activity

Defined in: components/activity/Activity.tsx:69

Independent screen or a page rendered on top of the app

Properties​

cluster?​

optional cluster?: string;

Defined in: components/activity/Activity.tsx:90

Cluster of the launched activity


content​

content: ReactNode;

Defined in: components/activity/Activity.tsx:73

Content to display inside the activity


hideTitleInHeader?​

optional hideTitleInHeader?: boolean;

Defined in: components/activity/Activity.tsx:79

Hides title from the window header


icon?​

optional icon?: ReactNode;

Defined in: components/activity/Activity.tsx:81

Activity icon, optional but highly recommended


id​

id: string;

Defined in: components/activity/Activity.tsx:71

Unique ID


kind?​

optional kind?: "details";

Defined in: components/activity/Activity.tsx:97

Optional tag identifying the kind of activity. 'details' marks a resource-details drawer so that navigation-driven minimize and the skip of click-outside close only apply to that flow, not to unrelated temporary or split-right activities launched by plugins.


location​

location: ActivityLocation;

Defined in: components/activity/Activity.tsx:75

Current activity location


minimized?​

optional minimized?: boolean;

Defined in: components/activity/Activity.tsx:83

Whether this activity is minimized to the taskbar


onCloseRequest?​

optional onCloseRequest?: () => void;

Defined in: components/activity/Activity.tsx:108

Optional close interceptor. When set, user-initiated close actions (the title-bar X, the taskbar close buttons, Close All and clicking outside a temporary activity) call this instead of closing the activity directly, so the content can e.g. ask for confirmation about unsaved changes. The handler is then responsible for eventually calling Activity.close(id) itself. Programmatic Activity.close() calls are unaffected, and temporary activities are still replaced without calling this when another activity launches.

Returns​

void


temporary?​

optional temporary?: boolean;

Defined in: components/activity/Activity.tsx:88

Temporary activity will be closed if another activity is opened It will turn into permanent one if user interacts with it


title?​

optional title?: ReactNode;

Defined in: components/activity/Activity.tsx:77

Title to render in the taskbar and in window