Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wordpress/wp-movies-demo

Demo of the Interactivity API
https://github.com/wordpress/wp-movies-demo

frontend-framework gutenberg wordpress

Last synced: 1 day ago
JSON representation

Demo of the Interactivity API

Awesome Lists containing this project

README 

        
# Interactivity API Demo - WP Movies



🎥 Live demo: [wpmovies.dev](https://wpmovies.dev)



https://user-images.githubusercontent.com/5417266/228688653-4af8bbae-0360-468e-a662-1a3998e62cb6.mp4



## What is this?



This is a demo plugin which shows the features of the [Interactivity API](https://make.wordpress.org/core/2024/03/04/interactivity-api-dev-note/).



The plugin is split into:



-   `/src/blocks/interactive`



    This folder contains all the custom interactive blocks used in the demo.



    **Follow this guide to understand how we built each interactive block with the Interactivity API:\

    [Movie Interactive Blocks](https://github.com/WordPress/wp-movies-demo/blob/main/docs/interactive-blocks/README.md)**



-   `/wp-movies-theme`



    The custom theme used in the demo. Contains some custom styling and the templates for the header & footer as well as the movie & actors pages.



-   `/lib`



    Helpers and support code for this demo. It's not relevant for understanding the Interactivity API.



## When will I be able to use the Interactivity API?



The Interactivity API is already [available in WordPress 6.5](https://make.wordpress.org/core/2024/03/04/interactivity-api-dev-note/).



## Setup



1. Install the required plugins:



    - If you use [`wp-env`](<[url](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/)>), run `npx wp-env start` to install the plugins automatically and run a local WP instance.

    - Otherwise, install the following plugins:

        - [Gutenberg](https://github.com/WordPress/gutenberg/releases/latest/download/gutenberg.zip)

        - [Movies Demo

          Plugin](https://github.com/WordPress/wp-movies-demo/releases/latest/download/wp-movies-plugin.zip)

          (this repo)



2. Install the dependencies and build the plugin:



    ```sh

    npm install && composer install

    npm run build

    ```



    If you plan on tinkering with the frontend code, start the webpack server which automatically rebuilds the files when you make any changes:



    ```sh

    npm start

    ```



3. Install & activate the theme:



    You need to install and activate the [Movies Demo Theme](https://github.com/WordPress/wp-movies-demo/releases/latest/download/wp-movies-theme.zip) (`/wp-movies-theme` in this repo). If you are using `wp-env`, it is already installed by default and you just have to activate it. You can run:



    ```sh

    npx wp-env run cli -- wp theme activate wp-movies-theme

    ```



4. Add the movie and actor data to the WordPress database:



    You can import the data manually:



    1. Go to **Tools > Import > WordPress** and click on _Run Importer_.

    2. Select the `wp_sampledata_movies.xml` file.

    3. Select the `Download and import file attachments` and click on the

       `Upload file and import`.

    4. Repeat the process for the `wp_sampledata_actors.xml` file.

    5. Repeat the process for the `wp_sampledata_media.xml` file. This one can take up to five minutes.



    If you are using `wp-env`, you can run the following commands:



    ```sh

    npx wp-env run cli -- wp plugin activate wordpress-importer

    npx wp-env run cli -- wp import wp-content/plugins/wp-movies-demo/wp_sampledata_movies.xml --authors=create

    npx wp-env run cli -- wp import wp-content/plugins/wp-movies-demo/wp_sampledata_media.xml  --authors=create

    npx wp-env run cli -- wp import wp-content/plugins/wp-movies-demo/wp_sampledata_actors.xml --authors=create

    ```



    If you run into any problems you can run `npx wp-env clean all` and start this step over again.



5. Set the permalinks to use the `Post name` in **Settings > Permalinks**.



    If you are using `wp-env` you can just run this command:



    ```sh

    npx wp-env run cli -- wp rewrite structure '/%postname%/'

    ```



6. Enable the **Full-page client-side navigation** in the **Gutenberg > Experiments**.



## Things to try



### Full-page client-side navigation



When enabled, the lists of movies and actors will paginate without doing a full page refresh. You can enable this behavior in your WordPress admin page in **Gutenberg > Experiments**.



Click around to the next/previous page of the movies or actors: the list is loaded without a delay. This is because the HTML for that page is prefetched ahead of time, and only the nodes that are different between the current page and the next page are updated.



### Add to favourites



When you add a movie to favourites notice how the number of movie likes is preserved when navigating to another page. In addition to client-side navigations, the Interactivity API uses a smart DOM diffing algorithm. This allows the interactive state of blocks on the current page to be preserved!



### Instant search



Try searching for movies or actors. The search results are rendered dynamically on the server!



### Remove the Search template



Try opening the site editor and removing the "Search" template. You'll notice that the Search experience keeps working but that now the Search results look different. That's because in the absence of the Search template, the Archive template is being used. The Interactivity API is designed to work with the server-rendered markup and Full Site Editing.



### Play the movie trailers



When you navigate to the page for a movie, you can play its trailer. If you have the full-page client-side navigation [enabled](#client-side-navigations-and-pagination), you'll notice that the trailer will keep playing as you keep navigating around the site!



## Credits



Powered by [WordPress](https://wordpress.org/) and [TMDb](https://www.themoviedb.org/).