Skip to content

API

1
window.scrapbox

Layout

1
2
scrapbox.Layout
// "page"

Return value

Type Value Description
string page If on page https://scrapbox.io/PROJECTNAME.
list If on page https://scrapbox.io/PROJECTNAME/PAGENAME.

Page

1
2
3
4
5
6
7
scrapbox.Page
/* {
 *   id: "01234567890123456789abcd",
 *   lines: [...],
 *   title: "Bar baz"
 * } 
 */

Return value

Type Value Description
object { id: string, lines: array, title: string } Subj.

id

1
2
scrapbox.Page.id
// "01234567890123456789abcd"

Return value

Type Value Description
string Text in range /[a-f0-9]{24}/ Unique for page.

lines[]

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
scrapbox.Page.lines
/* [
 *   {
 *     created: 1612345678,
 *     id: "01234567890123456789abcd",
 *     ...
 *   },
 *   { ... },
 *   ...
 * ]
 */

Return value

Type Value Description
array [ { created: number, ... }, ... ] Array of lines on the page.

created

1
2
scrapbox.Page.lines[0].created
// 1612345678

Return value

Type Value Description
number e.g. 1612345678 Unix timestamp.

id

Return value

Type Value Description
string Text in range /[a-f0-9]{24}/ Unique for line.

? nodes[]|{}|""

Optional.

Return value

One of these:

Type Value Description
array e.g. [ {children: string, type: string, unit: {content: string, whole: string, ? page: string, ? size: number, ? deco: string, ? italic: boolean, ? strike: boolean, ? strong: number, ? underline: boolean} } ]
e.g. [ string ]
Type Value Description
object e.g. {? fileId: undefined, children: string, type: string, unit: {? tag: string, content: string, whole: string } }
Type Value Description
string e.g. Just text.. Text from line

section{}

Return value1

Type Value Description
object e.g. { number: number, end: boolean, start: boolean}

? codeBlock{}

Optional.

Return value

Type Value Description
object e.g. {filename: string, indent: number, lang: string, start: bool, end: bool } If line is included in Code Block.

? tableBlock{}

Optional.

Return value

Type Value Description
object e.g. {title: string, indent: number, cells: array of strings, start: bool, end: bool } If line is included in Table Block.

text

Return value

Type Value Description
string e.g. "lorem [* ipsum] [https://example.com/favicon.ico]" Just text from a line, with tabulation if any.

? title

Optional.

Return value

Type Value Description
string e.g. Bar baz Title of current page.

updated

Return value

Type Value Description
number e.g. 1612345678 Unix timestamp.

userId

Return value

Type Value Description
string Text in range /[a-f0-9]{24}/ Unique for user.

Project

1
2
3
4
5
6
scrapbox.Project
/* {
 *   name: "foobar-project",
 *   pages: [ ... ]
 * }
 */

Return value

Type Value Description
object { name: string, pages: array }

name

1
2
scrapbox.Project.name
// "foobar-project"

Return value

Type Value Description
string foobar-project Title of opened project, from browser's address bar. Unique for the entire Scrapbox, not just for user's namespace.

pages[]

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
scrapbox.Project.pages
/* [
 *   { 
 *     title: "Bar baz",
 *     ... 
 *   },
 *   ...,
 *   {
 *     exists: false,
 *     title: "new link",
 *     titleLc: "new_link",
 *     titleLengthForSort: 8,
 *     updated: 0
 *   }
 * ]
 */

Return value

Type Value Description
array [ { }, { }, ... ] Array of objects containing information about pages. Last object is "new link" object.

exists

1
2
scrapbox.Project.pages[0].exists
// true

Return value

Type Value Description
boolean true
false For example for object with title new link (it is system object, visually hidden).

? id

Optional.

Return value

Type Value Description
string Text in range /[a-f0-9]{24}/ Unique for page. "new link" page doesn't have this.

? image

Optional.

Return value

Type Value Description
string e.g. https://gyazo.com/... URL to image, if image is on the page.
undefined

title

Return value

Type Value Description
string e.g. Bar baz Page title in page

titleLc

Return value

Type Value Description
string e.g. bar_baz Page title in address bar, lowercased.

titleLengthForSort

Return value

Type Value Description
number e.g. 7 Page title length.

updated

Return value

Type Value Description
number e.g. 1612345678 Unix timestamp. 
1
scrapbox.PageMenu

length

1
2
scrapbox.PageMenu.length
// 1

Return value1

Type Value Description
string 1

name

1
2
scrapbox.PageMenu.name
// ""

Return value1

Type Value Description
string Empty

addItem()

1
scrapbox.PageMenu.addItem({ ... })

Parameter

Type Value Description
object {title: string, onClick: function}

Return value

Method does not return anything.

1
scrapbox.PageMenu(titleVar).addItem({ ... })

Parameter

Type Value Description
object {title: string, onClick: function}

Return value

Method does not return anything.

addMenu()

1
2
3
4
5
6
7
8
scrapbox.PageMenu.addMenu({
    title: "lorem-ipsum",
    image: ""
})
scrapbox.PageMenu("lorem-ipsum").addItem({
    title: "dolor sit",
    onClick: () => { ... }
})

Parameter

Type Value Description
object {title: '', ?image: 'URL', ?onClick: ()=>{} }

Return value

Method does not return anything.

addSeparator()

1
scrapbox.PageMenu("lorem-ipsum").addSeparator();

Return value

Method does not return anything.

removeAllItems()

1
scrapbox.PageMenu("lorem-ipsum").removeAllItems();

Return value

Method does not return anything.

PopupMenu

addButton()

1
2
3
4
5
6
7
scrapbox.PopupMenu.addButton({
  title: "lorem ipsum",
  onClick: (text) => {
    console.log(text);
    return "lorem ipsum dolor sit amet";
  }
})

Parameters

Type Value Description
object {title: string, onClick: function}

Return value

Method does not return anything.

on()

1
scrapbox.on(event, your_function)

Parameters

Type Value Description
Event "layout:changed"
"lines:changed"
function e.g. () => {} Callback.

off()

1
scrapbox.off()

Parameters1

Type Value Description

once()

1
scrapbox.once()

Parameters1

Type Value Description

localStorage

? drawPenColors

Optional.

1
localStorage.drawPenColors

Return value

Type Value Description
array [] If Drawing tool was used.

emacsCutBuffer

Return value

Type Value Description
string ""

hideCompanyNameChangeAlert

Return value1

Type Value Description
boolean e.g. true

lastProject

Return value1

Type Value Description
string e.g. "01234567890123456789abcd" Id of project.

? pageSorts

Optional.

Return value1

Type Value Description
object e.g. {"test":"linked", "foobar-project":"views"} If Sort by on the project page is changed.

? pageTransitionContext

Optional.

Return value

Type Value Description
object {} If the page on the project has been opened.

projectsLastAccessed

Return value

Type Value Description
object e.g. { "01234567890123456789abcd": 1612345678, ... } The list of projects. Updated every second.

? userScriptSHA1

Optional.

Return value

Type Value Description
object e.g. { "01234567890123456789abcd": "SHA1" } UserId and SHA1. If it was enabled User Script.

  1. Need clarification. ↩↩↩↩↩↩↩↩