Skip to content

Today Habit Tracker

Today Habit Tracker 是一款习惯追踪应用。Protocol Launcher 允许您生成深度链接,以在 Today 中打开习惯、完成打卡、撤销打卡和显示习惯列表。

使用方式

有两种使用此库的方式:

  • 按需导入(On-Demand):从子路径导入支持 tree-shaking,保持较小的打包体积。
  • 完整导入(Full Import):从根包导入更方便,但会包含所有应用模块。

生产构建建议选择按需导入;快速脚本或演示可以使用完整导入。

选择安装方式

按需加载
推荐使用。生产环境优化。
全量导入
使用便捷。适合快速脚本。

Today Action URL 使用 today://x-callback-url/<action>。API 字段 xSuccessxError 会生成官方文档中的 x-successx-error query 参数。

Open Habit

打开 Today,跳转到指定习惯,并取回该习惯的信息。

On-Demand
ts
import { openHabit } from 'protocol-launcher/today-habit-tracker'

const url = openHabit({
  id: 'p14',
})

Check In

为指定习惯执行一次 check-in。

On-Demand
ts
import { checkIn } from 'protocol-launcher/today-habit-tracker'

const url = checkIn({
  id: 'p14',
})

Revoke Check-In

撤销指定习惯的一次 check-in。

On-Demand
ts
import { revokeCheckIn } from 'protocol-launcher/today-habit-tracker'

const url = revokeCheckIn({
  id: 'p14',
})

Show Habits

打开 Today 的习惯总览页。官方文档中的 filter 值为 todayall;省略 filter 时,Today 默认使用 today

On-Demand
ts
import { showHabits } from 'protocol-launcher/today-habit-tracker'

const url = showHabits({
  filter: 'all',
})

x-callback-url

Today 会在 habit-specific action 的 x-success 中返回 habit 数据,并在 showHabitsx-success 中返回 habit title/id 字典和统计值。错误会通过 x-error 返回。

On-Demand
ts
import { openHabit } from 'protocol-launcher/today-habit-tracker'

const url = openHabit({
  id: 'p14',
  xSuccess: 'shortcuts://x-callback-url/run-shortcut?name=Habit Info',
  xError: 'shortcuts://x-callback-url/run-shortcut?name=Habit Error',
})

官方文档