Skip to main content

DrawerWidgetSessionMixin

Auto-generated from the @jbrowse/mobx-state-tree model in the source — see the developer guide for concepts. Built into JBrowse core. View source.

Adds the widget drawer to a session: the open widgets, which one is showing, and the drawer's side, width and minimized state.

Properties

MemberDescription
drawerPosition
drawerPosition: types.optional(
        types.enumeration<DrawerPosition>('DrawerPosition', [
          ...drawerPositions,
        ]),
        storedDrawerPosition,
      )
drawerWidth
drawerWidth: types.stripDefault(
        types.refinement(types.integer, width => width >= minDrawerWidth),
        384,
      )
widgets
widgets: types.stripDefault(types.map(widgetStateModelType), {})
activeWidgets
activeWidgets: types.stripDefault(
        types.map(types.safeReference(widgetStateModelType)),
        {},
      )
minimized
minimized: types.stripDefault(types.boolean, false)

Volatiles

MemberDescription
poppedOut
boolean		true while the visible widget is shown in a modal dialog instead of the drawer. Volatile because a restored session that opened straight into a modal, with no drawer behind it, is disorienting
modalWidgets
boolean		set by a host with no room for a drawer column beside its views (a phone), so every widget shows in a modal instead

Getters

MemberDescription
visibleWidget
Widget | undefined
drawerVisible
boolean		whether the drawer column is on screen: there is something to show, it is not minimized to the FAB, and it is not currently a modal instead.

A getter rather than each host's own &&, because the hosts drifted -- the app shell tested poppedOut and the embedded view did not, so the day a popout button reaches the embedded drawer header it would render the modal and the drawer at once.
modalWidgetVisible
boolean		whether the visible widget shows in a modal: popped out of the drawer, or on a host with no room for one

Actions

MemberDescription
setDrawerPosition
(arg: DrawerPosition) => void
updateDrawerWidth
(drawerWidth: number, availableWidth?: number) => number
resizeDrawer
(distance: number, availableWidth?: number) => number
addWidget
(typeName: string, id: string, initialState?: any, conf?: unknown) => any
showWidget
(widget: any) => void
hideWidget
(widget: any) => void		closes the widget, and removes it from the session when its type sets discardOnClose. Minimizing the drawer is not closing.
minimizeWidgetDrawer
() => void
showWidgetDrawer
() => void
popoutWidget
() => void		show the visible widget in a modal dialog, freeing the drawer column
returnWidgetToDrawer
() => void
setModalWidgets
(flag: boolean) => void
hideAllWidgets
() => void
closeModalWidget
() => void		the modal's close button: a popped-out widget goes back to the drawer, and with no drawer to go back to the widget closes
openWidget
(typeName: string, id: string, initialState?: any, conf?: unknown) => any
adds the widget, replacing one with the same id, and shows it
editConfiguration
(configuration: AnyConfigurationModel | { trackId: string; }, opts?: { expandedDisplayId?: string | undefined; } | undefined) => void
opens a configuration editor to configure the given thing, and sets the current task to be configuring it