npm 包 wiki-plugin-transport 使用教程

在前端开发中，使用第三方库和工具是很常见的事情。npm是一个很好用的包管理工具，提供了大量的便利和选择。其中，wiki-plugin-transport就是一个非常优秀的工具，可以帮助前端开发者把wikimedia的组件和内容直接嵌入到自己的网站中。本文将详细介绍如何使用wiki-plugin-transport，同时包含一些实用的示例代码，希望对读者有所帮助。

什么是 wiki-plugin-transport

wiki-plugin-transport是一个npm包，其作用是帮助开发者在网站中嵌入wikimedia的组件和内容。Wikimedia是维基百科的运营组织，其拥有很多强大的组件和插件，如表格、搜索框、文件上传器等等。使用wiki-plugin-transport可以让开发者不用自己写这些组件，直接调用wikimedia提供的组件，节省了大量的时间和精力。

如何使用 wiki-plugin-transport

使用wiki-plugin-transport比较简单，只需要安装该包，然后在需要的位置直接调用相应的组件即可。具体步骤如下：

1.安装 wiki-plugin-transport

npm install wiki-plugin-transport --save

2.引入 wiki-plugin-transport

import WikiPluginTransport from 'wiki-plugin-transport';

3.使用 wiki-plugin-transport

wiki-plugin-transport提供了很多使用方式，这里只介绍比较常见的两种方式。

直接嵌入页面内容

const tag = `<wikiplugin-enable-parsoid></wikiplugin-enable-parsoid>
<wikiplugin-embeddedhtml height="500" width="500"><p>Hello Wolrd!</p></wikiplugin-embeddedhtml>`;
WikiPluginTransport.transform(tag, 'zh').then(html => {
  document.querySelector('#content').innerHTML = html;
});

在上面的代码中，我们嵌入了一个parsoid组件，和一个简单的HTML内容。其中，WikiPluginTransport.transform方法将组件和HTML内容转换成HTML字符串，然后将其插入到指定的dom节点。第二个参数'zh'则代表使用中文。

运行代码后，就可以在#content节点中看到嵌入的内容。

将结果作为函数返回值

const tag = `<wikiplugin-enable-parsoid></wikiplugin-enable-parsoid>
<wikiplugin-embeddedhtml height="500" width="500"><p>Hello Wolrd!</p></wikiplugin-embeddedhtml>`;
const html = await WikiPluginTransport.transform(tag, 'zh');
console.log(html);

在上面的代码中，我们将WikiPluginTransport.transform方法的返回值保存在变量中，然后做一些其它操作，比如打印返回的HTML字符串。这种方式常常用在需要对返回值进行操作的场景中。

wiki-plugin-transport 用例

下面我们将给出一些 wiki-plugin-transport 的用例，供读者参考。

在网站中添加搜索框

const tag = '<wikiplugin-search />';
const html = await WikiPluginTransport.transform(tag, 'zh');
document.querySelector('#search').innerHTML = html;

在上面的代码中，我们使用了wikimedia提供的搜索框，然后将其添加到了#search节点中。这样就可以直接在自己的网站中实现搜索功能了。

在网站中添加表格

const tag = '<table><tr><th>Header 1</th><th>Header 2</th></tr><tr><td>Value 1</td><td>Value 2</td></tr></table>';
const html = await WikiPluginTransport.transform(tag, 'zh');
document.querySelector('#table').innerHTML = html;

在上面的代码中，我们直接使用了HTML表格代码，然后通过调用wiki-plugin-transport生成了一个网页中可以直接运行的HTML表格。这可以帮助开发者快速生成一些简单的网页内容。

结语

本文详细介绍了如何使用 wiki-plugin-transport，同时给出了一些实用的示例代码。希望对大家在前端开发中使用第三方工具有所帮助。欢迎大家在评论区留言，分享自己的使用心得和技巧。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/wiki-plugin-transport