@journeyapps/reactor-mod-editor

Enumerations

Enumeration	Description
EditorEntities	-
MonacoLanguages	-
MonacoLanguageScopes	-

Classes

Class	Description
EditorModule	-
EditorThemeControl	-
EditorThemeEntityDefinition	-
MonacoShortcut	-
MonacoShortcutHandler	-
MonacoStore	-
MonacoSystemThemeStore	-
MonacoThemeStore	-

Interfaces

BranchFile

Properties

Property	Type
appID	string
branch	string
path	string

---

DualEditorWidgetProps

Extends

• MonacoDiffEditorProps

Properties

Property	Type
getLeftHeaderContent	() => Element
getRightHeaderContent	() => Element

---

EditorTheme

Properties

Property	Type
compatibility	boolean
key	string
label	string
system	boolean
theme	IStandaloneThemeData

---

EditorWidgetProps

Properties

Property	Type
events?	OxideEditorEvents
forwardRef?	RefObject<HTMLDivElement>
model	ITextModel
options?	Partial<monaco.editor.IEditorConstructionOptions>
patchOxideShortcuts?	boolean

---

GrammerMappingEntry

Properties

Property	Type
format	"json" | "plist"
hook?	() => any
language?	Partial<monaco.languages.ILanguageExtensionPoint>
monaco?	MonacoLanguages
url	string

---

GrammerMappingType

Indexable

[key: string]: GrammerMappingEntry

---

MonacoEditorType

Extends

• IStandaloneCodeEditor

Properties

Property	Type
_actions	Map<string, { id: string; label: string; }>
_commandService	{ executeCommand: Promise<any>; }
_commandService.executeCommand	Promise<any>
_standaloneKeybindingService	{ updateResolver: any; }
_standaloneKeybindingService.updateResolver	any

---

MonacoJsonPathLocation

Properties

Property	Type
column	number
line	number
offsetEnd	number
offsetStart	number

---

MonacoJsonPathLocationFromDocumentOptions

Extends

• MonacoJsonPathLocationOptions

Properties

Property	Type	Inherited from
document	JSONDocument	-
model	ITextModel	-
path	MonacoJsonPathInput	-
target?	MonacoJsonPathLocationTarget	MonacoJsonPathLocationOptions.target

---

MonacoJsonPathLocationOptions

Extended by

• MonacoJsonPathLocationFromDocumentOptions
• MonacoJsonPathLocationRequest

Properties

Property	Type
target?	MonacoJsonPathLocationTarget

---

MonacoJsonPathLocationRequest

Extends

• MonacoJsonPathLocationOptions

Properties

Property	Type	Inherited from
model	ITextModel	-
path	MonacoJsonPathInput	-
target?	MonacoJsonPathLocationTarget	MonacoJsonPathLocationOptions.target

---

MonacoJsonPathResult

Properties

Property	Type
node	ASTNode
propertyNode?	PropertyASTNode

---

MonacoShortcutHandlerOptions

Properties

Property	Type
keybindingStore	MonacoKeybindingStore

---

MonacoStoreListener

Extends

• AbstractStoreListener

Properties

Property	Type	Inherited from
gotEditor	(editor) => any	-
initialized	() => any	AbstractStoreListener.initialized

---

MonacoSuggestIconOverrideResult

Properties

Property	Type
iconClass	string
iconColor?	string

---

MonacoSuggestRendererPatchEvent

Properties

Property	Type
data	any
element	any
index	number

---

OxideEditorEvents

Properties

Property	Type
getEditor?	(editor) => any
gotFocus?	(editor) => any

---

ReactorSuggestCompletionItem

Properties

Property	Type
reactorIcon?	ReactorIcon
reactorIconColor?	string

---

SimpleEditorWidgetProps

Properties

Property	Type
className?	any
lang	string
path	string
text	string

---

UseEditorStickyHeaderOptions

Properties

Property	Type
editor	IStandaloneCodeEditor

Type Aliases

ColorContribution

type ColorContribution = {
  defaults: {
     dark: string;
     hc: string;
     light: string;
  };
  deprecationMessage: string;
  description: string;
  id: string;
  needsTransparency: boolean;
};

Properties

Property	Type
defaults	{ dark: string; hc: string; light: string; }
defaults.dark	string
defaults.hc	string
defaults.light	string
deprecationMessage	string
description	string
id	string
needsTransparency	boolean

---

ColorRegistry

type ColorRegistry = {
  colorsById: {
   [id: string]: ColorContribution;
  };
  colorSchema: {
     properties: {
      [id: string]: ColorSchema;
     };
  };
};

Properties

Property	Type
colorsById	{ [id: string]: ColorContribution; }
colorSchema	{ properties: { [id: string]: ColorSchema; }; }
colorSchema.properties	{ [id: string]: ColorSchema; }

---

ColorSchema

type ColorSchema = {
  description: string;
};

Properties

Property	Type
description	string

---

MonacoJsonPathInput

type MonacoJsonPathInput = string | MonacoJsonPathSegment[];

---

MonacoJsonPathLocationTarget

type MonacoJsonPathLocationTarget = "node" | "key" | "value" | "property";

---

MonacoJsonPathSegment

type MonacoJsonPathSegment = string | number;

---

MonacoSuggestIconOverrideTransform

type MonacoSuggestIconOverrideTransform<T> = (completion) => 
  | MonacoSuggestIconOverrideResult
  | null
  | undefined;

Type Parameters

Type Parameter	Default type
T extends ReactorSuggestCompletionItem	ReactorSuggestCompletionItem

Parameters

Parameter	Type
completion	T

Returns

| MonacoSuggestIconOverrideResult | null | undefined

---

MonacoSuggestRendererPatch

type MonacoSuggestRendererPatch = (event) => void;

Parameters

Parameter	Type
event	MonacoSuggestRendererPatchEvent

Returns

void

---

MonacoSystemTheme

type MonacoSystemTheme = {
  coupledIDEThemeKey: string;
  editorTheme: EditorTheme;
};

Properties

Property	Type
coupledIDEThemeKey	string
editorTheme	EditorTheme

---

TokenColor

type TokenColor = {
  name: string;
  scope: string;
  settings: {
     background: string;
     fontStyle: string;
     foreground: string;
  };
};

Properties

Property	Type
name	string
scope	string
settings	{ background: string; fontStyle: string; foreground: string; }
settings.background	string
settings.fontStyle	string
settings.foreground	string

---

VSIXPackage

type VSIXPackage = {
  contributes: {
     themes: {
        label: string;
        path: string;
        uiTheme: string;
     }[];
  };
};

Properties

Property	Type
contributes	{ themes: { label: string; path: string; uiTheme: string; }[]; }
contributes.themes	{ label: string; path: string; uiTheme: string; }[]

---

VSIXTheme

type VSIXTheme = {
  base?: monaco.editor.BuiltinTheme;
  colors: {
   [key: string]: string;
  };
  inherit?: boolean;
  name: string;
  tokenColors: TokenColor[];
};

Properties

Property	Type
base?	monaco.editor.BuiltinTheme
colors	{ [key: string]: string; }
inherit?	boolean
name	string
tokenColors	TokenColor[]

Variables

colorRegistry

const colorRegistry: ColorRegistry;

---

COUPLED_IDE_THEMES

const COUPLED_IDE_THEMES: {
  bunny: IStandaloneThemeData;
  hexagon: IStandaloneThemeData;
  journey: IStandaloneThemeData;
  oxide: IStandaloneThemeData;
  reactor: IStandaloneThemeData;
  reactor-dark: IStandaloneThemeData;
  reactor-light: IStandaloneThemeData;
  scarlet: IStandaloneThemeData;
};

Type Declaration

Name	Type
bunny	IStandaloneThemeData
hexagon	IStandaloneThemeData
journey	IStandaloneThemeData
oxide	IStandaloneThemeData
reactor	IStandaloneThemeData
reactor-dark	IStandaloneThemeData
reactor-light	IStandaloneThemeData
scarlet	IStandaloneThemeData

---

DARK_THEME

const DARK_THEME: "journey-dark" = 'journey-dark';

---

DualEditorWidget

const DualEditorWidget: React.FC<DualEditorWidgetProps>;

---

EditorWidget

const EditorWidget: React.FC<EditorWidgetProps>;

---

GrammerMapping

const GrammerMapping: GrammerMappingType;

---

LOGS_LANGUAGE

const LOGS_LANGUAGE: IMonarchLanguage;

---

MonacoInternals

const MonacoInternals: {
  ICodeEditorService: any;
  StandaloneServices: any;
};

Type Declaration

Name	Type
ICodeEditorService	any
StandaloneServices	any

---

Scarlet

const Scarlet: ThemeColors<{
  editor: {
     colors: {
        backgroundSticky: string;
     };
     label: string;
  };
}>;

---

SimpleEditorWidget

const SimpleEditorWidget: React.FC<SimpleEditorWidgetProps>;

---

styled

const styled: CreateStyled<ThemeColors<{
  editor: {
     colors: {
        backgroundSticky: string;
     };
     label: string;
  };
}> & {
  light: boolean;
}>;

---

theme

const theme: ThemeFragment<{
  editor: {
     colors: {
        backgroundSticky: string;
     };
     label: string;
  };
}>;

---

themed

const themed: CreateStyled<ThemeColors<{
  editor: {
     colors: {
        backgroundSticky: string;
     };
     label: string;
  };
}> & {
  light: boolean;
}>;

Functions

Function	Description
clearMonacoJsonPathCache	-
findMonacoJsonPathNode	-
getLanguageFromFile	Given a path or filename return a language based on the file extension. Optionally accepts a file_length parameter (1 char = 2 bytes) which, if too large, will result in 'text' being returned regardless of language
getMonacoJsonPathLocation	-
getMonacoJsonPathLocationFromDocument	-
normalizeVSCodeTheme	-
parseMonacoJsonPath	-
pathToUri	Given a local filename, return a monaco Uri.
registerMonacoSuggestIconOverride	-
registerMonacoSuggestRendererPatch	-
uriToPath	Take a Monaco model URI, and covert it to a path in the local repo. If the URI does not reference a valid local path, null is returned. No checks are performed on whether or not the referenced file exists.
useEditorStickyHeader	-

References

default

Renames and re-exports EditorModule