Super Editor

Super Editor does not provide a built-in Large Language Model (LLM). Instead, it provides UI tools and patterns to help you build chat-style interfaces (like ChatGPT or Gemini) where an LLM generates text based on user queries.

To create a seamless AI experience, you can use Super Editor to implement features like streaming text effects, such as fading in content as the LLM generates it.

If you need more detailed information than the unified API provides, or if you need to handle platform-specific reporting behaviors, you can use the dedicated platform APIs:

• iOS: Use SuperKeyboardIOS.
• Android: Use SuperKeyboardAndroid.

These APIs are provided because platforms report keyboard state and height differently, and the unified API is limited to the features common to both.

The SoftwareKeyboardHeightSimulator works by intercepting messages sent over the TextInput platform channel.

When a widget (like a TextField) requests focus, Flutter sends messages such as TextInput.show. The simulator intercepts these and:

1. Notifies listeners that the keyboard state has changed to KeyboardState.opening (or closing).
2. Triggers an animation that increases the MediaQuery bottom insets, simulating the physical space occupied by a software keyboard.

When embedding SuperEditor within an existing scrolling system, you have two primary architectural choices:

1. Use SuperEditor as a Sliver: This is the preferred method. It is built specifically for this purpose and integrates better with Flutter's scrolling and layout engine. Use this when working with CustomScrollView or other sliver-based layouts.
2. Use SuperEditor as a RenderBox: This involves expanding SuperEditor to its maximum height by setting shrinkWrap: true. This is useful for ListView or other box-based scrollables, but it requires that all components within the editor (including custom ones) support intrinsic height to avoid layout issues.

The serializeDocumentToMarkdown function accepts a syntax parameter of type MarkdownSyntax to control how Markdown is generated.

There are two primary options:

• MarkdownSyntax.superEditor: Standard Markdown plus custom syntaxes (e.g., paragraph alignment like :--- for left or :---: for center).
• MarkdownSyntax.normal: Standard Markdown syntax as defined by the markdown package.

MarkdownSyntax.superEditor is the default.

final markdown = serializeDocumentToMarkdown(
  superEditorDocument,
  syntax: MarkdownSyntax.normal,
);