配置项¶
Valine 支持两种不同的初始化方式。一种是构造方法初始化对象,另一种是调用init
方法:
<!-- 方法 1 --> <script> new Valine({ el:'#comment', appId:'your appid', appKey:'your appkey' }) </script> <!-- 方法 2 --> <script> var valine = new Valine(); valine.init({ el:'#comment', appId:'your appid', appKey:'your appkey' }) </script>
el¶
- 类型:
String
- 默认值:
#comment
- 必要性:
true
Valine 的初始化挂载器。可以是一个CSS 选择器
,也可以是一个实际的HTML元素
。
new Valine({ el:'#comment' }) // or new Valine({ el:document.getElementById('comment') })
Warning
在使用时,请保证该元素的唯一性。
appId¶
- 类型:
String
- 默认值:
null
- 必要性:
true
从LeanCloud
的应用中得到的appId
.
new Valine({ appId:'your leancloud appid' })
appKey¶
- 类型:
String
- 默认值:
null
- 必要性:
true
从LeanCloud
的应用中得到的appKey
.
new Valine({ appKey:'your leancloud appkey' })
region¶
- 类型:
String
- 默认值:
cn
- 必要性:
false
存储节点:在Valine
中初始化时默认遵循Leancloud SDK
的节点规则(默认中国大陆节点
),可选值:
cn
- 中国大陆节点us
- 海外节点
new Valine({ region:'cn' })
Info
可以先确认本地网络环境是否可以访问Leancloud服务器:ping "oip6cvm7.api.lncld.net"
该配置从v1.1.9-beta4
开始支持
placeholder¶
- 类型:
String
- 默认值:
null
- 必要性:
false
评论框占位提示符
。
new Valine({ placeholder:'Just so so' })
notify¶
- 类型:
Boolean
- 默认值:
false
- 必要性:
false
评论回复邮件提醒,请参考邮件提醒配置。
new Valine({ notify:false })
Warning
该功能目前处于测试阶段,请谨慎使用。
verify¶
- 类型:
Boolean
- 默认值:
false
- 必要性:
false
验证码服务。
new Valine({ verify:false })
path¶
- 类型:
String
- 默认值:
window.location.pathname
- 必要性:
false
当前文章页
路径,用于区分不同的文章页
,以保证正确读取该文章页
下的评论列表。可选值:
window.location.pathname
(默认值,推荐)window.location.href
自定义
Info
- I. 请保证每个
文章页
路径的唯一性,否则可能会出现不同文章页
下加载相同评论列表的情况。 - II. 如果值为
window.location.href
,可能会出现随便加不同参数
进入该页面,而被判断成新页面的情况。
new Valine({ path:window.location.pathname })
Info
该配置从v1.1.5+
开始支持
avatar¶
- 类型:
String
- 默认值:
mm
- 必要性:
false
Gravatar
头像展示方式。可选值:
''
(空字符串)mm
identicon
monsterid
wavatar
retro
hide
(v1.1.8-beta+
开始支持)
更多信息,请查看头像配置。
new Valine({ avatar:`mm` })
Info
该配置从v1.1.7+
开始支持
avatar_cdn¶
- 类型:
String
- 默认值:
https://gravatar.loli.net/avatar/
- 必要性:
false
Gravatar头像镜像,默认用的gravatar.loli.net
new Valine({ avatar_cdn:'https://gravatar.loli.net/avatar/' })
Info
该配置从v1.1.9-beta5+
开始支持
guest_info¶
- 类型:
Array
- 默认值:
['nick','mail','link']
- 必要性:
false
评论者相关属性。
new Valine({ guest_info:['nick'] // 只想要昵称 })
Info
该配置从v1.1.8-beta+
开始支持
pageSize¶
- 类型:
Number
- 默认值:
10
- 必要性:
false
评论列表分页,每页条数。
new Valine({ pageSize:10 })
Info
该配置从v1.1.8-beta2+
开始支持
lang¶
- 类型:
String
- 默认值:
zh-cn
- 必要性:
false
多语言支持,目前可选:
zh-cn
en
如需自定义语言,请参考i18n。
new Valine({ lang:'zh-cn' })
Info
该配置从v1.1.8-beta9+
开始支持