Typix LogoTypix
Extensions

Starter Kit

Sensible defaults — rich text, history, lists, headings, marks

The bundled-defaults extension. Includes everything most editors need: paragraphs, headings, lists, basic marks (bold, italic, underline, strikethrough, code), history (undo/redo), links, and standard inline behavior.

If you're not sure which extensions to install — start with this one.

Install

pnpm add @typix-editor/extension-starter-kit

Live demo

Usage

editor.tsx
import { useTypixEditor, TypixEditorContext, EditorContent, defaultTheme } from "@typix-editor/react";
import { StarterKit } from "@typix-editor/extension-starter-kit";

const extensions = [StarterKit()];

export function Editor() {
  const editor = useTypixEditor({
    extensions,
    theme: defaultTheme,
    namespace: "my-editor",
  });

  return (
    <TypixEditorContext.Provider value={{ editor }}>
      <EditorContent editor={editor} placeholder="Start typing…" />
    </TypixEditorContext.Provider>
  );
}

What's inside

StarterKit() registers these extensions as a single bundle:

  • BoldExtension, ItalicExtension, UnderlineExtension, StrikeExtension, CodeExtension — inline marks
  • HeadingExtension — H1–H6
  • ListExtension — bullet, numbered, checklist
  • LinkExtension — link node + commands
  • HistoryExtension — undo/redo
  • Standard paragraph + plain-text + tab handling

Individual extension exports are also available for granular config:

import {
  BoldExtension,
  HeadingExtension,
  ListExtension,
  // ...
} from "@typix-editor/extension-starter-kit";

Skipping the bundle

If you need a stripped-down editor (e.g., a one-line input that just allows inline formatting), import only the marks you need:

import { BoldExtension, ItalicExtension } from "@typix-editor/extension-starter-kit";

const extensions = [BoldExtension(), ItalicExtension()];

Config

OptionTypeDefaultDescription
headingPartial<HeadingConfig>Forwarded to HeadingExtension.
listPartial<ListConfig>Forwarded to ListExtension.
historyPartial<HistoryConfig>Forwarded to HistoryExtension.
linkPartial<LinkConfig>Forwarded to LinkExtension.
…per-mark configsSee StarterKitOptions type.

On this page