API.uvue 15.3 KB
Newer Older
DCloud-WZF's avatar
DCloud-WZF 已提交
1
<template>
Y
yurj26 已提交
2 3 4 5 6 7 8 9 10
  <!-- #ifdef APP -->
  <scroll-view style="flex: 1">
    <!-- #endif -->
    <view class="uni-container">
      <view class="uni-header-logo">
        <image class="uni-header-image" src="/static/apiIndex.png"></image>
      </view>
      <view class="uni-text-box">
        <text class="hello-text">以下将演示uni-app接口能力,详细文档见:</text>
W
wanganxp 已提交
11
        <u-link :href="'https://uniapp.dcloud.io/uni-app-x/api/'" :text="'https://uniapp.dcloud.io/uni-app-x/api/'"
Y
yurj26 已提交
12 13
          :inWhiteList="true"></u-link>
      </view>
M
mehaotian 已提交
14

Y
yurj26 已提交
15 16 17 18 19 20 21 22 23 24 25 26
      <uni-collapse>
        <template v-for="item in list" :key="item.id">
          <uni-collapse-item :title="item.name" class="item">
            <view class="uni-navigate-item" :hover-class="page.enable == false?'':'is--active'"
              v-for="(page, key) in item.pages" :key="key" @click="goDetailPage(page)">
              <text class="uni-navigate-text"
                :class="page.enable == false ? 'text-disabled' : ''">{{ page.name }}</text>
              <image :src="arrowRightIcon" class="uni-icon"></image>
            </view>
          </uni-collapse-item>
        </template>
      </uni-collapse>
M
mehaotian 已提交
27

Y
yurj26 已提交
28 29 30 31 32 33 34 35 36
    </view>
    <!-- #ifdef APP -->
  </scroll-view>
  <!-- #endif -->
  <view ref="pop" @click="hidePop()"
    style="width: 100%; height: 100%; position: absolute;align-items: center;justify-content: center; display: none;background-color: rgba(16, 16, 16, 0.5);">
    <view style="width: 90%;background-color: white;" @click="stopClickPop">
      <api-set-tabbar></api-set-tabbar>
    </view>
W
wanganxp 已提交
37
  </view>
DCloud-WZF's avatar
DCloud-WZF 已提交
38 39
</template>

Y
yurj26 已提交
40
<script lang="uts">
Y
yurj26 已提交
41 42 43 44
  type Page = {
    name : string
    url : string
    enable ?: boolean
45
    api ?: Array<string>
Y
yurj26 已提交
46 47 48 49 50 51 52 53 54 55 56 57
  }
  type ListItem = {
    id : string
    name : string
    pages : Page[]
    url ?: string
    enable ?: boolean
  }
  export default {
    data() {
      return {
        list: [
58
          {
D
DCloud_LXH 已提交
59
            id: 'global',
Y
yurj26 已提交
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
            name: '全局',
            pages: [
              {
                name: 'getApp',
                url: 'get-app',
              },
              {
                name: 'getCurrentPages',
                url: 'get-current-pages',
              }
            ] as Page[],
          },
          {
            id: 'base',
            name: '基础',
            pages: [
              {
                name: '事件总线event-bus',
                url: 'event-bus',
                api: ["$on", "$once", "$off", "$emit"]
              },
              {
                name: '获取启动参数',
                url: 'get-launch-options-sync',
              },
              {
                name: '退出应用',
                url: 'exit',
              },
            ] as Page[],
          },
          {
            id: 'page',
            name: '页面和路由',
            pages: [
              {
                name: '页面跳转',
                url: 'navigator',
D
DCloud_LXH 已提交
98
                api: ["navigateTo", "reLaunch", "navigateBack", "redirectTo", "switchTab"]
Y
yurj26 已提交
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
              },
              /*
              {
                name: '设置导航条标题',
                url: 'set-navigation-bar-title',
                enable: false,
              }, */
              {
                name: '设置导航条颜色',
                url: 'set-navigation-bar-color',
              },
              {
                name: '设置TabBar',
                url: 'set-tabbar',
                api: ["showTabBar", "hideTabBar", "showTabBarRedDot", "hideTabBarRedDot", "setTabBarBadge", "removeTabBarBadge", "setTabBarStyle", "setTabBarItem"]
              },
              {
                name: '页面下拉刷新',
                url: 'pull-down-refresh',
                api: ["stopPullDownRefresh"]
              },
              {
                name: '将页面滚动到指定位置',
                url: 'page-scroll-to',
              },
            ] as Page[],
          },
          {
            id: 'ui',
            name: '界面',
            pages: [
              /* {
                name: "创建动画",
                url: "animation",
                enable: false
              },
              {
                name: "创建绘画",
                url: "canvas",
                enable: false
              },
              {
                name: "节点布局交互状态",
                url: "intersection-observer",
                enable: false
DCloud-WZF's avatar
DCloud-WZF 已提交
144 145
              }, */
              {
W
wanganxp 已提交
146
                name: 'element元素',
DCloud-WZF's avatar
DCloud-WZF 已提交
147 148
                url: 'get-element-by-id',
                api: ["getElementById"]
149 150 151 152 153
              },
              {
                name: 'element截图',
                url: 'element-takesnapshot',
                api: ["takeSnapshot"]
DCloud-WZF's avatar
DCloud-WZF 已提交
154
              },
Y
yurj26 已提交
155
              {
W
wanganxp 已提交
156
                name: 'node节点',
Y
yurj26 已提交
157 158 159 160
                url: 'nodes-info',
                api: ["createSelectorQuery"]
              },
              {
W
wanganxp 已提交
161 162 163 164 165
                name: '动态加载字体',
                url: 'load-font-face',
              },
              {
                name: 'actionSheet操作菜单',
Y
yurj26 已提交
166 167 168
                url: 'action-sheet',
              },
              {
W
wanganxp 已提交
169
                name: 'showModal模态弹窗',
Y
yurj26 已提交
170 171 172 173
                url: 'modal',
                api: ["showModal"]
              },
              {
W
wanganxp 已提交
174
                name: 'showLoading等待框',
175
                url: 'loading',
Y
yurj26 已提交
176 177
              },
              {
W
wanganxp 已提交
178
                name: 'showToast轻提示框',
Y
yurj26 已提交
179 180
                url: 'toast',
                api: ["showToast"]
W
wanganxp 已提交
181
              }
Y
yurj26 已提交
182
            ] as Page[],
W
wanganxp 已提交
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
          },
          {
            id: 'network',
            name: '网络',
            pages: [
              {
                name: '发起请求request',
                url: 'request',
              },
              {
                name: '上传文件',
                url: 'upload-file',
              },
              {
                name: '下载文件',
                url: 'download-file',
              },
              {
                name: '获取设备网络状态',
                url: 'get-network-type',
              },
              {
                name: 'socketTask',
                url: 'websocket-socketTask',
                api: [""] //它不是uni.的api
              },
              {
                name: '全局websocket',
                url: 'websocket-global',
                api: ["connectSocket", "onSocketOpen", "onSocketError", "sendSocketMessage", "onSocketMessage", "closeSocket", "onSocketClose"]
              },
            ] as Page[],
Y
yurj26 已提交
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
          },
          {
            id: 'device',
            name: '设备',
            pages: [
              {
                name: '获取系统信息',
                url: 'get-system-info',
              },
              {
                name: '获取设备信息',
                url: 'get-device-info',
              },
              {
                name: '获取窗口信息',
                url: 'get-window-info',
              },
              {
                name: '获取APP基础信息',
                url: 'get-app-base-info',
              },
              {
                name: '获取APP授权设置',
                url: 'get-app-authorize-setting',
              },
              {
                name: '获取系统设置',
                url: 'get-system-setting',
              },
              {
                name: '电量',
                url: 'get-battery-info',
              },
              /* {
                name: "打电话",
                url: "make-phone-call",
              },
              {
                name: "震动",
                url: "vibrate",
              },
              {
                name: "添加手机联系人",
                url: "add-phone-contact",
              },
              {
                name: "扫码",
                url: "scan-code",
              },
              {
                name: "剪贴板",
                url: "clipboard",
              },
              {
                name: "屏幕亮度",
                url: "brightness",
              },
              {
                name: "蓝牙",
                url: "bluetooth",
              },
              {
                name: "生物认证",
                url: "soter",
              },
              {
                name: "iBeacon",
                url: "ibeacon",
              },
              {
                name: "监听加速度传感器",
                url: "on-accelerometer-change",
              },
              {
                name: "监听罗盘数据",
                url: "on-compass-change",
              },
              {
                name: "监听距离传感器",
                url: "/platforms/app-plus/proximity/proximity",
              },
              {
                name: "监听方向传感器",
                url: "/platforms/app-plus/orientation/orientation",
              }, */
            ] as Page[],
          },
          {
            id: 'media',
            name: '媒体',
张磊 已提交
305 306
            pages: [
              {
W
wanganxp 已提交
307
                name: "拍照和相册选择",
张磊 已提交
308 309
                url: 'choose-image'
              },
Y
yurj26 已提交
310
              {
W
wanganxp 已提交
311
                name: '图片预览',
Y
yurj26 已提交
312
                url: 'preview-image',
W
wanganxp 已提交
313
                api: ["previewImage", "closePreviewImage"]
Y
yurj26 已提交
314 315 316
              },
              {
                name: "保存图片到相册",
317
                url: 'save-image-to-photos-album'
Y
yurj26 已提交
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
              }
              /* {
                name: "图片选择和拍照",
                url: "image",
                enable: false
              },{
                name: "音频",
                url: "inner-audio",
              },
              {
                name: "录音",
                url: "voice",
              },
              {
                name: "背景音频",
                url: "background-audio",
              },
              {
                name: "视频选择和拍照",
                url: "video",
                enable: false
              },
              {
                name: "文件",
                url: "file",
              },
              {
                name: "保存媒体到本地",
                url: "save-media",
              }, */
            ] as Page[],
          },
          {
            id: 'location',
            name: '位置',
            pages: [
              {
                name: '获取当前位置',
                url: 'get-location',
              },
              /* {
                name: "使用地图查看位置",
                url: "open-location",
              },
              {
                name: "使用地图选择位置",
                url: "choose-location",
              },
              {
                name: "地图控制",
                url: "map",
              },
              {
                name: "地图搜索",
                url: "map-search",
              }, */
            ] as Page[],
375
          },
Y
yurj26 已提交
376 377 378 379 380 381 382
          {
            id: 'storage',
            name: '数据存储',
            pages: [
              {
                name: 'storage(key-value存储)',
                url: 'storage',
D
DCloud_LXH 已提交
383
                api: ["getStorageInfo", "getStorageInfoSync", "getStorage", "getStorageSync", "setStorage", "setStorageSync", "removeStorage", "removeStorageSync", "clearStorage", "clearStorageSync"]
Y
yurj26 已提交
384 385
              },
            ] as Page[],
W
微调  
wanganxp 已提交
386
          },
雪洛's avatar
雪洛 已提交
387 388 389 390 391 392
          {
            id: 'unicloud',
            name: 'uniCloud',
            pages: [
              {
                name: '云函数',
雪洛's avatar
雪洛 已提交
393
                url: 'unicloud-call-function',
雪洛's avatar
雪洛 已提交
394
              },
395 396
              {
                name: '云对象',
雪洛's avatar
雪洛 已提交
397 398 399 400 401
                url: 'unicloud-import-object',
              },
              {
                name: '云存储',
                url: 'unicloud-file-api',
402
              },
雪洛's avatar
雪洛 已提交
403 404 405 406
              {
                name: 'clientDB',
                url: 'unicloud-database',
              },
雪洛's avatar
雪洛 已提交
407
            ] as Page[],
雪洛's avatar
雪洛 已提交
408 409 410 411 412 413 414 415 416 417
          },
          {
            id: 'third-party',
            name: '第三方服务',
            pages: [
              {
                name: '实人认证',
                url: 'facial-recognition-verify',
              },
            ] as Page[],
雪洛's avatar
雪洛 已提交
418
          },
Y
yurj26 已提交
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
          /* {
            id: "rewarded-video-ad",
            url: "rewarded-video-ad",
            name: "激励视频广告",
            enable: false,
            pages: [] as Page[]
          },
          {
            id: "full-screen-video-ad",
            url: "full-screen-video-ad",
            name: "全屏视频广告",
            enable: false,
            pages: [] as Page[]
          },
          {
            id: "login",
            name: "登录",
            pages: [
              {
                name: "登录",
                url: "login",
              },
              {
                name: "获取用户信息",
                url: "get-user-info",
              },
            ] as Page[],
          },
          {
            id: "share",
            name: "分享",
            pages: [
              {
                name: "分享",
                url: "share",
              },
            ] as Page[],
          },
          {
            id: "payment",
            name: "支付",
            pages: [
              {
                name: "发起支付",
                url: "request-payment",
              },
            ] as Page[],
          },
          {
            id: "speech",
            name: "语音",
            pages: [
              {
                name: "语音识别",
                url: "/platforms/app-plus/speech/speech",
              },
            ] as Page[],
          },
          {
            id: "push",
            name: "推送",
            pages: [
              {
                name: "推送",
                url: "/platforms/app-plus/push/push",
              },
            ] as Page[],
          }, */
        ] as ListItem[],
        arrowUpIcon: '/static/icons/arrow-up.png',
        arrowDownIcon: '/static/icons/arrow-down.png',
        arrowRightIcon: '/static/icons/arrow-right.png',
      }
    },
    methods: {
      goDetailPage(e : Page) {
        if (e.enable == false) {
          uni.showToast({
            title: '暂不支持',
            icon: 'none',
          })
          return
        }
        if (e.url === 'set-tabbar') {
          this.showPop()
          return;
W
wanganxp 已提交
505
        }
Y
yurj26 已提交
506 507 508 509 510 511 512
        const url =
          e.url.indexOf('platform') > -1 ? e.url : `/pages/API/${e.url}/${e.url}`
        uni.navigateTo({
          url,
        })
      },
      showPop: function () {
DCloud-yyl's avatar
DCloud-yyl 已提交
513
        (this.$refs["pop"] as Element).style.setProperty("display", "flex")
Y
yurj26 已提交
514 515
      },
      hidePop: function () {
DCloud-yyl's avatar
DCloud-yyl 已提交
516
        (this.$refs["pop"] as Element).style.setProperty("display", "none")
Y
yurj26 已提交
517 518 519
      },
      stopClickPop: function (e : MouseEvent) {
        e.stopPropagation() //点击到pop的非灰色区域,拦截点击事件
W
wanganxp 已提交
520
      }
Y
yurj26 已提交
521 522
    },
  }
DCloud-WZF's avatar
DCloud-WZF 已提交
523 524 525
</script>

<style>
Y
yurj26 已提交
526
  @import '../../common/uni-uvue.css';
M
mehaotian 已提交
527

Y
yurj26 已提交
528 529 530
  .item {
    margin-bottom: 12px;
  }
W
微调  
wanganxp 已提交
531
</style>