YingXingAI/node_modules/mp-html/docs/basic/prop.md

142 lines
5.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🔨 属性 :id=prop
!> 需要将某个属性设置为 *false* 时,应写作 *attr="{{false}}"*
## container-style
?> [2.1.0](changelog/changelog#v210) 版本起支持
功能:设置容器的样式
类型:*String*
示例:
```css
padding: 5px; /* 设置内边距 */
font-size: 18px; /* 设置默认的字体大小 */
overflow: hidden; /* 禁用横向滚动 */
display: inline; /* 行内显示 */
white-space: pre-wrap; /* 保留空格和换行符 */
white-space: pre-line; /* 保留换行符 */
```
## content
功能:用于渲染的 *html* 字符串
类型:*String*
## copy-link
功能:是否允许外部链接被点击时自动复制
类型:*Boolean*
默认值:*true*
?> 对于 *uni-app**h5**app* 平台,外链是能够直接跳转的,这种情况下如果该属性为 *true* 则直接跳转外链(而不是复制链接),为 *false* 则不跳转
## domain
功能:主域名(用于链接拼接)
类型:*String*
示例:
```html
<!-- 假设 domain 属性被设置为 https://example.com
以下链接均会被拼接为 https://example.com/path -->
<img src="//example.com/path" />
<img src="/path" />
<div style="background-image:url('path')"></div>
```
?> 通过 *base* 标签也可以设置主域名,但优先级低于此属性
!> 该属性必须填写 协议名://域名 的完整链接
暂不支持拼接含有 *../* 的相对路径链接
*a* 标签的 *href* 属性可能需要跳转到小程序内路径,因此不进行 *domain* 拼接
设置该属性后将无法使用本地图片
## error-img
功能:图片出错时的占位图链接
类型:*String*
!> 该属性不会进行拼接 [domain](#domain),需传入完整路径(可以使用本地路径)
## lazy-load
功能:是否开启图片懒加载
类型:*Boolean*
默认值:*false*
?> 不同平台懒加载的时机不同,具体参考各平台 *image* 组件懒加载的时机
## loading-img
功能:图片加载过程中的占位图链接
类型:*String*
!> 该属性不会进行拼接 [domain](#domain),需传入完整路径(可以使用本地路径)
## pause-video
功能:是否在播放一个视频时自动暂停其他视频
类型:*Boolean*
默认值:*true*
?> 如果需要多个视频同时播放的,请将此属性设置为 *false*
## preview-img
功能:是否允许图片被点击时自动预览
类型:*Boolean*
默认值:*true*
?> 自动预览允许左右滑动查看所有图片,如果不希望如此可以禁用自动预览并在 [imgtap](basic/event#imgtap) 事件中自行处理
!> 默认情况下 *base64* 图片无法点击预览,[2.5.0](changelog/changelog#v250) 版本起支持将本属性设置为 *"all"* 开启 *base64* 图片的预览,但需要注意各平台 *previewImage**api**base64* 图片支持度不高,需充分测试后使用,如果无法预览,可参考 [imgList](advanced/api#imgList) 中的方法进行转存
## scroll-table
功能:是否给每个表格添加一个滚动层使其能单独横向滚动
类型:*Boolean*
默认值:*false*
!> 如果表格设置了 *inline* 布局,该属性将不会生效以免破坏行内布局
## selectable
功能:是否开启文本长按复制
类型:*Boolean* / *String*
默认值:*false*
!> 将本属性的值设置为 *true* 在微信 *iOS* 端可能失效,[2.0.5](changelog/changelog#v205) 版本起支持将本属性设置为 "*force*" 来支持,但会带来以下影响:
1、所有文本块会显示为 *inline-block*(通过 [text](https://developers.weixin.qq.com/miniprogram/dev/component/text.html) 标签的 *user-select* 属性实现),需要自行适配
2、文字下划线、删除线等效果将失效[详细](https://github.com/jin-yufeng/mp-html/issues/382)
3、所有文本块都无法被 *rich-text* 包含,一定程度上增加标签数,减慢渲染速度
从 [2.3.1](changelog/changelog#v231) 版本起对此问题进行优化(通过 [rich-text](https://developers.weixin.qq.com/miniprogram/dev/component/rich-text.html) 标签的 *user-select* 属性实现,基础库 *2.24.0* 及以上生效),第 *3* 个问题已解决,第 *1*、*2* 个问题部分情况下还会存在
## set-title
功能:是否将 *title* 标签的内容设置到页面标题
类型:*Boolean*
默认值:*true*
## show-img-menu
?> [2.3.0](changelog/changelog#v230) 版本起支持控制预览时是否长按显示菜单(仅微信、百度小程序有效)
功能:是否允许图片被长按时显示菜单
类型:*Boolean*
默认值:*true*
!> 该属性目前仅微信、百度和 *uni-app**app* 平台有效
## tag-style
功能:设置标签的默认样式
类型:*Object*
示例:
```javascript
// 格式为 标签名: 样式
{
a: 'color:red' // a 标签默认为红色
}
```
?> 该属性非响应式,需要在设置 [content](#content) 属性前设置才能生效,动态修改不能实时生效
!> 该属性的原理是解析到各标签的内联 *style* 属性中去,如果对特别常用的标签设置默认样式,将大大加大解析结果大小,减慢渲染速度,这种情况下建议通过 [外部样式](overview/quickstart#setting) 引入
## use-anchor
功能:是否使用锚点链接
类型:*Boolean* / *Number*
默认值:*false*
?> 传入一个数字时表示跳转锚点的偏移量(单位 *px*
?> 开启该属性会将所有设置了 *id* 属性的标签都暴露出来,一定程度上减慢渲染速度,非必要不要开启