definePage

使用 definePage 宏定义页面

definePage 宏,用于动态生成 pages.json。

definePage 全局类型声明

将类型添加到 tsconfig.json 中的 compilerOptions.types 下

tsconfig.json
{
  "compilerOptions": {
    "types": ["@uni-helper/vite-plugin-uni-pages"]
  }
}

使用

vue SFC 文件内 definePage 宏使用方式

更多使用方式请参考 playground/pages/define-page

定义页面

对象形式

pages/index.vue
<script setup lang="ts">
definePage({
  style: {
    navigationBarTitleText: 'hello world',
  },
  middlewares: [
    'auth',
  ],
})
</script>

函数形式

pages/index.vue
<script setup lang="ts">
import type { HelloWorld } from './utils'

definePage(() => {
  const words: HelloWorld = {
    hello: 'hello',
    world: 'world',
  }

  return {
    style: {
      navigationBarTitleText: [words.hello, words.world].join(' '),
    },
    middlewares: [
      'auth',
    ],
  }
})
</script>

嵌套函数

pages/index.vue
<script setup lang="ts">
definePage(() => {
  function getTitle(): string {
    const hello = 'hello'
    const world = 'world'

    return [hello, world].join(' ')
  }

  return {
    style: {
      navigationBarTitleText: getTitle(),
    },
    middlewares: [
      'auth',
    ],
  }
})
</script>

异步数据获取

pages/index.vue
<script setup lang="ts">
definePage(async () => {
  function fetchTitle(): Promise<string> {
    return new Promise((resolve) => {
      setTimeout(() => {
        resolve('hello world from async')
      }, 100)
    })
  }

  const title = await fetchTitle()

  return {
    style: {
      navigationBarTitleText: title,
    },
    middlewares: [
      'auth',
    ],
  }
})
</script>

引入外部函数、变量

pages/index.vue
<script setup lang="ts">
import { parse as parseYML } from 'yaml'

definePage(() => {
  const yml = `
style:
  navigationBarTitleText: "yaml test"
`
  return parseYML(yml)
})
</script>

条件编译

npm i @uni-helper/uni-env
pages/index.vue
<script setup lang="ts">
import { isH5 } from '@uni-helper/uni-env'

definePage(() => {
  const title = isH5 ? 'H5 环境' : '非 H5 环境'

  return {
    style: {
      navigationBarTitleText: title,
    },
    middlewares: [
      'auth',
    ],
  }
})
</script>

选项式 API

pages/index.vue
<script>
definePage({
  style: {
    navigationBarTitleText: 'Option API 内使用 definePage',
  },
  middlewares: [
    'auth',
  ],
})

export default {
  data() {
    return {
      count: 0
    }
  }
}
</script>

按平台写不同配置

函数式 definePage 的上下文带 define,用来按平台写不同配置。它来自 @uni-ku/pages-json。

pages/index.vue
<script setup lang="ts">
definePage(({ define }) =>
  define({ layout: 'default' })
    .ifdef('h5', { layout: 'home' })
    .ifndef(['mp-weixin'], { style: { navigationBarTitleText: '非微信' } }),
)
</script>
  • 先写所有平台共用的部分,再用 ifdef、ifndef 按平台补充。
  • 匹配的分支按写的顺序合并进基础配置。对象一层层合并,数组与普通值整个替换。
  • h5 与 web 是同一个浏览器目标的两个名字。列表里写任意一个,两边都算匹配。

排除页面

函数式 definePage 返回 null 时,该页面从当前平台的 pages.json 里排除。

pages/secret.vue
<script setup lang="ts">
definePage(({ platform }) => (platform === 'h5' ? null : {}))
</script>