Skip to content

docs(react-composable-api): align guide with latest Tiptap React API#621

Open
Ritik1330 wants to merge 1 commit intoueberdosis:mainfrom
Ritik1330:docs/react-composable-api-update
Open

docs(react-composable-api): align guide with latest Tiptap React API#621
Ritik1330 wants to merge 1 commit intoueberdosis:mainfrom
Ritik1330:docs/react-composable-api-update

Conversation

@Ritik1330
Copy link
Copy Markdown

Updates the React Composable API guide to align with the latest @tiptap/react changes introduced in the composable API simplification and menu components refactor.

Key updates:

  • Replace deprecated instance prop with the new editor prop on <Tiptap>
  • Update menu usage to import BubbleMenu and FloatingMenu from @tiptap/react/menus
  • Remove deprecated Tiptap.Loading, Tiptap.BubbleMenu, and Tiptap.FloatingMenu subcomponents
  • Simplify useTiptap examples by removing the isReady flag (editor is now always available from context)
  • Update all code samples to reflect the new composable API structure
  • Remove outdated guidance referencing isReady
  • Clarify that menu components are imported separately from the core @tiptap/react entrypoint
  • Update API reference to document the editor prop and removal of isReady

This brings the Composable API documentation in sync with the current @tiptap/react implementation after the API simplification changes.

…p React changes after the menu components refactor and API simplification.

Changes:

- Replace deprecated `instance` prop with `editor` for the `<Tiptap>` component
- Move `BubbleMenu` and `FloatingMenu` to separate imports from `@tiptap/react/menus`
- Remove deprecated `Tiptap.Loading`, `Tiptap.BubbleMenu`, and `Tiptap.FloatingMenu` subcomponents
- Simplify `useTiptap` usage by removing the `isReady` flag and relying on null checks for `editor`
- Remove `immediatelyRender: false` option from SSR example (no longer required)
- Update all code examples to reflect the new API structure and import patterns
- Remove outdated warning about checking `isReady` before using `useTiptapState`
- Clarify that menu components are imported separately and provide updated examples
- Update API reference to document the `editor` prop and removal of `isReady`

This ensures the Composable API documentation matches the current `@tiptap/react` implementation.
@vercel
Copy link
Copy Markdown

vercel bot commented Feb 18, 2026

@Ritik1330 is attempting to deploy a commit to the Tiptap Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant