-
Notifications
You must be signed in to change notification settings - Fork 0
Add smooth animated caret with line and underline styles #13
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
Merged
Merged
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 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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| import { Plugin } from "prosemirror-state"; | ||
| import type { EditorView } from "prosemirror-view"; | ||
|
|
||
| export type CaretStyle = "line" | "underline"; | ||
|
|
||
| let caretStyle: CaretStyle = (localStorage.getItem("cursor") as CaretStyle) ?? "line"; | ||
|
|
||
| // Track all active caret instances so setCaretStyle updates every editor. | ||
| const activeInstances = new Map<EditorView, HTMLElement>(); | ||
|
|
||
| export function setCaretStyle(style: CaretStyle) { | ||
| caretStyle = style; | ||
| for (const [view, el] of activeInstances) { | ||
| updateCaret(view, el); | ||
| } | ||
| } | ||
|
|
||
| function getCursorRect(view: EditorView) { | ||
| const sel = window.getSelection(); | ||
| if (sel?.rangeCount) { | ||
| const range = sel.getRangeAt(0).cloneRange(); | ||
| range.collapse(true); | ||
| const rects = range.getClientRects(); | ||
| const rect = rects.length ? rects[rects.length - 1] : null; | ||
| if (rect?.height) return rect; | ||
| } | ||
| return view.coordsAtPos(view.state.selection.head); | ||
| } | ||
|
|
||
| function updateCaret(view: EditorView, el: HTMLElement) { | ||
| const container = el.parentElement; | ||
| if (!container) return; | ||
| const containerRect = container.getBoundingClientRect(); | ||
| const cursorRect = getCursorRect(view); | ||
| if (!cursorRect) return; | ||
|
|
||
| const lineHeight = cursorRect.bottom - cursorRect.top; | ||
| el.setAttribute("data-style", caretStyle); | ||
| el.style.left = `${cursorRect.left - containerRect.left}px`; | ||
| el.style.top = | ||
| caretStyle === "underline" | ||
| ? `${cursorRect.bottom - containerRect.top - 2}px` | ||
| : `${cursorRect.top - containerRect.top}px`; | ||
| el.style.height = caretStyle === "underline" ? "2px" : `${lineHeight}px`; | ||
|
|
||
| // restart blink so caret stays solid while typing | ||
| el.style.animation = "none"; | ||
| void el.offsetWidth; | ||
| el.style.animation = ""; | ||
| } | ||
|
|
||
| export const caretPlugin = new Plugin({ | ||
| view(view) { | ||
| const parent = view.dom.parentElement; | ||
| if (!parent) { | ||
| throw new Error( | ||
| "caretPlugin: editor DOM node has no parent element – ensure the editor is mounted in the DOM before initializing the caret plugin", | ||
| ); | ||
| } | ||
|
|
||
| const el = document.createElement("div"); | ||
| el.className = "pm-caret"; | ||
| el.setAttribute("data-style", caretStyle); | ||
| parent.appendChild(el); | ||
|
|
||
| activeInstances.set(view, el); | ||
| updateCaret(view, el); | ||
|
|
||
| return { | ||
| update(v) { | ||
| updateCaret(v, el); | ||
| }, | ||
| destroy() { | ||
| el.remove(); | ||
| activeInstances.delete(view); | ||
| }, | ||
| }; | ||
| }, | ||
| }); | ||
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
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
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.
Type assertion could silently accept invalid values from
localStorage(e.g., if manually set to "foo"). Consider adding runtime validation: