docs(react-composable-api): align guide with latest Tiptap React API#621
Open
Ritik1330 wants to merge 1 commit intoueberdosis:mainfrom
Open
docs(react-composable-api): align guide with latest Tiptap React API#621Ritik1330 wants to merge 1 commit intoueberdosis:mainfrom
Ritik1330 wants to merge 1 commit intoueberdosis:mainfrom
Conversation
…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.
|
@Ritik1330 is attempting to deploy a commit to the Tiptap Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
instanceprop with the neweditorprop on<Tiptap>BubbleMenuandFloatingMenufrom@tiptap/react/menusTiptap.Loading,Tiptap.BubbleMenu, andTiptap.FloatingMenusubcomponentsuseTiptapexamples by removing theisReadyflag (editor is now always available from context)isReady@tiptap/reactentrypointeditorprop and removal ofisReadyThis brings the Composable API documentation in sync with the current
@tiptap/reactimplementation after the API simplification changes.