Packages
Install the core and add the packages your application uses. These packages ship independently as ESM. Their public APIs are still changing. Bundle size has no published measurement.
This table comes from the current workspace manifests. Every public declaration entry point appears in the generated reference. CSS exports are assets, and internal entry points stay outside the public reference.
| Package | Purpose | Declaration entry points |
|---|---|---|
| @singapore-editor/collab | Host-ordered collaborative text core. Editor and network integration are separate work. | 1 |
| @singapore-editor/collaboration | 5 | |
| @singapore-editor/core | Editor views, documents, extensions, rendering, syntax, keymaps and testing. | 14 |
| @singapore-editor/decode | Text reveal animation. | 1 |
| @singapore-editor/diff | Diff presentation and editor contributions. | 1 |
| @singapore-editor/find | Find and replace widget and commands. | 1 |
| @singapore-editor/gutters | Line numbers, fold arrows and gutter contributions. | 3 |
| @singapore-editor/highlighting | Shared highlighting support. | 1 |
| @singapore-editor/lsp | Language Server Protocol client and protocol types. | 3 |
| @singapore-editor/lsp-plugin | Editor diagnostics, completion, hover and other server-backed features. | 15 |
| @singapore-editor/markdown | Markdown preview and editing features. | 1 |
| @singapore-editor/minimap | Worker-drawn document overview. | 1 |
| @singapore-editor/paged | Read-only paged file viewing. | 1 |
| @singapore-editor/panes | Plain DOM split-pane layouts. | 1 |
| @singapore-editor/plugin-ui | Shared hovers and anchored UI for plugins. | 11 |
| @singapore-editor/react | React controller, host and state selectors. | 1 |
| @singapore-editor/scope-lines | Structure guides and sticky scope headers. | 1 |
| @singapore-editor/solid | Solid refs, accessors and reactive options. | 1 |
| @singapore-editor/spellcheck | Worker-backed spelling checks. | 1 |
| @singapore-editor/textbuffer | Persistent AVL piece table, versioned reads and anchors. | 3 |
| @singapore-editor/tree-sitter | Worker syntax parsing, highlighting, folds and structural selection. | 1 |
| @singapore-editor/tree-sitter-languages | Bundled grammar assets and language contributions. | 2 |
| @singapore-editor/typescript-lsp | TypeScript language service and virtual project files in a worker. | 3 |
Core entry points
Section titled “Core entry points”@singapore-editor/core/editor exposes the editor constructor and options. /document covers document sessions and snapshots. /extensions covers plugin contributions. /rendering, /syntax and /keymap expose those integration contracts. /shiki supplies Shiki highlighting and theme conversion. /testing provides testing helpers. The reference also documents other exported public declaration entry points.
Stylesheets
Section titled “Stylesheets”Import @singapore-editor/core/style.css for the editor. Packages with visual UI, including gutters, find, minimap, diff, Markdown, scope lines and panes, expose their own stylesheets. Check the package manifest and guide for the entry point to import.
Status
Section titled “Status”The editable core, worker syntax, language-server integrations, framework adapters and read-only paged viewer exist today. The collab package contains a host-ordered text core; full collaborative editor and network integration remain separate planned work. Vim mode, multibuffers and editable paging remain plans.
Follow the roadmap for planned work and send contributions to Fregat.