Skip to content

Sorted³

Sorted³ is a task manager and planner built around a unified timeline. Protocol Launcher allows you to generate Sorted³ URL scheme links.

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

On-Demand
Recommended. Optimized for production.
Full Import
Convenient. Good for quick scripts.

Notes

Sorted's official guide documents sorted://x-callback-url/open and sorted://x-callback-url/add for Sorted³ v3.1 or later. This module only exposes helpers for those documented actions and parameters.

The guide lists item values as today, inbox, new, and search. Date opening supports a yyyy-MM-dd date, casual dates such as today, tomorrow, and yesterday, date=offset with an offset value, and date=weekday with weekday numbers where Sunday is 1 and Monday is 2.

The add action defaults type to task, so addTask() omits type. addEvent() serializes type=event. Comma-separated values such as tags and filterByTags are passed as strings and percent-encoded in the generated URL.

Sorted documents lock as a task-only parameter but does not specify its serialized true/false values, so the type accepts a caller-provided string and the examples do not invent a value.

Open Item Views

On-Demand
ts
import { open, openToday, openInbox, openNew, openSearch } from 'protocol-launcher/sorted'

const todayUrl = openToday()
const inboxUrl = openInbox()
const newUrl = openNew()
const searchViewUrl = openSearch()
const itemUrl = open({ item: 'today' })

Open Date

On-Demand
ts
import { openDate } from 'protocol-launcher/sorted'

const dateUrl = openDate({
  date: '2018-07-20',
})

const casualDateUrl = openDate({
  date: 'tomorrow',
})

Open Offset

On-Demand
ts
import { openOffset } from 'protocol-launcher/sorted'

const url = openOffset({
  offset: 3,
})

Open Weekday

On-Demand
ts
import { openWeekday } from 'protocol-launcher/sorted'

const url = openWeekday({
  weekday: 2,
})

Open List Or Tag

On-Demand
ts
import { openList, openTag } from 'protocol-launcher/sorted'

const listUrl = openList({
  list: 'Work',
  filterByTags: 'urgent,office',
})

const tagUrl = openTag({
  tag: 'urgent',
  filterByTags: 'office,phone',
})
On-Demand
ts
import { search } from 'protocol-launcher/sorted'

const url = search({
  search: 'Meeting',
})

Add Task

On-Demand
ts
import { addTask } from 'protocol-launcher/sorted'

const url = addTask({
  title: 'Plan launch',
  date: '2026-06-01 09:00',
  duration: 45,
  earlyAlert: 'none',
  list: 'Work',
  tags: 'urgent,office',
})

Add Event

On-Demand
ts
import { addEvent } from 'protocol-launcher/sorted'

const url = addEvent({
  title: 'Planning meeting',
  date: '2026-06-01 10:00',
  duration: 60,
  earlyAlert: 15,
  calendar: 'Work',
  location: 'Conference Room',
})

Generated URLs

ts
openToday()
// => 'sorted://x-callback-url/open?item=today'

openInbox()
// => 'sorted://x-callback-url/open?item=inbox'

openNew()
// => 'sorted://x-callback-url/open?item=new'

openSearch()
// => 'sorted://x-callback-url/open?item=search'

openDate({ date: '2018-07-20' })
// => 'sorted://x-callback-url/open?date=2018-07-20'

openDate({ date: 'tomorrow' })
// => 'sorted://x-callback-url/open?date=tomorrow'

openOffset({ offset: 3 })
// => 'sorted://x-callback-url/open?date=offset&offset=3'

openWeekday({ weekday: 2 })
// => 'sorted://x-callback-url/open?date=weekday&weekday=2'

openList({ list: 'Work', filterByTags: 'urgent,office' })
// => 'sorted://x-callback-url/open?list=Work&filterByTags=urgent%2Coffice'

openTag({ tag: 'urgent', filterByTags: 'office,phone' })
// => 'sorted://x-callback-url/open?tag=urgent&filterByTags=office%2Cphone'

search({ search: 'Meeting' })
// => 'sorted://x-callback-url/open?search=Meeting'

addTask({
  title: 'Plan launch',
  date: '2026-06-01 09:00',
  duration: 45,
  earlyAlert: 'none',
  list: 'Work',
  tags: 'urgent,office',
})
// => 'sorted://x-callback-url/add?title=Plan%20launch&date=2026-06-01%2009%3A00&duration=45&earlyAlert=none&list=Work&tags=urgent%2Coffice'

addEvent({
  title: 'Planning meeting',
  date: '2026-06-01 10:00',
  duration: 60,
  earlyAlert: 15,
  calendar: 'Work',
  location: 'Conference Room',
})
// => 'sorted://x-callback-url/add?title=Planning%20meeting&date=2026-06-01%2010%3A00&duration=60&earlyAlert=15&type=event&calendar=Work&location=Conference%20Room'

Official Documentation