-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updated Drag Handle #361
Merged
Merged
Updated Drag Handle #361
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
--- | ||
title: "Global Drag Handle (New)" | ||
description: "Drag and drop blocks across the editor" | ||
--- | ||
|
||
<Steps> | ||
|
||
<Step title="Install the extension"> | ||
Install the extension with a package manager of your choice. | ||
|
||
```NPM | ||
$ npm i tiptap-extension-global-drag-handle | ||
``` | ||
```Yarn | ||
$ yarn add tiptap-extension-global-drag-handle | ||
``` | ||
|
||
In order to enjoy all the advantages of a drag handle, it is recommended to install the auto joiner extension as well, which allows you to automatically join various nodes such as 2 lists that are next to each other. | ||
|
||
```NPM | ||
$ npm i tiptap-extension-auto-joiner | ||
``` | ||
```Yarn | ||
$ yarn add tiptap-extension-auto-joiner | ||
``` | ||
|
||
</Step> | ||
|
||
<Step title="Add drag extension"> | ||
```tsx | ||
// extensions.ts | ||
import GlobalDragHandle from 'tiptap-extension-global-drag-handle' | ||
import AutoJoiner from 'tiptap-extension-auto-joiner' // optional | ||
|
||
export const defaultExtensions = [ | ||
GlobalDragHandle, | ||
AutoJoiner, // optional | ||
// other extensions | ||
]; | ||
|
||
// editor.tsx | ||
const Editor = () => { | ||
return <EditorContent extensions={defaultExtensions} /> | ||
} | ||
``` | ||
</Step> | ||
|
||
<Step title="Configure the extension"> | ||
```tsx | ||
//extensions.ts | ||
import GlobalDragHandle from 'tiptap-extension-global-drag-handle' | ||
import AutoJoiner from 'tiptap-extension-auto-joiner' // optional | ||
|
||
export const defaultExtensions = [ | ||
GlobalDragHandle.configure({ | ||
dragHandleWidth: 20, // default | ||
|
||
// The scrollTreshold specifies how close the user must drag an element to the edge of the lower/upper screen for automatic | ||
// scrolling to take place. For example, scrollTreshold = 100 means that scrolling starts automatically when the user drags an | ||
// element to a position that is max. 99px away from the edge of the screen | ||
// You can set this to 0 to prevent auto scrolling caused by this extension | ||
scrollTreshold: 100 // default | ||
}), | ||
AutoJoiner.configure({ | ||
elementsToJoin: ["bulletList", "orderedList"] // default | ||
}), | ||
// other extensions | ||
]; | ||
|
||
// editor.tsx | ||
const Editor = () => { | ||
return <EditorContent extensions={defaultExtensions} /> | ||
} | ||
``` | ||
</Step> | ||
|
||
<Step title="Add styling"> | ||
By default the drag handle is headless, which means it doesn't contain any css. If you want to apply styling to the drag handle, use the class "drag-handle" in your css file. | ||
|
||
Take a look at [this](https:/steven-tey/novel/blob/main/apps/web/styles/prosemirror.css#L131) to see an example of drag handle styling. | ||
</Step> | ||
|
||
</Steps> |
This file contains 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
This file contains 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
This file was deleted.
Oops, something went wrong.
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo