App

An interface for interacting with the MindDrop application.

Hooks and methods for retrieving and managing topics.

Returns root topics as an array ordered according their order of appearance in the app sidebar.

useRootTopics(): Topic[]

Returns archived root topics as an array ordered according their order of appearance in the app sidebar.

useArchivedRootTopics(): Topic[]

Returns the drop configs for the drop types enabled on the given topic.

useTopicDropConfigs(topicId: string): DropConfig[]

Creates a new topic along with a default view for it. Returns the new topic.

App.createTopic(core: Core, data?: CreateTopicData): Topic

Adds topics to the root level and dispaches an app:root-topics:add event.

App.addRootTopics(core: Core, topicIds: string[], position?: number): void

Removes topics from the root level and dispaches an app:root-topics:remove event.

App.removeRootTopics(core: Core, topicIds: string[]): void

Sets a new sort order for root topics. The provided root topic IDs must contain the same IDs as the current value, only in a different order. Dispatches a app:root-topics:sort event.

• Throws a InvalidParameterError if the given topic IDs differ from the current root topic IDs in anything but order.

App.sortRootTopics(core: Core, topicIds: string[]): void

Removes subtopics from a parent topic and adds them to the root level. Dispatches an app:move-subtopics-root event.

App.moveSubtopicsToRoot(core: Core, parentTopicId: string, subtopicIds: string[]): void

Removes topics from the root level and adds them as subtopics to a specified topic. Dispatches a app:root-topics:move event.

App.moveRootTopicsToParentTopic(
  core: Core,
  parentTopicId: string,
  topicIds: string[],
  position?: number,
): void

Archives root level topics and dispaches an app:root-topics:archive event.

App.archiveRootTopics(core: Core, topicIds: string[]): void

Unarchives root level topics and dispaches an app:root-topics:unarchive event.

App.unarchiveRootTopics(core: Core, topicIds: string[]): void

Returns root topics as an array ordered according their order of appearance in the app sidebar.

App.getRootTopics(): Topic[]

Returns archived root topics as an array ordered according their order of appearance in the app sidebar.

App.getArchivedRootTopics(): Topic[]

Handles data inserts into a topic depending on the insert's action parameter:

• insert: creates drops from the raw data and adds them to the topic

• copy: data insert's drops are duplicated and duplicates added to the topic

• cut: data insert's drops are added to the topic (removal from source is handled at the time of the cut)

• move: data insert's drops are added to the topic and removed from the source topic

• add: data insert's drops are added to the topic

Any other action is ignored. Returns a boolean indicating whether or not the data insert was handled (false if action is not one of the ones listed above).

App.insertDataIntoTopic(core: Core, topicId: string, data: DataInsert, metada: AddDropsMetadata): Promise<boolean>

Returns the drop configs for the drop types enabled on the given topic.

App.getTopicDropConfigs(topicId: string): DropConfig[]

Renders a drop using the appropriate component.

Drops.render(drop: Drop, parent?: DropParentReference): ReactElement;

Adds global tags and dispaches an app:add-global-tags event.

App.addGlobalTags(core: Core, tagIds: string[]): void

Removes global tags and dispaches an app:remove-global-tags event.

App.removeGlobalTags(core: Core, tagIds: string[]): void

Returns an object containing the currently open view and view instance (set to null if no view instance is open).

useCurrentView(): { view: View, instance: ViewInstance | null }

Returns an object containing the currently open view and view instance (set to null if no view instance is open).

App.getCurrentView(): { view: View, instance: ViewInstance | null }

Opens a view in the app and dispatches a app:view:open event. If opening a view instance, use App.openViewInstance instead.

App.openView(core: Core, view: viewId): void

Opens a view instance in the app and dispatches a app:view:open event. If opening a static view, use App.openView instead.

App.openViewInstance(core: Core, view: viewInstanceId): void

Adds a UI extension at a given location.

App.addUiExtension(location: UiLocation, element: UiComponentConfig | ReactElement): void

Removes a UI extension from a given location. The location and element must be the same as the ones used when adding the extension.

App.removeUiExtension(location: UiLocation, element: UiComponentConfig | ReactElement): void

Removes all UI extensions added by the extension. Optionally, a location can be specified to remove UI extensions only from the specified location.

App.removeAllUiExtensions(core: Core, location?: UiLocation): void

Adds app specific event listeners. Equivalent to calling addEventListener directly on core, but provides more advanced type definitions.

App.addEventListener(core: Core, event: AppEvent, callback: EventListenerCallback): void

Removes app specific event listeners. Equivalent to calling removeEventListener directly on core, but provides more advanced type definitions.

App.removeEventListener(core: Core, event: AppEvent, callback: EventListenerCallback): void

App events are prefixed with the namespace app.

See below the table for more details on the data passed by app related events.

AppView