A code editor is a versatile text editor that allows for editing various languages. The code editor is built on top of the Monaco Editor.
By default, the bulk of the code editor is the text editor itself. The component is extremely flexible, so many of the features are optional. Much of the functionality of the Monaco Editor has been carried over to the code editor, so it’s possible to further customize the component based on their options.
Light theme editor
- Text editor: The text of the editor sits in this container. Syntax highlighting is automatically built into the editor, but can be customized if necessary.
- Language indicator (optional): This tab indicates the language that the code is written in.
- Minimap (optional): This displays an overview of the contents of the editor. It can be used to scroll through the editor, rather than using the standard scrollbar that appears on the right of the editor.
- Line numbers (optional): These will populate to accompany the lines of text that appear in the editor.
- Indentation indicators: These vertical lines help make indentation clearer. They appear per indentation level.
Dark theme editor
We recommend using the light theme editor by default, but there is also a dark theme code editor available. All editor functionality remains the same whether a light or dark theme is used.
Syntax highlighting will update automatically to adapt to the dark background. The editor still remains within the code editor container so only the inner area adapts the dark theme.
Use a code editor when you:
- Want the user to create or edit large blocks of code.
- Want to display large blocks of code (see Displaying code in a code editor for guidance on when to use a code editor over a code block).
Creating or editing with a code editor
Code editors can optionally include actions that are attached to the editor itself. Use a code editor with actions when you want the user to be able to perform some sort of action using the code.
Actions are represented by an icon and should include a tooltip on hover explaining what action they perform. Some typical actions that are used are Copy to clipboard, Download, and Upload.
You can use an empty state in a code editor to indicate that a user can drag a file or browse to upload.
- Empty state: We recommend always using the code icon for code editor empty states. The text can be changed to fit the use case.
- Browse: Selecting Browse will bring up the file browser, which may look different depending on the operating system.
- Start from scratch: Selecting this will turn the code editor into editing mode and allow the user to start typing their code or allow them to paste it in.
Displaying code in a code editor
Use the read-only state of the code editor when you only want to display large blocks of code. In this case, the user will not be able to edit the code. If you are dealing with minimal lines of code that are read-only, and don’t require the use of line numbers and advanced formatting, use code blocks instead.
The border of the code editor will turn gray to indicate that it is read-only. The user can still highlight text in the editor, but won’t be able to edit. Adding actions is optional and should be determined by use case.
View source on GitHub