05610bb0f3
* Reload FileTree and File when changed externally * Added tests * Show project root in files pane * Cut off titles that are too long * Fix tests
114 lines
3.0 KiB
TypeScript
114 lines
3.0 KiB
TypeScript
import { IconDefinition, faBugSlash } from '@fortawesome/free-solid-svg-icons'
|
|
import { KclEditorMenu } from 'components/ModelingSidebar/ModelingPanes/KclEditorMenu'
|
|
import { CustomIconName } from 'components/CustomIcon'
|
|
import { KclEditorPane } from 'components/ModelingSidebar/ModelingPanes/KclEditorPane'
|
|
import { MouseEventHandler, ReactNode } from 'react'
|
|
import { MemoryPane, MemoryPaneMenu } from './MemoryPane'
|
|
import { LogsPane } from './LoggingPanes'
|
|
import { DebugPane } from './DebugPane'
|
|
import { FileTreeInner, FileTreeMenu, FileTreeRoot } from 'components/FileTree'
|
|
import { useKclContext } from 'lang/KclProvider'
|
|
import { editorManager } from 'lib/singletons'
|
|
import { ContextFrom } from 'xstate'
|
|
import { settingsMachine } from 'machines/settingsMachine'
|
|
|
|
export type SidebarType =
|
|
| 'code'
|
|
| 'debug'
|
|
| 'export'
|
|
| 'files'
|
|
| 'logs'
|
|
| 'lspMessages'
|
|
| 'variables'
|
|
|
|
export interface BadgeInfo {
|
|
value: (props: PaneCallbackProps) => boolean | number
|
|
onClick?: MouseEventHandler<any>
|
|
}
|
|
|
|
/**
|
|
* This interface can be extended as more context is needed for the panes
|
|
* to determine if they should show their badges or not.
|
|
*/
|
|
interface PaneCallbackProps {
|
|
kclContext: ReturnType<typeof useKclContext>
|
|
settings: ContextFrom<typeof settingsMachine>
|
|
platform: 'web' | 'desktop'
|
|
}
|
|
|
|
export type SidebarPane = {
|
|
id: SidebarType
|
|
title: ReactNode
|
|
sidebarName?: string
|
|
icon: CustomIconName | IconDefinition
|
|
keybinding: string
|
|
Content: ReactNode | React.FC
|
|
Menu?: ReactNode | React.FC
|
|
hide?: boolean | ((props: PaneCallbackProps) => boolean)
|
|
showBadge?: BadgeInfo
|
|
}
|
|
|
|
export type SidebarAction = {
|
|
id: string
|
|
title: ReactNode
|
|
icon: CustomIconName
|
|
iconClassName?: string // Just until we get rid of FontAwesome icons
|
|
keybinding: string
|
|
action: () => void
|
|
hide?: boolean | ((props: PaneCallbackProps) => boolean)
|
|
disable?: () => string | undefined
|
|
}
|
|
|
|
export const sidebarPanes: SidebarPane[] = [
|
|
{
|
|
id: 'code',
|
|
title: 'KCL Code',
|
|
icon: 'code',
|
|
Content: KclEditorPane,
|
|
keybinding: 'Shift + C',
|
|
Menu: KclEditorMenu,
|
|
showBadge: {
|
|
value: ({ kclContext }) => {
|
|
return kclContext.errors.length
|
|
},
|
|
onClick: (e) => {
|
|
e.preventDefault()
|
|
editorManager.scrollToFirstErrorDiagnosticIfExists()
|
|
},
|
|
},
|
|
},
|
|
{
|
|
id: 'files',
|
|
title: <FileTreeRoot />,
|
|
sidebarName: 'Project Files',
|
|
icon: 'folder',
|
|
Content: FileTreeInner,
|
|
keybinding: 'Shift + F',
|
|
Menu: FileTreeMenu,
|
|
hide: ({ platform }) => platform === 'web',
|
|
},
|
|
{
|
|
id: 'variables',
|
|
title: 'Variables',
|
|
icon: 'make-variable',
|
|
Content: MemoryPane,
|
|
Menu: MemoryPaneMenu,
|
|
keybinding: 'Shift + V',
|
|
},
|
|
{
|
|
id: 'logs',
|
|
title: 'Logs',
|
|
icon: 'logs',
|
|
Content: LogsPane,
|
|
keybinding: 'Shift + L',
|
|
},
|
|
{
|
|
id: 'debug',
|
|
title: 'Debug',
|
|
icon: faBugSlash,
|
|
Content: DebugPane,
|
|
keybinding: 'Shift + D',
|
|
hide: ({ settings }) => !settings.modeling.showDebugPanel.current,
|
|
},
|
|
]
|