Skip to content

U
unidocs-zh

程序yang / unidocs-zh
与 Fork 源项目一致

Fork自 DCloud / unidocs-zh

通知 1
Star 1
Fork 0
U
unidocs-zh
提交 6ab1227a 编写于 作者: DCloud_JSON's avatar DCloud_JSON
浏览文件
操作

Merge branch 'master' of https://gitee.com/dcloud/unidocs-zh

上级 f5178c50 780358c2
隐藏空白更改
内联 并排
Showing with 201 addition and 169 deletion
docs/api/getEnterOptionsSync.md
浏览文件 @ 6ab1227a
### uni.getEnterOptionsSync()
#### App、web 端
获取启动时的参数。返回值与App.onLaunch的回调参数一致
#### 小程序端
获取本次启动时的参数。如果当前小程序是冷启动，则返回值与 App.onLaunch 的回调参数一致；如果当前是热启动，则返回值与 App.onShow 一致。
关于微信小程序冷启动热启动的概念，[详见](https://developers.weixin.qq.com/miniprogram/dev/framework/runtime/operating-mechanism.html)
......
docs/component/uniui/uni-data-select.md
浏览文件 @ 6ab1227a
......@@ -90,8 +90,8 @@ export default {
| 属性名 | 类型 | 可选值 | 默认值 | 说明 |
| :-----------: | :-----------: | :----: | :------: | :-----------------------------------------------------------------: |
| value/v-model | String/Number | - | - | 默认值，multiple=true 时为 Array 类型，否则为 String 或 Number 类型 |
| localdata | Array | - | - | 本地渲染数据， |
| value/v-model | String/Number | - | - | 已选择数据的 value 值 |
| localdata | Array | - | - | 本地渲染数据 |
| clear | Boolean | - | - | 是否可以清空已选项 |
| label | String | | | 左侧标题 |
| placeholder | String | - | 请选择 | 输入框的提示文字 |
......
docs/component/uniui/uni-table.md
浏览文件 @ 6ab1227a
::: tip 组件名：uni-table
> 代码块： `uTable`
[点击下载&安装](https://ext.dcloud.net.cn/plugin?name=uni-table)
:::
用于展示多条结构类似的数据
## 介绍
### 基本用法
表格是由4个组件： `uni-table`表格组件、`uni-tr`表格行 、`uni-th` 表格头、`uni-td` 单元格组成
需要注意的是：
- `uni-table` 的根节点一定是 `uni-tr`
- `uni-tr` 的根节点一定是 `uni-th` 或者 `uni-td`
- 一个表格内理论上只能包含表头行
- 目前只能在 `uni-th` 中设置 width 属性，`uni-td` 的宽度跟随 `uni-th` 宽度变化
```html
<uni-table border stripe emptyText="暂无更多数据" >
<!-- 表头行 -->
<uni-tr>
<uni-th align="center">日期</uni-th>
<uni-th align="center">姓名</uni-th>
<uni-th align="left">地址</uni-th>
</uni-tr>
<!-- 表格数据行 -->
<uni-tr>
<uni-td>2020-10-20</uni-td>
<uni-td>Jeson</uni-td>
<uni-td>北京市海淀区</uni-td>
</uni-tr>
<uni-tr>
<uni-td>2020-10-21</uni-td>
<uni-td>HanMeiMei</uni-td>
<uni-td>北京市海淀区</uni-td>
</uni-tr>
<uni-tr>
<uni-td>2020-10-22</uni-td>
<uni-td>LiLei</uni-td>
<uni-td>北京市海淀区</uni-td>
</uni-tr>
<uni-tr>
<uni-td>2020-10-23</uni-td>
<uni-td>Danner</uni-td>
<uni-td>北京市海淀区</uni-td>
</uni-tr>
</uni-table>
```
## API
### Table Props
|属性名| 类型|默认值| 可选值| 说明|
|:-:| :-:|:-:| :-:| :-: |
|border| Boolean| false| -| 是否带有纵向边框 |
|stripe| Boolean| true| -| 是否显示斑马线样式 |
|type| String| ''| -| 值为type="selection" 时开启多选|
|emptyText | String| 没有更多数据| -| 空数据时显示的文本内容|
|loading| Boolean| false| -| 显示加载中|
### Table Events
|事件称名|说明| 返回参数 |
|:-:|:-:| :-: |
|selection-change| 开启多选时，当选择项发生变化时会触发该事件 | Function(Object)|
### Table Methods
**Tips: 因微信小程序框架问题，暂不支持如下方法**
|方法称名|说明|参数|
|:-:|:-:|:-:|
|selectionAll|选中全部行 |- |
|toggleRowSelection |用于多选表格，切换某一行的选中状态，如果使用了第二个参数，则是设置这一行选中与否（selected 为 true 则选中） | Function(Array:[行索引],Boolean:selected) |
|clearSelection |用于多选表格，清空用户的选择 |- |
|toggleAllSelection |用于多选表格，切换所有行的选中状态 |- |
### Th Props
|属性名|类型|默认值|可选值|说明|
|:-:|:-: |:-:| :-:|:-:|
|width|String | -|-| 单元格宽度|
|align|String | left|left/center/right| 表头对齐方式|
|filter-type|String ||search/select/range/date | 筛选类型，search关键字搜索，select类别选择|
|filter-data|Array ||| 筛选数据|
|sortable |Boolean| false|- | 是否启用排序|
**filter-data 示例**
```json
[{
text: "", //显示
value: "" // 值
}]
```
### Th Events
|事件称名 |说明 | 返回参数 |
|:-: |:-: | :-: |
||sort-change | 点击排序时会触发该事件 | Function(Object)|
||filter-change | 筛选数据时会触发该事件 | Function(Object)|
filter-change(e) 说明
```json
e = {
filterType: "", //筛选类型 search/select/range 和传入的相同
filter: "" // 值, filterType=search字符串类型，filterType=select数组类型，filterType=range数组类型，[0]开始值， [1]结束值
}
```
### Td Props
|属性名 |类型 |默认值 |可选值 |说明|
|:-: |:-: |:-: |:-: |:-:|
|align |String | left |left/center/right | 单元格对齐方式|
## 示例
::: warning 注意
示例依赖了 `uni-card` `uni-section` `uni-scss` 等多个组件，直接拷贝示例代码将无法正常运行 。
请到 [组件下载页面](https://ext.dcloud.net.cn/plugin?name=uni-table) ，在页面右侧选择 `使用 HBuilderX导入示例项目` ，体验完整组件示例。
:::
::: preview https://hellouniapp.dcloud.net.cn/pages/extUI/table/table
> Template
``` html
::: tip 组件名：uni-table
> 代码块： `uTable`
[点击下载&安装](https://ext.dcloud.net.cn/plugin?name=uni-table)
:::
用于展示多条结构类似的数据
## 介绍
### 基本用法
表格是由4个组件： `uni-table`表格组件、`uni-tr`表格行 、`uni-th` 表格头、`uni-td` 单元格组成
需要注意的是：
- `uni-table` 的根节点一定是 `uni-tr`
- `uni-tr` 的根节点一定是 `uni-th` 或者 `uni-td`
- 一个表格内理论上只能包含表头行
- 目前只能在 `uni-th` 中设置 width 属性，`uni-td` 的宽度跟随 `uni-th` 宽度变化
```html
<uni-table border stripe emptyText="暂无更多数据" >
<!-- 表头行 -->
<uni-tr>
<uni-th align="center">日期</uni-th>
<uni-th align="center">姓名</uni-th>
<uni-th align="left">地址</uni-th>
</uni-tr>
<!-- 表格数据行 -->
<uni-tr>
<uni-td>2020-10-20</uni-td>
<uni-td>Jeson</uni-td>
<uni-td>北京市海淀区</uni-td>
</uni-tr>
<uni-tr>
<uni-td>2020-10-21</uni-td>
<uni-td>HanMeiMei</uni-td>
<uni-td>北京市海淀区</uni-td>
</uni-tr>
<uni-tr>
<uni-td>2020-10-22</uni-td>
<uni-td>LiLei</uni-td>
<uni-td>北京市海淀区</uni-td>
</uni-tr>
<uni-tr>
<uni-td>2020-10-23</uni-td>
<uni-td>Danner</uni-td>
<uni-td>北京市海淀区</uni-td>
</uni-tr>
</uni-table>
```
## API
### Table Props
|属性名| 类型|默认值| 可选值| 说明|
|:-:| :-:|:-:| :-:| :-: |
|border| Boolean| false| -| 是否带有纵向边框 |
|stripe| Boolean| true| -| 是否显示斑马线样式 |
|type| String| ''| -| 值为type="selection" 时开启多选|
|emptyText | String| 没有更多数据| -| 空数据时显示的文本内容|
|loading| Boolean| false| -| 显示加载中|
### Table Events
|事件称名|说明| 返回参数 |
|:-:|:-:| :-: |
|selection-change| 开启多选时，当选择项发生变化时会触发该事件 | Function(Object)|
### Table Methods
**Tips: 因微信小程序框架问题，暂不支持如下方法**
|方法称名|说明|参数|
|:-:|:-:|:-:|
|selectionAll|选中全部行 |- |
|toggleRowSelection |用于多选表格，切换某一行的选中状态，如果使用了第二个参数，则是设置这一行选中与否（selected 为 true 则选中） | Function(Array:[行索引],Boolean:selected) |
|clearSelection |用于多选表格，清空用户的选择 |- |
|toggleAllSelection |用于多选表格，切换所有行的选中状态 |- |
### Th Props
|属性名|类型|默认值|可选值|说明|
|:-:|:-: |:-:| :-:|:-:|
|width|String | -|-| 单元格宽度|
|align|String | left|left/center/right| 表头对齐方式|
|filter-type|String ||search/select/range/date | 筛选类型，search关键字搜索，select类别选择|
|filter-data|Array ||| 筛选数据|
|sortable |Boolean| false|- | 是否启用排序|
**filter-data 示例**
```json
[{
text: "", //显示
value: "" // 值
}]
```
### Th Events
|事件称名 |说明 | 返回参数 |
|:-: |:-: | :-: |
|sort-change | 点击排序时会触发该事件 | Function(Object)|
|filter-change | 筛选数据时会触发该事件 | Function(Object)|
filter-change(e) 说明
```json
e = {
filterType: "", //筛选类型 search/select/range 和传入的相同
filter: "" // 值, filterType=search字符串类型，filterType=select数组类型，filterType=range数组类型，[0]开始值， [1]结束值
}
```
### Td Props
|属性名 |类型 |默认值 |可选值 |说明|
|:-: |:-: |:-: |:-: |:-:|
|align |String | left |left/center/right | 单元格对齐方式|
## 示例
::: warning 注意
示例依赖了 `uni-card` `uni-section` `uni-scss` 等多个组件，直接拷贝示例代码将无法正常运行 。
请到 [组件下载页面](https://ext.dcloud.net.cn/plugin?name=uni-table) ，在页面右侧选择 `使用 HBuilderX导入示例项目` ，体验完整组件示例。
:::
::: preview https://hellouniapp.dcloud.net.cn/pages/extUI/table/table
> Template
``` html
<template>
<view>
<view class="uni-container">
......@@ -165,8 +165,8 @@ e = {
</view>
</view>
</template>
```
> Script
```
> Script
```html
<script>
import tableData from './tableData.js'
......@@ -204,7 +204,7 @@ export default {
},
// 分页触发
change(e) {
this.$refs.table.clearSelection()
this.$refs.table.clearSelection()
this.selectedIndexs.length = 0
this.getData(e.current)
},
......@@ -257,24 +257,24 @@ export default {
}
}
</script>
```
> Style
```
> Style
```html
<style>
/* #ifndef H5 */
/* page {
padding-top: 85px;
} */
/* #endif */
.uni-group {
display: flex;
align-items: center;
/* #endif */
.uni-group {
display: flex;
align-items: center;
}
</style>
```
> tableData.js
```javascript
</style>
```
> tableData.js
```javascript
export default [{
"date": "2020-09-01",
"name": "Dcloud1",
......@@ -467,9 +467,9 @@ export default [{
"date": "2020-09-16",
"name": "Dcloud48",
"address": "上海市普陀区金沙江路 1516 弄"
}]
```
:::
}]
```
:::
[完整示例演示](https://hellouniapp.dcloud.net.cn/pages/extUI/table/table)
\ No newline at end of file
docs/uniCloud/cf-callfunction.md
浏览文件 @ 6ab1227a
......@@ -125,7 +125,6 @@ context对象的属性清单如下：
|SOURCE |string |云函数调用来源 [详见](?id=context-source) |
|FUNCTION_NAME |string |获取云函数名称 |
|FUNCTION_TYPE |string |获取云函数类型，对于云函数来说，这里一定会返回`cloudfunction`，新增于HBuilderX 3.5.1。 |
|FUNCTION_RUNTIME_VERSION |string |云函数sdk版本，本地调试时随HBuilderX版本变动，云端一直保持和最新HBuilderX一致（无论本地版本多少，云端只有一个最新版本的云函数sdk）。新增于HBuilderX 3.5.1 |
|CLIENTIP |string |客户端IP。如果调用来源是其他服务器，会返回调用方的ip |
|CLIENTUA |string |客户端userAgent。注意非本地运行环境下客户端getSystemInfoSync也会获取ua参数并上传给云函数，但是云函数会从http请求头里面获取ua而不是clientInfo里面的ua |
|uniIdToken |string |客户端uni-id token字符串，新增于HBuilderX 3.5.1。 |
......
docs/uniCloud/cf-functions.md
浏览文件 @ 6ab1227a
......@@ -289,6 +289,18 @@ errMsg用于存放具体错误信息，包括展示给开发者、终端用户
|uniCloud.init() |获取指定服务空间的uniCloud实例 [详见](uniCloud/concepts/space.md?id=multi-space) |
|uniCloud.logger |云函数中打印日志到[uniCloud web控制台](https://unicloud.dcloud.net.cn/)的日志系统（非HBuilderX控制台）[详情](rundebug.md?id=uniCloudlogger) |
## 错误对象@uni-cloud-error
云函数调用uniCloud接口时（包括请求云函数、云对象、云存储等）可能存在抛出错误的场景，此时会抛出uniCloud标准的错误对象（以下记为uniCloudError），uniCloudError包含以下属性
|属性 |类型 |必备 |说明 |
|-- |-- |-- |-- |
|errCode |string |是 |错误码 |
|errMsg |string |是 |错误信息 |
|requestId |string |否 |请求Id，用于排查错误 |
|detail |object |否 |仅云对象主动返回错误对应的响应体规范时会有此属性 |
另外uniCloudError对象上还有code属性和message属性，两者均不推荐使用。
## 访问数据库
......@@ -425,6 +437,7 @@ uniCloud的api中，有些api对应的实现，其代码体积较大，且这些
- redis扩展库[uni-cloud-redis]：云函数内使用redis，详见：[redis扩展库](uniCloud/redis.md)
- 发送短信扩展[uni-cloud-sms]：云函数中发送短信，详见：[sms扩展](uniCloud/send-sms?id=extension)
- 一键登录API扩展[uni-cloud-verify]：手机App调用运营商一键登陆服务时，云函数中获取到真实手机号， 详见：[一键登陆扩展库](uniCloud/univerify?id=extension)
- 统一推送服务扩展库[uni-cloud-push]：云函数内使用uni-push，详见：[uniCloud/uni-cloud-push/api]
以下是一个开启了redis扩展库的云函数package.json示例，注意此文件不支持注释，下方示例中的注释仅为演示
......
docs/uniCloud/client-sdk.md
浏览文件 @ 6ab1227a
......@@ -371,4 +371,17 @@ uniCloud.offNeedLogin(log)
用法：`uniCloud.config.provider`
访问此属性会返回`tencent`、`aliyun`分别代表腾讯云和阿里云
\ No newline at end of file
访问此属性会返回`tencent`、`aliyun`分别代表腾讯云和阿里云
## 错误对象@uni-cloud-error
客户端请求云端时（包括请求云函数、云对象、clientDB、云存储等）可能存在抛出错误的场景，此时会抛出uniCloud标准的错误对象（以下记为uniCloudError），uniCloudError包含以下属性
|属性 |类型 |必备 |说明 |
|-- |-- |-- |-- |
|errCode |string |是 |错误码 |
|errMsg |string |是 |错误信息 |
|requestId |string |否 |请求Id，用于排查错误 |
|detail |object |否 |仅云对象主动返回错误对应的响应体规范时会有此属性 |
另外uniCloudError对象上还有code属性和message属性，两者均不推荐使用。
docs/uniCloud/cloud-obj.md
浏览文件 @ 6ab1227a
......@@ -310,7 +310,6 @@ module.exports = {
// cloudInfo = {
// provider,
// spaceId,
// functionRuntimeVersion,
// functionName,
// functionType,
// }
......@@ -324,7 +323,6 @@ module.exports = {
|-- |-- |-- |-- |
|provider |string |是 |服务空间供应商，阿里云为：`aliyun`，腾讯云为：`tencent` |
|spaceId |string |是 |服务空间Id |
|functionRuntimeVersion |string |是 |服务端sdk版本，本地调试插件随HBuilderX更新，云端保持与最新HBuilderX一致（无论本地版本多少，云端只有一个最新版本的云函数sdk），新增于`HBuilderX 3.5.1` |
|functionName |string |是 |云对象名称，新增于`HBuilderX 3.5.1` |
|functionType |string |是 |云对象此值固定为`cloudobject`，新增于`HBuilderX 3.5.1` |
......
docs/uniCloud/http.md
浏览文件 @ 6ab1227a
......@@ -48,7 +48,8 @@ url化后需要注意以下几点
- 每个服务空间最多绑定1个自定义域名
- uniCloud提供默认域名供体验和测试该特性
- 需要注意的是绑定的域名必须已经备案
- 单个服务空间可支持被访问的最大 QPS 为5000，单个云函数可支持被访问的最大 QPS 为2000（具体频次受函数并发限制）
- 腾讯云单个服务空间可支持被访问的最大 QPS 为5000，单个云函数可支持被访问的最大 QPS 为2000（具体频次受函数并发限制）
- 阿里云单个服务空间可支持被访问的最大 QPS 为1000（具体频次受函数并发限制）
- 默认域名可支持被访问的最大 QPS 为200，推荐您绑定自定义域名以获取更大的访问频次
- 阿里云绑定自定义域名要求此域名在阿里云保留备案信息，参考：[新增备案信息](https://help.aliyun.com/document_detail/36926.html)
......
docs/uniCloud/rundebug.md
浏览文件 @ 6ab1227a
......@@ -255,20 +255,24 @@ const hour = getOffsetDate(8).getHours()
"APPID": "", // 应用DCloud AppId
"LOCALE: "", // 客户端语言
// HBuilderX 3.5.1及更高版本无需传入大写参数，以上参数对应写法如下
"osName": "ios" // 系统类型 ios、android
"osName": "ios", // 系统类型 ios、android
"uniPlatform": "web", // 客户端类型 app-plus、h5、mp-weixin、mp-alipay等
"deviceId": "", // 设备id
"appId": "", // 应用DCloud AppId
"locale": "", // 客户端语言
// HBuilderX 3.5.1及更高版本还允许模拟调用来源（context.SOURCE）、客户端ip（context.CLIENTIP）、客户端ua（context.CLIENTUA）
"source": "client",
"clientIP": "127.0.0.1",
"ua": "xx MicroMessenger/xxx" // 注意非本地运行环境下客户端getSystemInfoSync也会获取ua参数并上传给云函数，但是云函数会从http请求头里面获取ua而不是clientInfo里面的ua
"source": "client", // 调用来源，不传时默认为 client
"clientIP": "127.0.0.1", // 客户端ip，不传时默认为 127.0.0.1
"ua": "xx MicroMessenger/xxx" // 客户端ua，不传时默认为 HBuilderX
// ...其他客户端信息
}
}
```
**注意**
- 非本地运行环境下客户端getSystemInfoSync也会获取ua参数并上传给云函数，但是云函数会从http请求头里面获取ua而不是clientInfo里面的ua
### 传入uniIdToken@mock-uni-id-token
客户端调用云函数时自动在data内加入了uniIdToken，使用配置参数运行时也一样在参数内传入即可
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或