API reference

Generated from the source. Every export, grouped by kind.

Functions

• emptySearchForm
• fileSystemProviderCapabilityName - Gets a human readable name of the given capability
• hasKeycode - Checks if an event has any of the provided
• hasModifierKey - Checks whether a modifier key is pressed.
• stringFromByArray
• stringToByteArray

Classes

• BadgeComponent - Projects arbitrary content and overlays a small count bubble at its
• BinarySize
• CheckboxComponent - A compact, VS-Code-like checkbox built on a native <input type="checkbox">.
• CodeEditor - Represents an editor that is attached to a component.
• CodeEditorComponent
• CodeEditorModule
• CommandEvent
• CommandGroupComponent
• CommandModule
• CommandService
• ContextMenuService - Opens a menu at the pointer position, on top of @angular/cdk.
• Contribution
• Contribution
• Contribution
• Contribution
• CoreModule
• DiagnosticService
• DialogModule
• DialogService
• DividerComponent - A thin rule that separates content, laid out horizontally (default) or
• DndDirective - Element that can share or accept a data of dragged dom element.
• Editor - Represents an editor that is attached to a component.
• EditorContribution
• EditorDirective
• EditorDirectivesModule
• EditorGroup - Represents an editor group.
• EditorModule
• EditorPipesModule
• EditorService
• ErrorNotification
• ExplorerCommandCollapseAll
• ExplorerCommandCopy - Commands available inside the explorer container.
• ExplorerCommandCopyPath - Commands available inside the explorer container.
• ExplorerCommandCreateFile - Commands available inside the explorer container.
• ExplorerCommandCreateFolder - Commands available inside the explorer container.
• ExplorerCommandDelete - Commands available inside the explorer container.
• ExplorerCommandFileExport - Commands available inside the explorer container.
• ExplorerCommandFileUpload - Commands available inside the explorer container.
• ExplorerCommandPaste - Commands available inside the explorer container.
• ExplorerCommandRefresh - Command that refresh the explorer file tree.
• ExplorerCommandRename - Commands available inside the explorer container.
• ExplorerCommandToggleFiltering
• ExplorerComponent
• ExplorerContribution
• ExplorerModule
• ExplorerService - Provides an API to interact with the explorer view tree.
• FileChangedPipe
• FileNamePipe
• FileService
• FileSystemError - A type that filesystem providers should use to signal errors.
• FileSystemProvider - The filesystem provider defines what the editor needs to read, write, discover,
• HighlightDirective
• HtmlPreviewHandler
• IdeAutocompleteComponent - Floating list of <ide-auto-option> items shown under an input by the
• IdeAutocompleteDirective - Trigger that binds a native <input> (or <textarea>) to an
• IdeAutoOptionComponent - A single selectable row inside an <ide-autocomplete> panel.
• IdeButtonDirective - Styling primitive that replaces ng-zorro's nz-button.
• IdeComponent
• IdeInputDirective - Styling primitive that replaces ng-zorro's nz-input.
• IdeMenuComponent - Menu panel that lays out a list of IdeMenuItemDirective entries.
• IdeMenuItemDirective - A single entry inside an IdeMenuComponent.
• IdeMenuTriggerDirective - Turns its host element into a click trigger that opens an
• IdeModalContainerComponent - Presentational container rendered inside the CDK dialog overlay. It lays out
• IdeModalRef - Handle to a modal opened through IdeModalService. Wraps the CDK DialogRef
• IdeModalService - Injectable, VS-Code-like modal service built on @angular/cdk/dialog. It is a
• IdeService
• InfobarComponent
• InfobarContainer - Representation of view container inside the infobar area.
• InfobarModule
• InfoNotification
• Keybinding
• KeyBindService
• MarkdownPreviewHandler
• MediaEditor - Represents an editor that is attached to a component.
• MediaEditorComponent
• MediaEditorModule
• MemFileProvider - The filesystem provider defines what the editor needs to read, write, discover,
• MonacoService
• NgeIdeExplorerModule
• NgeIdeModule
• NgeIdeNotificationsModule
• NgeIdeProblemsModule
• NgeIdeSearchModule
• NgeIdeSettingsModule
• NicifyNamePipe
• NotificationsComponent
• NotificationService
• NotificationsModule
• OpenRequest - Represents file open request.
• OptionComponent - A single choice inside an SelectComponent (ide-select).
• Paths
• PreviewEditor - Represents an editor that is attached to a component.
• PreviewEditorComponent
• PreviewEditorModule
• PreviewService
• ProblemsComponent
• ProblemsModule
• QuickOpenComponent
• QuickOpenModule
• SearchComponent
• SearchInputComponent
• SearchModule
• SelectComponent - A compact, VS-Code-like single-select dropdown.
• SettingsEditorComponent
• SettingsEditorModule
• SettingsService
• SidebarComponent - Renders on the sidebar area of the ide.
• SidebarContainer - Representation of view container inside the sidebar area.
• SidebarModule
• SkeletonComponent - Lightweight loading placeholder rendering a few content lines with an
• SpinnerComponent - Indeterminate loading spinner. Standalone, pure-CSS replacement for
• StatusbarComponent
• StatusbarModule
• StatusBarService
• StorageService
• SvgPreviewHandler
• TabButtonDirective - Internal directive applied to every tab header rendered by
• TabComponent - A single tab hosted by TabsComponent. Standalone replacement for
• TabsComponent - Card-style (or line-style) tab bar. Standalone replacement for ng-zorro's
• TaskbarComponent
• TaskbarModule
• TaskService
• ThemeService - Owns the IDE's color theme.
• ThemeSidebarContainer - Activity-bar (bottom) entry offering Light / Dark / System. The title is a
• ToggleThemeCommand - Command-palette entry that cycles the color theme (light -> dark -> system).
• ToolbarButton
• ToolbarComponent
• ToolbarModule
• ToolbarSeparator
• ToolbarService
• TooltipComponent - The floating bubble rendered by TooltipDirective.
• TooltipDirective - Attribute directive that shows a compact, VS-Code-like tooltip on hover and on
• ViewContainerService
• ViewDirective
• ViewGroupComponent
• ViewModule
• ViewService
• WarningNotification
• WorkbenchComponent
• WorkbenchModule

Interfaces

• ConfirmOptions
• Diagnostic - Represents a diagnostic, such as a compiler error or warning.
• DiagnosticGroup
• DndData - Representation of a data shared with a drag and drop action.
• EditorState - Represents the state of the editor.
• EditorTab
• FileNestingPattern
• ICommand
• IContribution
• IdeAutoOptionSelectionEvent - Payload emitted when an option is chosen.
• IdeContextMenuConfig - Options accepted by ContextMenuService.open.
• IdeModalButton - Declarative footer button of a modal, mirroring the plain objects the IDE
• IdeModalContainerData - Normalized data handed to IdeModalContainerComponent through DIALOG_DATA.
• IdeModalOptions - Options accepted by IdeModalService.create/open. Each field is the plain
• IExplorerCommand - Commands available inside the explorer container.
• IFile - Representation of a file/directory.
• IFileChange - Identifies a single change in a file.
• IFileSystemProvider - The filesystem provider defines what the editor needs to read, write, discover,
• IStatusBarItem
• ITask
• IToolbarButton
• IToolbarCustomGroup
• IToolbarItem
• IView - Representation of a part of the editor (statusbar, sidebar...).
• IViewContainer - Representation of view container inside the infobar area.
• Notification
• OpenOptions - Represents file open options.
• Preview
• PreviewHandler
• SearchForm
• SearchMatch
• SearchResult

Type aliases

• IdeButtonSize - Height/padding scale of an [ideButton] (replaces ng-zorro's nzSize).
• IdeButtonType - Visual style of an [ideButton] (replaces ng-zorro's nzType).
• IdeContextMenuContent - A menu source: a bare TemplateRef, or an object that carries one.
• IdeModalButtonType - Visual style of an IdeModalButton (replaces ng-zorro's button nzType).
• IdeSpinnerSize - Diameter preset for SpinnerComponent.
• IdeTabsType - Visual style of the tab bar (renamed from ng-zorro's nzType).
• NotificationLevel
• ResolvedTheme
• ThemeMode

Variables

• CONTRIBUTION
• DEFAULT_STORAGE_PREFIX - Namespace applied to every stored key when STORAGE_PREFIX is not provided.
• DndDataTransfer - Data passed to dataTransfer.setData method when a data is dragged using DndDirective.
• EXPLORER_COMMAND_COLLAPSE
• EXPLORER_COMMAND_COPY
• EXPLORER_COMMAND_COPY_PATH
• EXPLORER_COMMAND_CREATE_FILE
• EXPLORER_COMMAND_CREATE_FOLDER
• EXPLORER_COMMAND_DELETE
• EXPLORER_COMMAND_FILE_EXPORT
• EXPLORER_COMMAND_FILE_UPLOAD
• EXPLORER_COMMAND_PASTE
• EXPLORER_COMMAND_REFRESH
• EXPLORER_COMMAND_RENAME
• EXPLORER_COMMAND_TOGGLE_FILTERING
• EXPLORER_CONTAINER_ID - Identifier of the explorer container.
• EXPLORER_VIEW_ID - Identifier of the explorer view component.
• IDE_MENU_DIRECTIVES - Every menu directive/component, for a single-line imports entry.
• IDE_THEME_CSS - IDE theme tokens (GitHub Light + GitHub Dark), bundled as a string and
• KeyCodes
• KeyModifiers
• NOTIFICATION_EVENT_CHANNEL
• NOTIFICATIONS_CONTAINER_ID - Identifier of the notifications container.
• NOTIFICATIONS_VIEW_ID - Identifier of the notifications view component.
• PROBLEMS_CONTAINER_ID - Identifier of the problems container.
• PROBLEMS_VIEW_ID - Identifier of the problems view component.
• SEARCH_CONTAINER_ID - Identifier of the search container.
• SEARCH_VIEW_ID - Identifier of the search view component.
• SETTINGS_CONTAINER_ID - Identifier of the settings container.
• SETTINGS_URI
• STORAGE_PREFIX
• THEME_CONTAINER_ID
• TOGGLE_THEME_COMMAND