Tilde Friends Client JS

Classes
class	TfNavigationElement
class	TfFilesElement
class	TfFilesPaneElement

Functions
function	ensureLoaded (nodes, callback)
function	editing ()
function	is_edit_only ()
function async	edit ()
function	loadFile (name, id)
function async	load (path)
function	closeEditor ()
function async	update_html ()
function	save (save_to)
function async	save_open_direct ()
function	save_locally ()
function	save_as ()
function	changeIcon ()
function	deleteApp ()
function	url ()
function	hash ()
function	api_setDocument (content)
function	api_setTitle (text)
function	api_postMessage (message)
function	api_error (error)
function	api_localStorageSet (key, value)
function	api_localStorageGet (key)
function	api_requestPermission (permission, description)
function	api_print ()
function	api_getHash (hash)
function	api_setHash (hash)
function	set_hidden (id, hide)
function	update_credentials (credentials)
function	_receive_websocket_message (message)
function	setStatusMessage (message, color)
function	send (value)
function	hashChange ()
function	focus ()
function	blur ()
function	visibilitychange ()
function	message (event)
function	reconnect (path)
function	connectSocket (path)
function	modeFromName (name)
function	openFile (name)
function	updateFiles ()
function	makeNewFile (name)
function	newFile ()
function	renameFile ()
function	removeFile ()
function async	appExport ()
function async	save_file_to_blob_id (name, file)
function async	appImport ()
function async	sourcePretty ()
function	toggleVisibleWhitespace ()

Variables
const	k_api

Detailed Description

Tilde Friends client-side browser JavaScript.

Function Documentation

_receive_websocket_message()

function _receive_websocket_message

(

message

)

Process an incoming WebSocket message.

Parameters

message

The message.

api_error()

function api_error

(

error

)

Show an error.

Parameters

error

The error.

api_getHash()

function api_getHash

(

hash

)

Get the window's location hash.

Returns

hash The hash.

api_localStorageGet()

function api_localStorageGet

(

key

)

Get a value from local storage.

Parameters

key

The key.

Returns

The value.

api_localStorageSet()

function api_localStorageSet	(		key,
			value
	)

et a value in local storage.

Parameters

key	The key.
value	The value.

api_postMessage()

function api_postMessage

(

message

)

Send a message to the sandboxed iframe.

Parameters

message

The message.

api_print()

function api_print

(

)

Log from the app to the console.

api_requestPermission()

function api_requestPermission	(		permission,
			description
	)

Request a permission

Parameters

permission	The permission to request.
description	An optional human-readable description of the action for which the permission is being requested.

Returns

A promise fulfilled if the permission was granted.

api_setDocument()

function api_setDocument

(

content

)

Set the iframe document contents.

Parameters

content

The contents.

api_setHash()

function api_setHash

(

hash

)

Set the window's location hash.

Parameters

hash	The new hash.

api_setTitle()

function api_setTitle

(

text

)

Set the document title.

Parameters

text	The title.

appExport()

function async appExport

(

)

Export the app to a zip file, which is downloaded by the browser.

appImport()

function async appImport

(

)

Prompt to import an app from a zip file.

blur()

function blur

(

)

Notify the app of lost focus.

changeIcon()

function changeIcon

(

)

Prompt to set the app icon.

closeEditor()

function closeEditor

(

)

Hide the editor.

connectSocket()

function connectSocket

(

path

)

Connect the WebSocket.

Parameters

path	The path to which to connect.

deleteApp()

function deleteApp

(

)

Prompt to delete the current app.

edit()

function async edit

(

)

Show the editor.

editing()

function editing

(

)

Check whether the editior is currently visible.

Returns

true if the editor is visible.

ensureLoaded()

function ensureLoaded	(		nodes,
			callback
	)

Make sure a set of dependencies are loaded

Parameters

nodes	An array of descriptions of dependencies to load.
callback	Called when all dependencies are loaded.

focus()

function focus

(

)

Make sure the app is connected on window focus, and notify the app.

hash()

function hash

(

)

Get the window hash without the lone '#' if it is empty.

Returns

The hash.

hashChange()

function hashChange

(

)

Notify the app of the window hash changing.

is_edit_only()

function is_edit_only

(

)

Check whether only the editor is visible and the app is hidden.

Returns

true if the editor is visible and the app is not.

load()

function async load

(

path

)

Load files for the app.

Parameters

path	The app path to load.

Returns

A promise resolved when the app is laoded.

loadFile()

function loadFile	(		name,
			id
	)

Load a single file.

Parameters

name	The name by which the file is known.
id	The file's ID.

Returns

A promise resolved with the file's contents.

makeNewFile()

function makeNewFile

(

name

)

Create a new file with the given name.

Parameters

name	The file's name.

message()

function message

(

event

)

Handle a message.

Parameters

event

The message.

modeFromName()

function modeFromName

(

name

)

Determine a CodeMirror language mode from filename.

Parameters

name

Filename.

Returns

The mode name.

newFile()

function newFile

(

)

Prompt to create a new file.

openFile()

function openFile

(

name

)

Open a file by name.

Parameters

name	The file to open.

reconnect()

function reconnect

(

path

)

Reconnect the WebSocket.

Parameters

path	The path to which the WebSocket should be connected.

removeFile()

function removeFile

(

)

Prompt to remove a file.

renameFile()

function renameFile

(

)

Prompt to rename a file.

save()

function save

(

save_to

)

Save the app.

Parameters

save_to

An optional path to which to save the app.

Returns

A promise resoled when the app is saved.

save_as()

function save_as

(

)

Prompt the user for a path to save the application to, and save there.

save_file_to_blob_id()

function async save_file_to_blob_id	(		name,
			file
	)

Save a file.

Parameters

name	The file to svae.
file	The file contents.

Returns

A promise resolved with the blob ID of the saved file.

save_locally()

function save_locally

(

)

Save the current application under a standard path for the current user

save_open_direct()

function async save_open_direct

(

)

Save the app in-place and then open it by blob ID.

send()

function send

(

value

)

Send a message to the app.

Parameters

value

The message.

set_hidden()

function set_hidden	(		id,
			hide
	)

Hide or unhide a DOM element with the given id.

Parameters

id	The element ID.
hide	true to hide the element or false to show it.

setStatusMessage()

function setStatusMessage	(		message,
			color
	)

Set the status message.

Parameters

message	The message.
color	The message's color.

sourcePretty()

function async sourcePretty

(

)

Prettify the current source file.

toggleVisibleWhitespace()

function toggleVisibleWhitespace

(

)

Toggle visible whitespace.

update_credentials()

function update_credentials

(

credentials

)

React to user credentials changing.

Parameters

credentials

Credentials object.

update_html()

function async update_html

(

)

Reload any static HTML content in the iframe.

updateFiles()

function updateFiles

(

)

Refresh the files list.

url()

function url

(

)

Get the current app URL.

Returns

The app URL.

visibilitychange()

function visibilitychange

(

)

Notify the app of visibility change. Seems to work when changing apps/tabs where focus/blur doesn't on mobile.

Variable Documentation

k_api

const k_api

Initial value:

= {
    setDocument: {args: ['content'], func: api_setDocument},
    setTitle: {args: ['text'], func: api_setTitle},
    postMessage: {args: ['message'], func: api_postMessage},
    error: {args: ['error'], func: api_error},
    localStorageSet: {args: ['key', 'value'], func: api_localStorageSet},
    localStorageGet: {args: ['key'], func: api_localStorageGet},
    requestPermission: {
        args: ['permission', 'id', 'description'],
        func: api_requestPermission,
    },
    print: {args: ['...'], func: api_print},
    setHash: {args: ['hash'], func: api_setHash},
    getHash: {args: [], func: api_getHash},
}

Functions that server-side app code can call through the app object.