Today Habit Tracker
Today Habit Tracker is a habit tracking app. Protocol Launcher allows you to generate deep links to open habits, check in, revoke check-ins, and show habit lists in Today.
Usage
There are two ways to use this library:
- On-Demand import from subpaths enables tree-shaking and keeps bundles small.
- Full Import from the root package is convenient but includes all app modules.
Pick On-Demand for production builds; Full Import is fine for quick scripts or demos.
Select Installation Method
Today action URLs use today://x-callback-url/<action>. The API fields xSuccess and xError generate the documented x-success and x-error query parameters.
Open Habit
Open Today, jump to a specific habit, and retrieve information about that habit.
import { openHabit } from 'protocol-launcher/today-habit-tracker'
const url = openHabit({
id: 'p14',
})Check In
Perform a check-in on a specific habit.
import { checkIn } from 'protocol-launcher/today-habit-tracker'
const url = checkIn({
id: 'p14',
})Revoke Check-In
Revoke a check-in on a specific habit.
import { revokeCheckIn } from 'protocol-launcher/today-habit-tracker'
const url = revokeCheckIn({
id: 'p14',
})Show Habits
Open Today's habit overview screen. The documented filter values are today and all; Today defaults to today when the filter is omitted.
import { showHabits } from 'protocol-launcher/today-habit-tracker'
const url = showHabits({
filter: 'all',
})x-callback-url
Today returns habit data on x-success for habit-specific actions, and returns habit title/id dictionaries plus totals for showHabits. Errors are returned through x-error.
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',
})