Page templates

Contents

Thus far, page rendering has been based on mappings, or editorially composing one page at a time. In this chapter you’ll learn how to make page templates - and reuse them across multiple content items.

Task: Movie details part

To complete this section, we’ll need one final part for listing movie details. The content type and content for movies already exists in Enonic, so lets get to work.

  1. Verify the Enonic app has the movie-details part descriptor - same procedure as before…​

    src/main/resources/cms/parts/movie-details/movie-details.yaml
    kind: "Part"
    title: "Movie Details"
    description: "Show details of a movie"
    form: [ ]
  2. Redeploy the Enonic app if you made any changes (happens automatically if you started enonic dev).

  3. Add the Movie query and view in Next.

    src/components/parts/MovieDetails.tsx
    import React from 'react';
    import type { ImageUrl, PageUrl } from '@enonic/nextjs-adapter';
    import {
        APP_NAME_UNDERSCORED,
        I18n,
        MetaData,
        PartProps,
        imageUrl,
        imageUrlQuery,
        pageUrl,
        pageUrlQuery,
    } from '@enonic/nextjs-adapter';
    import Link from 'next/link';
    
    
    export const getMovie = `
    query {
      guillotine(scopeKey: $scopeKey, branch: $branch, project: $project) {
        get(key: $path) {
          type
          displayName
          parent {
            _path
            ${pageUrlQuery()}
          }
          ... on ${APP_NAME_UNDERSCORED}_Movie {
            data {
              subtitle
              abstract
              trailer
              release
              photos {
                ... on media_Image {
                  ${imageUrlQuery({ scale: 'width(500)' })}
                  attachments {
                    name
                  }
                }
              }
              cast {
                character
                actor {
                  ... on ${APP_NAME_UNDERSCORED}_Person {
                    _path
                    ${pageUrlQuery()}
                    displayName
                    data {
                      photos {
                        ... on media_Image {
                          ${imageUrlQuery({ scale: 'block(200,200)' })}
                          attachments {
                            name
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }`;
    
    
    // Root component
    const MovieView = (props: PartProps) => {
        const data = props.data?.get.data as MovieInfoProps;
        const meta = props.meta;
        const {displayName, parent} = props.data.get;
        const href = pageUrl(parent?.pageUrl, meta);
        return (
            <>
                <div>
                    <h2>{displayName}</h2>
                    {data && <MovieInfo {...data} meta={meta}/>}
                    {data?.cast && <Cast cast={data.cast} meta={meta}/>}
                </div>
                {href &&
                 <p>
                     <Link href={href} data-content-path={parent?._path}>{I18n.localize('back')}</Link>
                </p>
                }
            </>
        );
    };
    
    export default MovieView;
    
    interface MovieInfoProps {
        meta: MetaData;
        release: string;
        subtitle: string;
        abstract: string;
        cast: CastMemberProps[],
        photos: {
            imageUrl: ImageUrl;
        }[];
    }
    
    // Main movie info: release year, poster image and abstract text.
    const MovieInfo = (props: MovieInfoProps) => {
        const posterSrc = imageUrl((props.photos || [])[0]?.imageUrl, props.meta);
        return (
            <>
                {props.release && (
                    <p>({new Date(props.release).getFullYear()})</p>
                )}
                {posterSrc && (
                    <img src={posterSrc}
                         title={props.subtitle}
                         alt={props.subtitle}
                    />
                )}
                <p>{props.abstract}</p>
            </>
        )
    }
    
    interface CastProps {
        cast: CastMemberProps[];
        meta: MetaData;
    }
    
    interface CastMemberProps {
        character: string;
        actor: {
            _path: string;
            pageUrl: PageUrl;
            displayName: string;
            data: {
                photos: {
                    imageUrl: ImageUrl;
                    attachments: {
                        name: string
                    }[]
                }[]
            }
        }
    }
    
    // List persons starring in the movie.
    const Cast = (props: CastProps) => (
        <div>
            <h4>Cast</h4>
            <ul style={{listStyle: "none", display: "flex", flexFlow: "row wrap"}}>
                {props.cast.map(
                    (person: CastMemberProps, i: number) => person && (
                        <CastMember key={i} {...person} meta={props.meta}/>
                    )
                )}
            </ul>
        </div>
    );
    
    
    const CastMember = (props: CastMemberProps & { meta: MetaData }) => {
        const { character, actor } = props;
        const { displayName, pageUrl: actorPageUrl, data, _path } = actor;
        const photoSrc = imageUrl((data.photos || [])[0]?.imageUrl, props.meta);
    
        return (
            <li style={{marginRight: "15px"}}>
                {
                    photoSrc &&
                    <img src={photoSrc}
                         title={`${displayName} as ${character}`}
                         alt={`${displayName} as ${character}`}/>
                }
                <div>
                    <p>{character}</p>
                    <p>
                        <Link href={pageUrl(actorPageUrl, props.meta)} data-content-path={_path}>
                            {displayName}
                        </Link>
                    </p>
                </div>
            </li>
        );
    }
  4. Update the component mappings:

    src/components/_mappings.ts
    import MovieDetails, {getMovie} from './parts/MovieDetails';
    
    // Part mappings
    ComponentRegistry.addPart(`${APP_NAME}:movie-details`, {
        query: getMovie,
        view: MovieDetails
    });

Task: Create template

With the new component registered, let’s put it to use.

  1. In Content Studio, select and edit your favorite movie (or choose "No time to deflate" if you have no favorites).

  2. Activate the context panel by pressing its icon in the top right screen corner, select Page in the widget dropdown, then Main in the Template dropdown, and add the Movie Details part to the page (drag Part from the Insert tab into the region and pick it in the part dropdown).

    movie details

    We now have a single movie nicely presented, but it would be cumbersome to manually configure each movie like this - page templates to the rescue.

  3. In the Page tab of the form on the left, select the page (root) component named Main.

    movie page

  4. Right click it and select Save as Template from the context menu.

    This will create a new page template content item, and open it in a new tab for editing.

  5. Give your template a better name, such as "Movie details" - the change is saved automatically. The template already supports the Movie content type.

    movie template

  6. Try visiting other movie items to verify they now automatically render.

    PS! Don’t forget to publish the changes and the new page template (both the movie and the template are Mark as ready → Publish now).

With templates sorted out, let’s dive into production mode and page revalidation.


Contents

Contents