Skip to content

Inline Commenting: Added new sidebar as extension of the canvas #67347

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.

Sign up for GitHub

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
ellatrix merged 6 commits into from
Dec 2, 2024
Merged

Inline Commenting: Added new sidebar as extension of the canvas #67347

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
35c9f23
Create new sidebar as extension of editor canvas for commenting
akasunil Nov 27, 2024
f1d7e1c
Cleanup and error fix
akasunil Nov 27, 2024
b1f0488
Merge branch 'trunk' of github.com:WordPress/gutenberg into try/inlin…
akasunil Nov 29, 2024
c60972c
Keep collab sidebar open when comments are available
akasunil Nov 29, 2024
06c49ba
Merge branch 'trunk' of github.com:WordPress/gutenberg into try/inlin…
akasunil Nov 29, 2024
d096211
Remove fallback background color function
akasunil Nov 29, 2024
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
Prev Previous commit
Next Next commit
Keep collab sidebar open when comments are available
  • Loading branch information
@akasunil
akasunil committed Nov 29, 2024
commit c60972c05820b8cca22a2dd919bb39827b1e5f4c
27 changes: 25 additions & 2 deletions packages/editor/src/components/collab-sidebar/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@
* WordPress dependencies
*/
import { __ } from '@wordpress/i18n';
import { useSelect, useDispatch, resolveSelect } from '@wordpress/data';
import {
useSelect,
useDispatch,
resolveSelect,
subscribe,
} from '@wordpress/data';
import { useState, useMemo } from '@wordpress/element';
import { comment as commentIcon } from '@wordpress/icons';
import { addFilter } from '@wordpress/hooks';
Expand All @@ -22,6 +27,7 @@ import { store as editorStore } from '../../store';
import AddCommentButton from './comment-button';
import AddCommentToolbarButton from './comment-button-toolbar';
import { getEditorCanvasBackgroundColor } from './utils';
import { useGlobalStylesContext } from '../global-styles-provider';

const isBlockCommentExperimentEnabled =
window?.__experimentalEnableBlockComment;
Expand Down Expand Up @@ -213,6 +219,7 @@ function CollabSidebarContent( {
export default function CollabSidebar() {
const [ showCommentBoard, setShowCommentBoard ] = useState( false );
const { enableComplementaryArea } = useDispatch( interfaceStore );
const { getActiveComplementaryArea } = useSelect( interfaceStore );

const { postStatus } = useSelect( ( select ) => {
return {
Expand Down Expand Up @@ -285,6 +292,21 @@ export default function CollabSidebar() {
return result;
}, [ threads ] );

// Get the global styles to set the background color of the sidebar.
const { merged: GlobalStyles } = useGlobalStylesContext();
const backgroundColor = GlobalStyles?.styles?.color?.background;

if ( 0 < resultComments.length ) {
const unsubscribe = subscribe( () => {
Copy link
Member

@ellatrix ellatrix Nov 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you change this to an effect? We shouldn't subscribe on render.

Copy link
Member Author

@akasunil akasunil Nov 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

useEffect won't work in this case, as the component doesn't re-render when another sidebar is toggled from outside the editor.

const activeSidebar = getActiveComplementaryArea( 'core' );

if ( ! activeSidebar ) {
enableComplementaryArea( 'core', 'edit-post/collab-sidebar' );
unsubscribe();
}
} );
Copy link
Member

@ellatrix ellatrix Nov 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could probably create an option for PluginSidebar to use the sidebar as a fallback sidebar that is always open instead of this, but it's fine as a temporary solution.

}

// Check if the experimental flag is enabled.
if ( ! isBlockCommentExperimentEnabled || postStatus === 'publish' ) {
return null; // or maybe return some message indicating no threads are available.
Expand Down Expand Up @@ -321,7 +343,8 @@ export default function CollabSidebar() {
showCommentBoard={ showCommentBoard }
setShowCommentBoard={ setShowCommentBoard }
styles={ {
backgroundColor: getEditorCanvasBackgroundColor(),
backgroundColor:
backgroundColor ?? getEditorCanvasBackgroundColor(),
} }
/>
</PluginSidebar>
Expand Down
Loading