Skip to content
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

Add home template details to inspector controls #61762

Merged
merged 4 commits into from
May 20, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
124 changes: 124 additions & 0 deletions packages/editor/src/components/blog-title/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
/**
* WordPress dependencies
*/
import { __, sprintf } from '@wordpress/i18n';
import { debounce } from '@wordpress/compose';
import { useSelect, useDispatch } from '@wordpress/data';
import { store as coreStore } from '@wordpress/core-data';
import { decodeEntities } from '@wordpress/html-entities';
import {
Button,
Dropdown,
__experimentalInputControl as InputControl,
} from '@wordpress/components';
import { useState, useMemo } from '@wordpress/element';
import { __experimentalInspectorPopoverHeader as InspectorPopoverHeader } from '@wordpress/block-editor';

/**
* Internal dependencies
*/
import { TEMPLATE_POST_TYPE } from '../../store/constants';
import PostPanelRow from '../post-panel-row';
import { store as editorStore } from '../../store';

const EMPTY_OBJECT = {};

export default function BlogTitle() {
const { editEntityRecord } = useDispatch( coreStore );
const { postsPageTitle, postsPageId, isTemplate, postSlug } = useSelect(
( select ) => {
const { getEntityRecord, getEditedEntityRecord } =
select( coreStore );
const siteSettings = getEntityRecord( 'root', 'site' );
const _postsPageRecord = siteSettings?.page_for_posts
? getEditedEntityRecord(
'postType',
'page',
siteSettings?.page_for_posts
)
: EMPTY_OBJECT;
const { getEditedPostAttribute, getCurrentPostType } =
select( editorStore );
return {
postsPageId: _postsPageRecord?.id,
postsPageTitle: _postsPageRecord?.title,
isTemplate: getCurrentPostType() === TEMPLATE_POST_TYPE,
postSlug: getEditedPostAttribute( 'slug' ),
};
},
[]
);
// Use internal state instead of a ref to make sure that the component
// re-renders when the popover's anchor updates.
const [ popoverAnchor, setPopoverAnchor ] = useState( null );
// Memoize popoverProps to avoid returning a new object every time.
const popoverProps = useMemo(
() => ( {
// Anchor the popover to the middle of the entire row so that it doesn't
// move around when the label changes.
anchor: popoverAnchor,
placement: 'left-start',
offset: 36,
shift: true,
} ),
[ popoverAnchor ]
);

if (
! isTemplate ||
! [ 'home', 'index' ].includes( postSlug ) ||
! postsPageId
) {
return null;
}

const setPostsPageTitle = ( newValue ) => {
editEntityRecord( 'postType', 'page', postsPageId, {
title: newValue,
} );
};
const decodedTitle = decodeEntities( postsPageTitle );
return (
<PostPanelRow label={ __( 'Blog title' ) } ref={ setPopoverAnchor }>
<Dropdown
popoverProps={ popoverProps }
contentClassName="editor-blog-title-dropdown__content"
focusOnMount
renderToggle={ ( { isOpen, onToggle } ) => (
<Button
size="compact"
variant="tertiary"
aria-expanded={ isOpen }
aria-label={ sprintf(
// translators: %s: Current post link.
__( 'Change blog title: %s' ),
decodedTitle
) }
onClick={ onToggle }
>
{ decodedTitle }
</Button>
) }
renderContent={ ( { onClose } ) => (
<>
<InspectorPopoverHeader
title={ __( 'Blog title' ) }
onClose={ onClose }
/>
<InputControl
placeholder={ __( 'No Title' ) }
size={ '__unstable-large' }
value={ postsPageTitle }
onChange={ debounce( setPostsPageTitle, 300 ) }
label={ __( 'Blog title' ) }
help={ __(
'Set the Posts Page title. Appears in search results, and when the page is shared on social media.'
) }
hideLabelFromVision
/>
</>
) }
/>
</PostPanelRow>
);
}
4 changes: 4 additions & 0 deletions packages/editor/src/components/blog-title/style.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.editor-blog-title-dropdown__content .components-popover__content {
min-width: 320px;
padding: $grid-unit-20;
}
101 changes: 101 additions & 0 deletions packages/editor/src/components/posts-per-page/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
/**
* WordPress dependencies
*/
import { __ } from '@wordpress/i18n';
import { useSelect, useDispatch } from '@wordpress/data';
import { store as coreStore } from '@wordpress/core-data';
import {
Button,
Dropdown,
__experimentalNumberControl as NumberControl,
} from '@wordpress/components';
import { useState, useMemo } from '@wordpress/element';
import { __experimentalInspectorPopoverHeader as InspectorPopoverHeader } from '@wordpress/block-editor';

/**
* Internal dependencies
*/
import { TEMPLATE_POST_TYPE } from '../../store/constants';
import { store as editorStore } from '../../store';
import PostPanelRow from '../post-panel-row';

export default function PostsPerPage() {
const { editEntityRecord } = useDispatch( coreStore );
const { postsPerPage, isTemplate, postSlug } = useSelect( ( select ) => {
const { getEditedPostAttribute, getCurrentPostType } =
select( editorStore );
const { getEditedEntityRecord } = select( coreStore );
const siteSettings = getEditedEntityRecord( 'root', 'site' );
return {
isTemplate: getCurrentPostType() === TEMPLATE_POST_TYPE,
postSlug: getEditedPostAttribute( 'slug' ),
postsPerPage: siteSettings?.posts_per_page || 1,
};
}, [] );
// Use internal state instead of a ref to make sure that the component
// re-renders when the popover's anchor updates.
const [ popoverAnchor, setPopoverAnchor ] = useState( null );
// Memoize popoverProps to avoid returning a new object every time.
const popoverProps = useMemo(
() => ( {
// Anchor the popover to the middle of the entire row so that it doesn't
// move around when the label changes.
anchor: popoverAnchor,
placement: 'left-start',
offset: 36,
shift: true,
} ),
[ popoverAnchor ]
);

if ( ! isTemplate || ! [ 'home', 'index' ].includes( postSlug ) ) {
return null;
}
const setPostsPerPage = ( newValue ) => {
editEntityRecord( 'root', 'site', undefined, {
posts_per_page: newValue,
} );
};
return (
<PostPanelRow label={ __( 'Posts per page' ) } ref={ setPopoverAnchor }>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This text wraps in two lines and I'm not sure how we can address that properly, since all labels have a width:30%. Should we apply some truncate rules to editor-post-panel__row-label in general?

It seems like we might have more similar use cases in the future, and it seems like a problem that could be happening already in different languages. --cc @WordPress/gutenberg-design

<Dropdown
popoverProps={ popoverProps }
contentClassName="editor-posts-per-page-dropdown__content"
focusOnMount
renderToggle={ ( { isOpen, onToggle } ) => (
<Button
size="compact"
variant="tertiary"
aria-expanded={ isOpen }
aria-label={ __( 'Change posts per page' ) }
onClick={ onToggle }
>
{ postsPerPage }
</Button>
) }
renderContent={ ( { onClose } ) => (
<>
<InspectorPopoverHeader
title={ __( 'Posts per page' ) }
onClose={ onClose }
/>
<NumberControl
placeholder={ 0 }
value={ postsPerPage }
size={ '__unstable-large' }
spinControls="custom"
step="1"
min="1"
onChange={ setPostsPerPage }
label={ __( 'Posts per page' ) }
help={ __(
'Set the default number of posts to display on blog pages, including categories and tags. Some templates may override this setting.'
) }
hideLabelFromVision
/>
</>
) }
/>
</PostPanelRow>
);
}
4 changes: 4 additions & 0 deletions packages/editor/src/components/posts-per-page/style.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.editor-posts-per-page-dropdown__content .components-popover__content {
min-width: 320px;
padding: $grid-unit-20;
}
8 changes: 7 additions & 1 deletion packages/editor/src/components/sidebar/post-summary.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ import PostSyncStatus from '../post-sync-status';
import PostTemplatePanel from '../post-template/panel';
import PostTrashPanel from '../post-trash/panel';
import PostURLPanel from '../post-url/panel';
import BlogTitle from '../blog-title';
import PostsPerPage from '../posts-per-page';
import SiteDiscussion from '../site-discussion';
import { store as editorStore } from '../../store';
import {
NAVIGATION_POST_TYPE,
Expand Down Expand Up @@ -87,7 +90,10 @@ export default function PostSummary( { onActionPerformed } ) {
</VStack>
<PostStickyPanel />
<PostFormatPanel />
{ isTemplate && <TemplateAreas /> }
<BlogTitle />
<PostsPerPage />
<SiteDiscussion />
<TemplateAreas />
{ fills }
{ ! isPattern &&
! isTemplate &&
Expand Down
138 changes: 138 additions & 0 deletions packages/editor/src/components/site-discussion/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
/**
* WordPress dependencies
*/
import { __ } from '@wordpress/i18n';
import { useSelect, useDispatch } from '@wordpress/data';
import { store as coreStore } from '@wordpress/core-data';
import {
Button,
Dropdown,
RadioControl,
__experimentalVStack as VStack,
__experimentalText as Text,
} from '@wordpress/components';
import { useState, useMemo } from '@wordpress/element';
import { __experimentalInspectorPopoverHeader as InspectorPopoverHeader } from '@wordpress/block-editor';

/**
* Internal dependencies
*/
import { TEMPLATE_POST_TYPE } from '../../store/constants';
import PostPanelRow from '../post-panel-row';
import { store as editorStore } from '../../store';

const COMMENT_OPTIONS = [
{
label: (
<>
{ __( 'Open' ) }
<Text variant="muted" size={ 12 }>
{ __( 'Visitors can add new comments and replies.' ) }
</Text>
</>
),
value: 'open',
},
{
label: (
<>
{ __( 'Closed' ) }
<Text variant="muted" size={ 12 }>
{ __( 'Visitors cannot add new comments or replies.' ) }
</Text>
<Text variant="muted" size={ 12 }>
{ __( 'Existing comments remain visible.' ) }
</Text>
</>
),
value: '',
},
];

export default function SiteDiscussion() {
const { editEntityRecord } = useDispatch( coreStore );
const { allowCommentsOnNewPosts, isTemplate, postSlug } = useSelect(
( select ) => {
const { getEditedPostAttribute, getCurrentPostType } =
select( editorStore );
const { getEditedEntityRecord } = select( coreStore );
const siteSettings = getEditedEntityRecord( 'root', 'site' );
return {
isTemplate: getCurrentPostType() === TEMPLATE_POST_TYPE,
postSlug: getEditedPostAttribute( 'slug' ),
allowCommentsOnNewPosts:
siteSettings?.default_comment_status || '',
};
},
[]
);
// Use internal state instead of a ref to make sure that the component
// re-renders when the popover's anchor updates.
const [ popoverAnchor, setPopoverAnchor ] = useState( null );
// Memoize popoverProps to avoid returning a new object every time.
const popoverProps = useMemo(
() => ( {
// Anchor the popover to the middle of the entire row so that it doesn't
// move around when the label changes.
anchor: popoverAnchor,
placement: 'left-start',
offset: 36,
shift: true,
} ),
[ popoverAnchor ]
);

if ( ! isTemplate || ! [ 'home', 'index' ].includes( postSlug ) ) {
return null;
}
const setAllowCommentsOnNewPosts = ( newValue ) => {
editEntityRecord( 'root', 'site', undefined, {
default_comment_status: newValue ? 'open' : null,
} );
};
return (
<PostPanelRow label={ __( 'Discussion' ) } ref={ setPopoverAnchor }>
<Dropdown
popoverProps={ popoverProps }
contentClassName="editor-site-discussion-dropdown__content"
focusOnMount
renderToggle={ ( { isOpen, onToggle } ) => (
<Button
size="compact"
variant="tertiary"
aria-expanded={ isOpen }
aria-label={ __( 'Change discussion settings' ) }
onClick={ onToggle }
>
{ allowCommentsOnNewPosts
? __( 'Comments open' )
: __( 'Comments closed' ) }
</Button>
) }
renderContent={ ( { onClose } ) => (
<>
<InspectorPopoverHeader
title={ __( 'Discussion' ) }
onClose={ onClose }
/>
<VStack spacing={ 3 }>
<Text>
{ __(
'Changes will apply to new posts only. Individual posts may override these settings.'
) }
</Text>
<RadioControl
className="editor-site-discussion__options"
hideLabelFromVision
label={ __( 'Comment status' ) }
options={ COMMENT_OPTIONS }
onChange={ setAllowCommentsOnNewPosts }
selected={ allowCommentsOnNewPosts }
/>
</VStack>
</>
) }
/>
</PostPanelRow>
);
}
Loading
Loading