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.

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

Add: Page start options (templates and patterns). #39147

Closed
wants to merge 1 commit into from
Closed

Add: Page start options (templates and patterns). #39147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions lib/block-patterns.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function gutenberg_register_gutenberg_patterns() {
$patterns = array(
'query-standard-posts' => array(
'title' => _x( 'Standard', 'Block pattern title', 'gutenberg' ),
'blockTypes' => array( 'core/query' ),
'blockTypes' => array( 'core/query', 'core/post-content' ),
'categories' => array( 'query' ),
'content' => '<!-- wp:query {"query":{"perPage":3,"pages":0,"offset":0,"postType":"post","order":"desc","orderBy":"date","author":"","search":"","exclude":[],"sticky":"","inherit":false}} -->
<div class="wp-block-query">
Expand All @@ -35,7 +35,7 @@ function gutenberg_register_gutenberg_patterns() {
),
'query-medium-posts' => array(
'title' => _x( 'Image at left', 'Block pattern title', 'gutenberg' ),
'blockTypes' => array( 'core/query' ),
'blockTypes' => array( 'core/query', 'core/post-content' ),
'categories' => array( 'query' ),
'content' => '<!-- wp:query {"query":{"perPage":3,"pages":0,"offset":0,"postType":"post","order":"desc","orderBy":"date","author":"","search":"","exclude":[],"sticky":"","inherit":false}} -->
<div class="wp-block-query">
Expand All @@ -55,7 +55,7 @@ function gutenberg_register_gutenberg_patterns() {
),
'query-small-posts' => array(
'title' => _x( 'Small image and title', 'Block pattern title', 'gutenberg' ),
'blockTypes' => array( 'core/query' ),
'blockTypes' => array( 'core/query', 'core/post-content' ),
'categories' => array( 'query' ),
'content' => '<!-- wp:query {"query":{"perPage":3,"pages":0,"offset":0,"postType":"post","order":"desc","orderBy":"date","author":"","search":"","exclude":[],"sticky":"","inherit":false}} -->
<div class="wp-block-query">
Expand All @@ -74,7 +74,7 @@ function gutenberg_register_gutenberg_patterns() {
),
'query-grid-posts' => array(
'title' => _x( 'Grid', 'Block pattern title', 'gutenberg' ),
'blockTypes' => array( 'core/query' ),
'blockTypes' => array( 'core/query', 'core/post-content' ),
'categories' => array( 'query' ),
'content' => '<!-- wp:query {"query":{"perPage":6,"pages":0,"offset":0,"postType":"post","order":"desc","orderBy":"date","author":"","search":"","exclude":[],"sticky":"exclude","inherit":false},"displayLayout":{"type":"flex","columns":3}} -->
<div class="wp-block-query">
Expand Down
2 changes: 2 additions & 0 deletions packages/edit-post/src/components/layout/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ import SettingsSidebar from '../sidebar/settings-sidebar';
import MetaBoxes from '../meta-boxes';
import WelcomeGuide from '../welcome-guide';
import ActionsPanel from './actions-panel';
import StartPageOptions from '../start-page-options';
import { store as editPostStore } from '../../store';

const interfaceLabels = {
Expand Down Expand Up @@ -286,6 +287,7 @@ function Layout( { styles } ) {
<PreferencesModal />
<KeyboardShortcutHelpModal />
<WelcomeGuide />
<StartPageOptions />
<Popover.Slot />
<PluginArea onError={ onPluginAreaError } />
</>
Expand Down
216 changes: 216 additions & 0 deletions packages/edit-post/src/components/start-page-options/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,216 @@
/**
* WordPress dependencies
*/
import { Modal } from '@wordpress/components';
import { __ } from '@wordpress/i18n';
import { useState, useMemo, useEffect } from '@wordpress/element';
import {
store as blockEditorStore,
__experimentalBlockPatternsList as BlockPatternsList,
} from '@wordpress/block-editor';
import { useSelect, useDispatch } from '@wordpress/data';
import { useAsyncList } from '@wordpress/compose';
import { store as editorStore } from '@wordpress/editor';
import { store as coreStore } from '@wordpress/core-data';
import { parse } from '@wordpress/blocks';

/**
* Internal dependencies
*/
import { store as editPostStore } from '../../store';

function TemplateSelection( { onChooseTemplate } ) {
const { availableTemplates, fetchedTemplates, linkedTemplate } = useSelect(
( select ) => {
const {
getEditorSettings,
getCurrentPostType,
getCurrentPost,
} = select( editorStore );
const { getEntityRecords } = select( coreStore );

const currentPostType = getCurrentPostType();
const currentPostLink = getCurrentPost().link;

const templateRecords = getEntityRecords(
'postType',
'wp_template',
{
post_type: currentPostType,
per_page: -1,
}
);

const linkedTemplateRecords = getEntityRecords(
'postType',
'wp_template',
{
'find-template': currentPostLink,
per_page: 1,
}
);

return {
availableTemplates: getEditorSettings().availableTemplates,
fetchedTemplates: templateRecords,
linkedTemplate:
linkedTemplateRecords && linkedTemplateRecords[ 0 ],
};
},
[]
);
const templatesAsPatterns = useMemo( () => {
let templates = ( fetchedTemplates || [] ).filter(
( { slug } ) => !! availableTemplates[ slug ]
);
if (
linkedTemplate &&
! templates.some( ( { id } ) => id === linkedTemplate.id )
) {
templates = [ linkedTemplate, ...templates ];
}
return templates.map( ( template ) => ( {
name: template.id,
title: template.title.rendered,
blocks: parse( template.content.raw ),
template,
} ) );
}, [ availableTemplates, fetchedTemplates, linkedTemplate ] );
const shownPatterns = useAsyncList( templatesAsPatterns );
const { editPost } = useDispatch( editorStore );
useEffect( () => {
if ( availableTemplates.length <= 1 ) {
onChooseTemplate();
}
}, [ availableTemplates.length ] );
return (
<BlockPatternsList
blockPatterns={ templatesAsPatterns }
shownPatterns={ shownPatterns }
onClickPattern={ ( { template } ) => {
if ( template.id !== linkedTemplate.id ) {
editPost( { template: template.slug } );
}
onChooseTemplate();
} }
/>
);
}

function PatternSelection( { onChoosePattern } ) {
const { blockPatterns } = useSelect( ( select ) => {
const { __experimentalGetPatternsByBlockTypes } = select(
blockEditorStore
);
return {
blockPatterns: __experimentalGetPatternsByBlockTypes(
'core/post-content'
),
};
}, [] );
const shownBlockPatterns = useAsyncList( blockPatterns );
const { resetEditorBlocks } = useDispatch( editorStore );
useEffect( () => {
if ( blockPatterns.length <= 1 ) {
onChoosePattern();
}
}, [ blockPatterns.length ] );
return (
<BlockPatternsList
blockPatterns={ blockPatterns }
shownPatterns={ shownBlockPatterns }
onClickPattern={ ( _pattern, blocks ) => {
resetEditorBlocks( blocks );
onChoosePattern();
} }
/>
);
}

const START_PAGE_MODAL_STATES = {
INITIAL: 'INITIAL',
TEMPLATE: 'TEMPLATE',
PATTERN: 'PATTERN',
CLOSED: 'CLOSED',
};

export default function StartPageOptions() {
const [ modalState, setModalState ] = useState(
START_PAGE_MODAL_STATES.INITIAL
);
const shouldOpenModel = useSelect(
( select ) => {
if ( modalState !== START_PAGE_MODAL_STATES.INITIAL ) {
return false;
}
const {
getCurrentPostType,
getEditedPostContent,
getEditedPostAttribute,
isEditedPostSaveable,
} = select( editorStore );
const { isEditingTemplate, isFeatureActive } = select(
editPostStore
);
return (
getCurrentPostType() === 'page' &&
! isEditedPostSaveable() &&
'' === getEditedPostContent() &&
'' === getEditedPostAttribute( 'template' ) &&
! isEditingTemplate() &&
! isFeatureActive( 'welcomeGuide' )
);
},
[ modalState ]
);

useEffect( () => {
if ( shouldOpenModel ) {
setModalState( START_PAGE_MODAL_STATES.TEMPLATE );
}
}, [ shouldOpenModel ] );

if (
modalState === START_PAGE_MODAL_STATES.INITIAL ||
modalState === START_PAGE_MODAL_STATES.CLOSED
) {
return null;
}
return (
<Modal
className="edit-post-start-page-options__modal"
title={
modalState === START_PAGE_MODAL_STATES.TEMPLATE
? __( 'Choose a template' )
: __( 'Choose a pattern' )
}
closeLabel={ __( 'Cancel' ) }
onRequestClose={ () => {
switch ( modalState ) {
case START_PAGE_MODAL_STATES.TEMPLATE:
setModalState( START_PAGE_MODAL_STATES.PATTERN );
return;
case START_PAGE_MODAL_STATES.PATTERN:
setModalState( START_PAGE_MODAL_STATES.CLOSED );
}
} }
>
<div className="edit-post-start-page-options__modal-content">
{ modalState === START_PAGE_MODAL_STATES.TEMPLATE && (
<TemplateSelection
onChooseTemplate={ () => {
setModalState( START_PAGE_MODAL_STATES.PATTERN );
} }
/>
) }
{ modalState === START_PAGE_MODAL_STATES.PATTERN && (
<PatternSelection
onChoosePattern={ () => {
setModalState( START_PAGE_MODAL_STATES.CLOSED );
} }
/>
) }
</div>
</Modal>
);
}
27 changes: 27 additions & 0 deletions packages/edit-post/src/components/start-page-options/style.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.edit-post-start-page-options__modal {
// To keep modal dimensions consistent as subsections are navigated, width
// and height are used instead of max-(width/height).
@include break-small() {
width: calc(100% - #{ $grid-unit-20 * 2 });
height: calc(100% - #{ $header-height * 2 });
}
@include break-medium() {
width: $break-medium - $grid-unit-20 * 2;
}
@include break-large() {
height: 70%;
}
}

.edit-post-start-page-options__modal-content .block-editor-block-patterns-list {
display: grid;
grid-template-columns: 1fr 1fr;
grid-gap: $grid-unit-10;

.block-editor-block-patterns-list__list-item {
margin-bottom: 0;
.block-editor-block-preview__container {
min-height: 100px;
}
}
}
1 change: 1 addition & 0 deletions packages/edit-post/src/style.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
@import "./components/text-editor/style.scss";
@import "./components/visual-editor/style.scss";
@import "./components/welcome-guide/style.scss";
@import "./components/start-page-options/style.scss";

/**
* Animations
Expand Down