Wordpress Gutenberg:前端的React组件

时间:2018-08-09 15:41:40

标签: wordpress reactjs wordpress-gutenberg gutenberg-blocks

古腾堡(Gutenberg)仍然很新,但我仍然希望有人遇到此问题并找到解决方案。

我使用create-guten-block来制作一个项目并创建一个测试块。我遇到的问题是,当我尝试使用React组件修改前端的状态时,什么都没有发生。组件可以通过save()很好地加载,但是当您尝试做一些简单的事情(如切换列表)时,前端仍然无法响应状态更改。我还要注意,create-guten-block不会加载任何前端JS,因此我交换了已编译的javascript以加载到前端,但是仍然无法使其正常工作。

以下是我从Codecademy提取的一些代码,可以作为一个简单的示例进行测试。选择名称时,它将更改sibling.js中的文本以显示名称。该代码在create-react-app中可以正常工作,但作为Gutenberg中的块,在前端没有任何作用:

block.js

import { Parent } from './parent';

// More code here 

save: function( props ) {
    return (
          <div>
              <Parent />
          </div>
     );
 },

parent.js

import React from 'react';
import { Child } from './child';
import { Sibling } from './sibling';

export class Parent extends React.Component {
    constructor(props) {
        super(props);

        this.state = { name: 'Frarthur' };

        this.changeName = this.changeName.bind(this);
    }

    changeName(newName) {
        this.setState({
        name: newName
        });
    }

    render() {
        return (
        <div>
            <Child onChange={this.changeName} />
            <Sibling name={this.state.name} />
        </div>
        );
    }
};

child.js

import React from 'react';

export class Child extends React.Component {
    constructor(props) {
        super(props);

        this.handleChange = this.handleChange.bind(this);
    }

    handleChange(e) {
        const name = e.target.value;
        this.props.onChange(name);
    }

    render() {
        return (
        <div>
            <select
            id="great-names"
            onChange={this.handleChange}>

                <option value="Frarthur">Frarthur</option>
                <option value="Gromulus">Gromulus</option>
                <option value="Thinkpiece">Thinkpiece</option>
            </select>
        </div>
        );
    }
}

sibling.js

import React from 'react';

export class Sibling extends React.Component {
    render() {
        const name = this.props.name;
        return (
        <div>
            <h1>Hey, my name is {name}!</h1>
            <h2>Don't you think {name} is the prettiest name ever?</h2>
            <h2>Sure am glad that my parents picked {name}!</h2>
        </div>
        );
    }
}

2 个答案:

答案 0 :(得分:3)

古腾堡(Gutenberg)很棒,但是其文档不能说同样的话。就像其他任何Wordpress文档一样,它过于冗长,组织混乱和健谈。我认为这与领土和目标消费者有关。

我花了一些时间和几本手册来理解什么是块。资源稀缺,人们通常将块与它们在编辑器中的屏幕视觉表示混淆。

话虽如此,让我们从古腾堡块开始。古腾堡块是这样的优美的短代码:

<!-- wp:paragraph {"key": "value"} -->
<p>Welcome to the world of blocks.</p>
<!-- /wp:paragraph -->

这些短代码由编辑器呈现为react组件以进行可视化表示。

在这里记住这样的短代码[gallery id="123" size="medium"],这些短代码可以通过tinymce插件呈现为可视化表示,您将在编辑器窗口中看到功能完整的画廊。想法是一样的,只是这次古腾堡(Gutenberg)编辑器将略有不同的短代码呈现为视觉表示。

现在,由于WordPress文档也将这些视觉表示也作为块来处理,因此产生了混乱。但是整个渲染-序列化-解析-重新渲染周期的真相是其中之一,那就是所谓的“优美的短代码”,其余是这些短代码采用的不同形式和表示形式。说,在编辑器上下文中,它是一个呈现的react组件,在前端它只是常规的html。

edit函数的返回元素将确定块在编辑器窗口中的显示方式:

<!-- language: lang-js -->
registerBlockType(«NAMESPACE/BLOCK_NAME», {
    edit: function(props){
        // Should return a react element
    }
})

了解区块的生命周期以更好地了解它们至关重要。让我们从头开始:

当您在组件面板中单击一个块图标时,save函数的返回将被渲染并序列化并插入到页面中。

<!-- language: lang-js -->
registerBlockType("NAMESPACE/BLOCK_NAME", {
    save: function(props){
       // Should return a react element
    }
})

save函数应该返回一个react元素,该元素将由react渲染,并由块序列化器进行 serialized ,并以block的形式插入到帖子内容中。您可以检查serializer.js以了解React元素如何序列化成一个块 1

<!-- wp:image -->
<figure class="wp-block-image"><img src="source.jpg" alt="" /></figure>
<!-- /wp:image -->

如果它是动态块,则save函数将返回null,因此将没有内容。块看起来像这样:

<!-- wp:latest-posts {"postsToShow":4,"displayPostDate":true} /-->

注意自我结束评论:

blocks grammar中,第一个称为静态块(_Block_Balanced_),第二个称为动态块(_Block_Void _)。

请务必注意,静态块包含渲染的内容和属性对象。对于动态块,应在块注册期间将render_callback提供给register_block_type函数。

因此,当请求the_content时,服务器将获得the_content并将其传递给多个filters,然后再响应请求。

在此阶段,由于静态块已经具有其内容,因此将从静态块中剥离属性并返回内容。对于动态块,将调用render_callback并将其返回值作为块内容返回。这就是文档中某种程度上完全同构的 3 的意思。您可以在Wordpress核心中签出render_block功能。

当您通过gutenberg的视觉元素编辑该图块时,该图块将重新进行重新序列化过程,并根据您所做的更改在页面上绘制一个新的视觉表示。

<!-- wp:paragraph {"key": "value"} -->
<p>Welcome to the world of blocks.</p>
<!-- /wp:paragraph -->

单击发布按钮后,如文档所述,此序列化数据或行数据将保存到数据库中。

假设您保存后关闭页面。下次打开它时,已保存的块将由块解析器解析,并且可视化表示将绘制到页面上。您可以看一下解析器 2

在解析期间,将根据save函数验证块标记。如果您在两次编辑之间更改了save函数的返回值,则先前保存的块标记将无效或deprecated。您可以通过在registerBlockType的阻止设置中提供升级路径来更新不赞成使用的代码。但是,您无需更改就可以更改edit函数,因为它控制了块在编辑器屏幕上的显示方式。

升级路径只是具有功能和属性的对象的数组。此数组上的每个元素将根据优先级检查已弃用的块,如果块与新版本兼容,则将迁移该块;否则,将返回旧版本。

现在问您一个问题,当请求前端服务器上的页面时,将向您发送格式完整的html。因此,从正面看,您获得的是静态html,而不是react元素。

因此,实际上save函数与front无关。从前端角度看,创建the_content时是使用tinymce编辑器还是Gutenberg编辑器还是纯HTML都没有什么区别。

为了增加交互性,您必须像在Gutenberg之前一样专门针对前端编写代码。

注册块时,由您决定是否排入另一个javascript文件或使用通过enqueue_block_assets排入的文件。

要使用React,您必须使用ReactDOM将组件安装到文档上。不错的是,Wordpess已经在全局空间中提供了React和ReactDOM,但是您在排队脚本时需要指出依赖性。

答案 1 :(得分:1)

据我了解,古腾堡只支持方程式 editor 上的交互性。是的,您在React中定义了 view 端,但是在保存帖子时,该视图将呈现为静态标记,然后仅将此静态标记传递给客户端(读者)。

好处是您可以免费获得“服务器端渲染”,并且您的客户端不需要React即可查看帖子。不利的一面是,如果您想进行客户端交互,这超出了Gutenburg的范围,那么您必须找到自己的方式。