PromucFlow_constructor/app/client/src/comments/inlineComments/InlineCommentPin.tsx

108 lines
3.4 KiB
TypeScript
Raw Normal View History

Initialise comments (#3328) * Initial scaffolding for comments CRUD APIs * add actions * add assets * state management for existing comments and creating new * add ui components * add overlay comments wrapper to baseWidget * add toggle comment mode button at editor header * trigger tests * Disallow commenting as someone else * Add applicationId for comments * lint * Add overlay blacklist to prevent component interaction while adding comments * Comment thread style updates * Placeholder comment context menu * Controlled comment thread visibility for making new comments visible by default * Update comment type description * Reset input on save * Resolve comment thread button ui * fix close on esc key, dont create new comment on outside click * Submit on enter * add emoji picker * Attempt at adding a websocket server in Java * CRUD APIs for comment threads * Add API for getting all threads in application * Move types to a separate file * Initial commit for real time server (RTS) * Add script to start RTS * Fix position property * Use create comment thread API * Use add comment to thread API * Add custom cursor * Dispatch logout init on 401 errors * Allow CORS for real time connection * Add more logs to RTS * Fix construction of MongoClient * WIP: Real time comments * Enable comments * Minor updates * Read backend API base URL from environment * Escape to reset comments mode * Set popover position as auto and boundary as scroll parent * Disable warning * Added permissions for comment threads * Add resolved API for comment threads * Migration to set commenting permission on existing apps * Fix updates bringing the RTS down * Show view latest button, scroll to bottom on creating a new comment * Cleanup comment reducer * Move to typescript for RTS * Add missing server.ts and tsconfig files * Resolve / unresolve comment * Scaffold app comments * Minor fixes: comment on top of all widgets, add toggle button at viewer header * Reconnect socket on creating a new app, set connected status in store * Retry socket connection flow * Integration tests for comments with api mocks using msw * Fix circular depependency * rm file * Minor cleanup and comments * Minor refactors: move isScrolledToBottom to common hooks, decouple prevent interactions overlay from comments wrapper * Use policies when pushing updates in RTS * ENV var to set if comments are enabled * Fix: check if editor/viewer is initialised before waiting for init action * Add tests for comments reducer * Revert "ENV var to set if comments are enabled" This reverts commit 988efeaa69d378d943a387e1e73510334958adc5. * Enable comments for users with appsmith email * lint * fix * Try running a socket.io server inside backend * Update comment reducer tests * Init mentions within comments * Fix comment thread updates with email rooms * Minor fixes * Refactors / review suggestions * lint * increase cache limit for builds * Comment out tests for feature that's under development * Add Dockerfile for RTS * Fix policies missing for first comment in threads * Use draftJS for comments input with mentions support * fix fixtures * Use thread's policies when querying for threads * Update socket.io to v4 * Add support for richer body with mentions * Update comment body type to RawDraftContentState * fix stale method * Fix mentions search * Minor cleanups * Comment context menu and thread UI updates * revert: Scaffold app comments * Yarn dependencies * Delete comment using id api added * Init app comments * Add test for creating thread * Api for delete comment with id * Test comment creation response and policies * Copy comment links * Fix reset editor state * Delete valid comment testcase added * Delete comment TC : code refactor * Don't allow creating comments with an empty body * Pin comments WIP[] * Ignore dependency-reduced-pom.xml files from VCS * Cleanup of some dev-only files, for review * Delete comment * Update socket.io to v4 in RTS * Pin and resolve comment thread object added in commentThread * Pin and resolve comment thread object added in commentThread * Update comment thread API * Added creationTime and updationTime in comment thread response * Added creationTime and updationTime in comment thread response * Added human readable id to comment threads, fallback to username for null name in user document * Refactor * lint * fix test, rm duplicate selector * comment out saga used for dev * CommentThread viewed status, username fallback for getName=null, username field added in pin & resolve status * lint * trigger tests Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com> Co-authored-by: Abhijeet <abhi.nagarnaik@gmail.com>
2021-04-29 10:33:51 +00:00
import React, { useEffect } from "react";
import { useSelector, useDispatch } from "react-redux";
import styled, { withTheme } from "styled-components";
import CommentThread from "comments/CommentThread/CommentThread";
import Icon, { IconSize } from "components/ads/Icon";
import { Popover } from "@blueprintjs/core";
import { get } from "lodash";
import { commentThreadsSelector } from "selectors/commentsSelectors";
import { Theme } from "constants/DefaultTheme";
import { setIsCommentThreadVisible as setIsCommentThreadVisibleAction } from "actions/commentActions";
const CommentTriggerContainer = styled.div<{ top: number; left: number }>`
position: absolute;
top: ${(props) => props.top}%;
left: ${(props) => props.left}%;
z-index: 1;
`;
const useSelectCommentThreadUsingQuery = (commentThreadId: string) => {
const dispatch = useDispatch();
useEffect(() => {
const searchParams = new URL(window.location.href).searchParams;
const commentThreadIdInUrl = searchParams.get("commentThreadId");
if (commentThreadIdInUrl && commentThreadIdInUrl === commentThreadId) {
const elements = document.getElementsByClassName(
`comment-thread-pin-${commentThreadId}`,
);
const commentPin = elements && elements[0];
commentPin?.scrollIntoView();
// set comment thread visible after scrollIntoView is complete
setTimeout(() => {
dispatch(
setIsCommentThreadVisibleAction({
commentThreadId,
isVisible: true,
}),
);
});
}
}, []);
};
/**
* Comment pins that toggle comment thread popover visibility on click
* They position themselves using position absolute based on top and left values (in percent)
*/
const InlineCommentPin = withTheme(
({ commentThreadId, theme }: { commentThreadId: string; theme: Theme }) => {
const commentThread = useSelector(commentThreadsSelector(commentThreadId));
const { top, left } = get(commentThread, "position", {
top: 0,
left: 0,
});
const dispatch = useDispatch();
const setIsCommentThreadVisible = (isVisible: boolean) =>
dispatch(
setIsCommentThreadVisibleAction({
commentThreadId,
isVisible,
}),
);
useSelectCommentThreadUsingQuery(commentThreadId);
return (
<CommentTriggerContainer
data-cy="inline-comment-pin"
left={left}
onClick={(e: any) => {
// capture clicks so that create new thread is not triggered
e.preventDefault();
e.stopPropagation();
}}
top={top}
>
<Popover
autoFocus
canEscapeKeyClose
hasBackdrop
isOpen={!!commentThread.isVisible}
minimal
// isOpen is controlled so that newly created threads are set to be visible
onInteraction={(nextOpenState) => {
setIsCommentThreadVisible(nextOpenState);
}}
popoverClassName="comment-thread"
>
<Icon
className={`comment-thread-pin-${commentThreadId}`}
data-cy={`t--inline-comment-pin-trigger-${commentThreadId}`}
fillColor={theme.colors.comments.pin}
name="pin"
size={IconSize.XXL}
/>
<CommentThread
commentThread={commentThread}
inline
isOpen={!!commentThread.isVisible}
/>
</Popover>
</CommentTriggerContainer>
);
},
);
export default InlineCommentPin;