Textwell

Textwell is a text editor for iOS and macOS. Protocol Launcher allows you to generate official URL scheme links for Textwell.

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

Textwell's official URL scheme documentation says every query parameter value must be URL-encoded. Textwell URL schemes support the documented x-success callback option, and extendXSuccess can ask Textwell to append textwell-text, textwell-loc, and textwell-len to the callback URL.

The prefix and suffix options are documented only for the four paste methods: pasteReplace, pasteInsert, pasteAdd, and pasteReplaceRange.

Open

On-Demand

import { open } from 'protocol-launcher/textwell'

const url = open()

Open Textwell

Replace

On-Demand

import { replace } from 'protocol-launcher/textwell'

const url = replace({
  text: 'Hello, Textwell.',
})

Replace Text

Insert

On-Demand

import { insert } from 'protocol-launcher/textwell'

const url = insert({
  text: 'Inserted text',
})

Insert Text

Add

On-Demand

import { add } from 'protocol-launcher/textwell'

const url = add({
  text: 'New ending',
})

Add Text

Replace Range

On-Demand

import { replaceRange } from 'protocol-launcher/textwell'

const url = replaceRange({
  replacingLoc: 7,
  replacingLen: 5,
  text: 'Textwell',
  selectingLoc: 0,
  selectingLen: 16,
})

Replace Range

Paste Methods

On-Demand

import { pasteReplace, pasteInsert, pasteAdd } from 'protocol-launcher/textwell'

const replaceUrl = pasteReplace()
const insertUrl = pasteInsert({
  prefix: '> ',
  suffix: '\n',
})
const addUrl = pasteAdd()

Paste ReplacePaste InsertPaste Add

Paste Replace Range

On-Demand

import { pasteReplaceRange } from 'protocol-launcher/textwell'

const url = pasteReplaceRange({
  replacingLoc: 7,
  replacingLen: 5,
  selectingLoc: 0,
  selectingLen: 16,
})

Paste Replace Range

Execute Action

On-Demand

import { executeAction } from 'protocol-launcher/textwell'

const url = executeAction({
  title: 'Format Markdown',
})

Execute Action

Import Action

On-Demand

import { importAction } from 'protocol-launcher/textwell'

const url = importAction({
  title: 'Hello',
  source: 'editor.setText("Hello")',
  iconTitle: 'star',
  desc: 'Create hello text',
  platform: 0,
  confirming: 1,
})

Import Action

x-success

On-Demand

import { replace } from 'protocol-launcher/textwell'

const url = replace({
  text: 'Hello',
  xSuccess: 'shortcuts://callback',
  extendXSuccess: true,
})

Generated URLs

open()
// => 'textwell://'

replace({ text: 'Hello, Textwell.' })
// => 'textwell:///replace?text=Hello%2C%20Textwell.'

insert({ text: 'Inserted text' })
// => 'textwell:///insert?text=Inserted%20text'

add({ text: 'New ending' })
// => 'textwell:///add?text=New%20ending'

replaceRange({
  replacingLoc: 7,
  replacingLen: 5,
  text: 'Textwell',
  selectingLoc: 0,
  selectingLen: 16,
})
// => 'textwell:///replaceRange?replacingLoc=7&replacingLen=5&text=Textwell&selectingLoc=0&selectingLen=16'

pasteReplace()
// => 'textwell:///pasteReplace?'

pasteInsert({ prefix: '> ', suffix: '\n' })
// => 'textwell:///pasteInsert?prefix=%3E%20&suffix=%0A'

pasteAdd()
// => 'textwell:///pasteAdd?'

pasteReplaceRange({
  replacingLoc: 7,
  replacingLen: 5,
  selectingLoc: 0,
  selectingLen: 16,
})
// => 'textwell:///pasteReplaceRange?replacingLoc=7&replacingLen=5&selectingLoc=0&selectingLen=16'

executeAction({ title: 'Format Markdown' })
// => 'textwell:///executeAction?title=Format%20Markdown'

importAction({
  title: 'Hello',
  source: 'editor.setText("Hello")',
  iconTitle: 'star',
  desc: 'Create hello text',
  platform: 0,
  confirming: 1,
})
// => 'textwell:///importAction?title=Hello&source=editor.setText(%22Hello%22)&iconTitle=star&desc=Create%20hello%20text&platform=0&confirming=1'

replace({
  text: 'Hello',
  xSuccess: 'shortcuts://callback',
  extendXSuccess: true,
})
// => 'textwell:///replace?text=Hello&x-success=shortcuts%3A%2F%2Fcallback&extendXSuccess=true'

Official Documentation

• Textwell URL Schemes