Skip to content

feat: use remirror link extension #257

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 2 commits into from
May 3, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
254 changes: 244 additions & 10 deletions ui/src/components/nodes/Rich.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,13 @@ import {
BoldExtension,
CalloutExtension,
ItalicExtension,
LinkExtension,
PlaceholderExtension,
ShortcutHandlerProps,
SubExtension,
SupExtension,
TextHighlightExtension,
createMarkPositioner,
wysiwygPreset,
} from "remirror/extensions";
import {
Expand All @@ -84,16 +87,246 @@ import {
BaselineButtonGroup,
CommandButton,
CommandButtonProps,
useChainedCommands,
useCurrentSelection,
useAttrs,
useUpdateReason,
FloatingWrapper,
} from "@remirror/react";
import { WysiwygEditor } from "@remirror/react-editors/wysiwyg";
import { FloatingToolbar } from "@remirror/react";
import { FloatingToolbar, useExtensionEvent } from "@remirror/react";
import { TableExtension } from "@remirror/extension-react-tables";
import { GenIcon, IconBase } from "@remirror/react-components";
import "remirror/styles/all.css";

import { htmlToProsemirrorNode } from "remirror";
import { styled } from "@mui/material";

function useLinkShortcut() {
const [linkShortcut, setLinkShortcut] = useState<
ShortcutHandlerProps | undefined
>();
const [isEditing, setIsEditing] = useState(false);

useExtensionEvent(
LinkExtension,
"onShortcut",
useCallback(
(props) => {
if (!isEditing) {
setIsEditing(true);
}

return setLinkShortcut(props);
},
[isEditing]
)
);

return { linkShortcut, isEditing, setIsEditing };
}

function useFloatingLinkState() {
const chain = useChainedCommands();
const { isEditing, linkShortcut, setIsEditing } = useLinkShortcut();
const { to, empty } = useCurrentSelection();

const url = (useAttrs().link()?.href as string) ?? "";
const [href, setHref] = useState<string>(url);

// A positioner which only shows for links.
const linkPositioner = React.useMemo(
() => createMarkPositioner({ type: "link" }),
[]
);

const onRemove = useCallback(() => {
return chain.removeLink().focus().run();
}, [chain]);

const updateReason = useUpdateReason();

React.useLayoutEffect(() => {
if (!isEditing) {
return;
}

if (updateReason.doc || updateReason.selection) {
setIsEditing(false);
}
}, [isEditing, setIsEditing, updateReason.doc, updateReason.selection]);

useEffect(() => {
setHref(url);
}, [url]);

const submitHref = useCallback(() => {
setIsEditing(false);
const range = linkShortcut ?? undefined;

if (href === "") {
chain.removeLink();
} else {
chain.updateLink({ href, auto: false }, range);
}

chain.focus(range?.to ?? to).run();
}, [setIsEditing, linkShortcut, chain, href, to]);

const cancelHref = useCallback(() => {
setIsEditing(false);
}, [setIsEditing]);

const clickEdit = useCallback(() => {
if (empty) {
chain.selectLink();
}

setIsEditing(true);
}, [chain, empty, setIsEditing]);

return React.useMemo(
() => ({
href,
setHref,
linkShortcut,
linkPositioner,
isEditing,
clickEdit,
onRemove,
submitHref,
cancelHref,
}),
[
href,
linkShortcut,
linkPositioner,
isEditing,
clickEdit,
onRemove,
submitHref,
cancelHref,
]
);
}

const DelayAutoFocusInput = ({
autoFocus,
...rest
}: React.HTMLProps<HTMLInputElement>) => {
const inputRef = useRef<HTMLInputElement>(null);

useEffect(() => {
if (!autoFocus) {
return;
}

const frame = window.requestAnimationFrame(() => {
inputRef.current?.focus();
});

return () => {
window.cancelAnimationFrame(frame);
};
}, [autoFocus]);

return <input ref={inputRef} {...rest} />;
};

const FloatingLinkToolbar = ({ children }) => {
const {
isEditing,
linkPositioner,
clickEdit,
onRemove,
submitHref,
href,
setHref,
cancelHref,
} = useFloatingLinkState();
const active = useActive();
const activeLink = active.link();
const { empty } = useCurrentSelection();

const handleClickEdit = useCallback(() => {
clickEdit();
}, [clickEdit]);

const linkEditButtons = activeLink ? (
<CommandButtonGroup>
<CommandButton
commandName="updateLink"
aria-label="Edit link"
onSelect={handleClickEdit}
icon="pencilLine"
enabled
/>
<CommandButton
commandName="removeLink"
aria-label="Remove link"
onSelect={onRemove}
icon="linkUnlink"
enabled
/>
</CommandButtonGroup>
) : (
<CommandButtonGroup>
<CommandButton
commandName="updateLink"
aria-label="Add link"
onSelect={handleClickEdit}
icon="link"
enabled
/>
</CommandButtonGroup>
);

return (
<>
{!isEditing && (
<FloatingToolbar>
{linkEditButtons}
{children}
</FloatingToolbar>
)}
{!isEditing && empty && (
<FloatingToolbar positioner={linkPositioner}>
{linkEditButtons}
{children}
</FloatingToolbar>
)}

<FloatingWrapper
positioner="always"
placement="bottom"
enabled={isEditing}
renderOutsideEditor
>
<DelayAutoFocusInput
style={{ zIndex: 20 }}
autoFocus
placeholder="Enter link..."
onChange={(event: React.ChangeEvent<HTMLInputElement>) =>
setHref(event.target.value)
}
value={href}
onKeyPress={(event: React.KeyboardEvent<HTMLInputElement>) => {
const { code } = event;

if (code === "Enter") {
submitHref();
}

if (code === "Escape") {
cancelHref();
}
}}
/>
</FloatingWrapper>
</>
);
};

export interface SetHighlightButtonProps
extends Omit<
CommandButtonProps,
Expand Down Expand Up @@ -175,6 +408,7 @@ const MyEditor = ({
new TextHighlightExtension(),
new SupExtension(),
new SubExtension(),
new LinkExtension({ autoLink: true }),
// new CalloutExtension({ defaultType: "warn" }),
...wysiwygPreset(),
],
Expand Down Expand Up @@ -230,33 +464,33 @@ const MyEditor = ({
>
{/* <WysiwygToolbar /> */}
<EditorComponent />

<TableComponents />

{!isGuest && (
<FloatingToolbar>
<FloatingLinkToolbar>
<FormattingButtonGroup />
<VerticalDivider />
<CommandButtonGroup>
{/* <HeadingLevelButtonGroup /> */}
{/* <VerticalDivider /> */}
<FormattingButtonGroup />

{/* <ListButtonGroup /> */}
<SetHighlightButton color="lightpink" />
<SetHighlightButton color="yellow" />
<SetHighlightButton color="lightgreen" />
<SetHighlightButton color="lightcyan" />
<SetHighlightButton />
</CommandButtonGroup>
<VerticalDivider />
{/* <FormattingButtonGroup /> */}
{/* <DecreaseIndentButton /> */}
{/* <IncreaseIndentButton /> */}
{/* <TextAlignmentButtonGroup /> */}
{/* <IndentationButtonGroup /> */}
{/* <BaselineButtonGroup /> */}
</FloatingToolbar>
)}
{!isGuest && (
<FloatingToolbar positioner="emptyBlockStart">
<HeadingLevelButtonGroup />
</FloatingToolbar>
</FloatingLinkToolbar>
)}

{/* <Menu /> */}
</Remirror>
</MyStyledWrapper>
Expand Down