
【Hugo】APlayer +PJAX 引入音乐播放放器并实现音乐不中断功能
1 引入音乐播放器
(1)在博客主目录中创建文件
layouts\partials\footer\custom.html
,此文件为Stack主题作者留给我们加入自定义组件用的文件(可以查看主题源码同路径文件找到)(2)查看官方文档,引入对应的脚本,css到
custom.html
中,页面最下面就会出现音乐播放器
Copy
(3)修改 ap对象 配置,改成吸底模式
Copy
(4)填写 audio 数组,引入歌曲,封面和歌词
lrcType 的值具体看【文档】
歌曲,封面,歌词支持远程链接 or 本地路径
若想通过本地路径引入,请将资源文件放在
static
文件夹下,通过hugo方法{{ .Site.Home.Permalink }}
,获取网站主路径来拼接文件路径,进行引入
Copy
到这一步音乐播放器已经引入完了
2 音乐播放器样式切换
(1)通过阅读Stack主题的源码可以看到,主题样式的切换是通过
[data-scheme="light/darck"] {...}
(2)所以我们可以准备两种Aplayer的css,用
[data-scheme="light"]{ 亮的css样式 }
包裹亮的,用[data-scheme="dark"]{ 暗的css样式 }
包裹暗的,这里直接给各位准备好了aplayer-light.scss(Ctrl+S保存)
aplayer-dark.scss(Ctrl+S保存)
(3)在博客主目录中创建文件
assets\scss\custom.scss
,此文件为Stack主题作者留给我们加入自定义样式用的文件(可以查看主题源码同路径文件找到)(4)将上述两个scss文件放到跟 custom.scss同目录下,并通过
@import
来进行引入文件
Copy
(5)因为音乐播放器的css改为我们本地文件引入了,所以 custom.html 中的link标签可以将它注释掉或者删掉了
Copy
到这一步样式随主题切换已经完成了
3 音乐播放进度保留
(1)实现思路:页面切换前,把歌曲的 歌曲序号,播放时长,播放状态 记录下来;在页面切换加载完之后,我们调用Aplayer的接口切换歌曲,调整时长,并选择播放or暂停
(2)通过
console.log(ap)
打印ap对象,或者官方文档,可以找到我们需要的参数list.index:歌曲序号
audio.currentTime:播放时长
paused :播放状态(是否暂停)
(3)通过【官方文档】可以查找到我们需要调用的接口
ap.list.switch(index: number):切换歌曲
ap.seek(time: number):调整时长
ap.play():播放歌曲
(4)需要的东西已经找齐,只需在 custom.html 加入以下代码即可
Copy
到这一步音乐播放进行已经完成了
4 引入PJAX
PJAX已单独创建到一篇新的文章上 【Hugo】PJAX实现无刷新加载页面
后续相关问题将在新文章中更新,不会在此文章进行更新
⚠️建议直接看新文章来引入PJAX
4.1 基本引入
(1)PJAX主要分为两个版本,带JQuery 和 不带JQuery的,下面我演示的是不带JQuery版本的
【defunkt/jquery-pjax】(带JQuery)
【MoOx/pjax】(不带JQuery)
(2)分析页面元素,看哪些是需要我们重新加载的,可以发现是左侧边栏,中间内容,右侧边栏
(3)查看页面源代码,可以发现这些元素都被一个
<div class="main-container">...</div>
包裹着,所以我们将这元素定为要刷新的对象(4)根据官方文档,在 custom.html 加入以下代码来引入PJAX
Copy
这样算是已经基本引入了PJAX,但也带来了不少问题,我们一步一步进行修复
4.2 文章样式修复
(1)随便点进其中一篇文章,可以发现文章内容的样式丢失,缺少文章该有的边框
(2)通过手动刷新,对比页面元素发现,决定文章样式的是
<body>
标签中的class名: article-page,存在此class名就会识别到文章该有的css(3)因为
<body>
内包含整个页面的所有内容,包括我们的音乐播放器,所以不能让PJAX监听<body>
标签阅读官方文档发现,官方提供了数据预处理方法,让我们处理数据
我们通过预处理数据,获取到新页面的className,然后我们手动将这className设置到
<body>
上
Copy
这样我们切页面后,都会自动把body中的className更新,就不会丢失样式了
4.3 主题切换修复
(1)当我们切换页面后,点击左下角切换主题颜色的按钮,会发现没有效果,主题颜色切换失效了
(2)阅读Stack主题源码
\assets\ts\colorScheme.ts
发现,在脚本初始化时,会给元素绑定一个点击事件。但因为页面切换了,替换了该元素,但该元素没有重新绑定点击事件,导致点击主题切换失效(3)解决思路:在PJAX切换完页面后,重新执行一遍
colorScheme.ts
的初始化,使元素重新绑定点击事件。阅读源码,发现
colorScheme.ts
被main.ts
引用,在main.ts
中执行了初始化,并且main.ts
生成了个全局变量 Stack所以在PJAX执行完后,使用全局变量 Stack ,执行里面的初始化方法,重新执行一遍脚本,来绑定点击事件
阅读PJAX文档,发现官方也提供了PJAX执行完后的事件,我们执行监听这个事件,Stack 执行初始化就好
Copy
这样元素的点击事件重新绑定,主题颜色就能正常切换了
4.4 文章搜索修复
(1)使用文章搜索功能时,输入关键词,无任何搜索记录,搜索功能失效
(2)查看
layouts\ts\search.tsx
文件,发现情况和上面的colorScheme.ts
类似,存在绑定事件(3)解决思路类似上面的,把 search.tsx 初始化内容,封装为一个函数,并把函数 export 出来,由 main.ts 引入这个函数,并放到 Stack.init() 的方法中,利用此方法来重新初始化搜索脚本 - (以下操作请复制同路径同名文件到自己主目录下修改,不要在主题源码中修改)
Copy
Copy
(4)tsx 类型的文件引入方式有点特殊,需要我们修改以下 main.ts 的引入方式,修改
layouts\partials\footer\components\script.html
,改法参考layouts\page\search.html
,把"JSXFactory" "createElement"
补充上就好
这样search.tsx能正常初始化,文章搜索功能恢复
4.5 搜索内容跳转修复
(1)虽然文章搜索已经修复了,但搜索出来的内容并没有被PJAX识别到,导致PJAX没有拦截,进而导致页面刷新了
(2)阅读 search.tsx 源码可知,搜索内容的数据,是通过 React.render() ,动态渲染回页面的,这些动态数据没有被PJAX识别到。阅读PJAX文档,官方提供给了我们重新解析数据的方法,所以在 React.render() 之后,调用PJAX方法,重新解析页面即可
Copy
这样动态渲染出的页面数据就能被PJAX识别到,就不会刷新页面跳转了
4.6 文章评论修复
(1)如果博客有开启评论功能的话,会发现评论的脚本不生效了
(2)由于每个人使用的评论种类各不相同,所以这边也是简单说一下。PJAX官方文档也有说如何处理:
用一个
<div class=js-Pjax></div>
来包裹一个<script></script>
在
<script>
标签中,通过document.createElement('script')
形式,创建对应的评论脚本内容pjax对象通过 .js-Pjax 被识别到此内容,进行脚本执行
Copy
这样PJAX会自动加载我们的评论脚本
5 引入进度条
(1)由于使用了PJAX后,无法得知页面的加载情况是否完成,所以引入一个伪进度条,来显示页面内容进度
(2)前往【topbar】,点击下载zip包,将解压后的 topbar.min.js 放到
assets\js\topbar.min.js
(3)通过监听PJAX两个事件 pjax:send 和 pjax:complete 实现伪进度条
Copy
这样伪进度条就成功引入了,能大概知道页面的加载情况了