Skip to content

Shopi

Shopi is a clever shopping list app for iPhone that's focused on helping you capture and shop for the items you want to buy. Protocol Launcher allows you to generate deep links to add items, create lists, and manage your shopping lists in Shopi.

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.

Show Lists

Show all shopping lists in Shopi.

On-Demand
ts
import { showLists } from 'protocol-launcher/shopi'

const url = showLists()

Show List

Show a specific shopping list in Shopi.

On-Demand
ts
import { showList } from 'protocol-launcher/shopi'

const url = showList({
  name: 'groceries',
})

Create List

Create a new shopping list in Shopi.

On-Demand
ts
import { createList } from 'protocol-launcher/shopi'

const url = createList({
  name: 'weekly shopping',
})

Add Item

Add an item to a shopping list in Shopi.

On-Demand
ts
import { addItem } from 'protocol-launcher/shopi'

const url = addItem({
  list: 'groceries',
  name: 'milk',
  amount: '2',
})

Clear List

Clear items from a shopping list in Shopi.

On-Demand
ts
import { clearList } from 'protocol-launcher/shopi'

const url = clearList({
  name: 'groceries',
  crossedOnly: 'yes',
})