JSDocumentation - cse110-sp21-group14/cse110-sp21-group14 Wiki

Modules

Classes

Members

Constants

Functions

Typedefs

calendar module

Middleware to protect users security

passport module

Passport for Google OAuth2

decrypting module

Decrypted data from MongoDB to original journal(s)/page(s)

calendar module

Calendar route

Calendar

Kind: global class

new Calendar(model, date)

Param Type
model Model
date Date

Events

NestedList Tool for EditorJS

Kind: global class

new Events(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

new Events(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

events.nodes

HTML nodes used in tool

Kind: instance property of Events

events.defaultListStyle

This list-style will be used by default

Kind: instance property of Events

events.caret

Instantiate caret helper

Kind: instance property of Events

events.listStyle ⇒ string

Get list style name

Kind: instance property of Events

events.listStyle

Set list style

Kind: instance property of Events

Param Type Description
style string new style to set

events.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Events

events.nodes

HTML nodes used in tool

Kind: instance property of Events

events.defaultListStyle

This list-style will be used by default

Kind: instance property of Events

events.caret

Instantiate caret helper

Kind: instance property of Events

events.listStyle ⇒ string

Get list style name

Kind: instance property of Events

events.listStyle

Set list style

Kind: instance property of Events

Param Type Description
style string new style to set

events.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Events

events.render() ⇒ Element

Returns list tag with items

Kind: instance method of Events
Access: public

events.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Events
Access: public

events.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Events

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

events.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Events

Param Type Description
content string item content to render
[items] Array.<ListItem> children

events.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Events

events.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Events

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

events.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Events

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

events.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

events.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Events

events.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Events

Param Type Description
item Element item wrapper ()

events.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Events

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

events.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Events

events.backspace(event)

Handle backspace

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

events.addTab(event)

Add indentation to current item

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

events.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

events.render() ⇒ Element

Returns list tag with items

Kind: instance method of Events
Access: public

events.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Events
Access: public

events.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Events

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

events.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Events

Param Type Description
content string item content to render
[items] Array.<ListItem> children

events.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Events

events.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Events

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

events.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Events

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

events.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

events.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Events

events.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Events

Param Type Description
item Element item wrapper ()

events.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Events

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

events.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Events

events.backspace(event)

Handle backspace

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

events.addTab(event)

Add indentation to current item

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

events.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

Events.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Events

Events.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Events
Access: public

Events.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Events

Events.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Events

Events.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Events
Access: public

Events.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Events

Notes

NestedList Tool for EditorJS

Kind: global class

new Notes(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

new Notes(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

notes.nodes

HTML nodes used in tool

Kind: instance property of Notes

notes.defaultListStyle

This list-style will be used by default

Kind: instance property of Notes

notes.caret

Instantiate caret helper

Kind: instance property of Notes

notes.listStyle ⇒ string

Get list style name

Kind: instance property of Notes

notes.listStyle

Set list style

Kind: instance property of Notes

Param Type Description
style string new style to set

notes.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Notes

notes.nodes

HTML nodes used in tool

Kind: instance property of Notes

notes.defaultListStyle

This list-style will be used by default

Kind: instance property of Notes

notes.caret

Instantiate caret helper

Kind: instance property of Notes

notes.listStyle ⇒ string

Get list style name

Kind: instance property of Notes

notes.listStyle

Set list style

Kind: instance property of Notes

Param Type Description
style string new style to set

notes.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Notes

notes.render() ⇒ Element

Returns list tag with items

Kind: instance method of Notes
Access: public

notes.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Notes
Access: public

notes.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Notes

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

notes.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Notes

Param Type Description
content string item content to render
[items] Array.<ListItem> children

notes.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Notes

notes.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Notes

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

notes.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Notes

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

notes.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

notes.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Notes

notes.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Notes

Param Type Description
item Element item wrapper ()

notes.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Notes

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

notes.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Notes

notes.backspace(event)

Handle backspace

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

notes.addTab(event)

Add indentation to current item

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

notes.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

notes.render() ⇒ Element

Returns list tag with items

Kind: instance method of Notes
Access: public

notes.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Notes
Access: public

notes.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Notes

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

notes.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Notes

Param Type Description
content string item content to render
[items] Array.<ListItem> children

notes.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Notes

notes.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Notes

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

notes.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Notes

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

notes.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

notes.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Notes

notes.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Notes

Param Type Description
item Element item wrapper ()

notes.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Notes

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

notes.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Notes

notes.backspace(event)

Handle backspace

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

notes.addTab(event)

Add indentation to current item

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

notes.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

Notes.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Notes

Notes.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Notes
Access: public

Notes.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Notes

Notes.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Notes

Notes.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Notes
Access: public

Notes.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Notes

Tasks

NestedList Tool for EditorJS

Kind: global class

new Tasks(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

new Tasks(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

tasks.nodes

HTML nodes used in tool

Kind: instance property of Tasks

tasks.defaultListStyle

This list-style will be used by default

Kind: instance property of Tasks

tasks.caret

Instantiate caret helper

Kind: instance property of Tasks

tasks.listStyle ⇒ string

Get list style name

Kind: instance property of Tasks

tasks.listStyle

Set list style

Kind: instance property of Tasks

Param Type Description
style string new style to set

tasks.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Tasks

tasks.nodes

HTML nodes used in tool

Kind: instance property of Tasks

tasks.defaultListStyle

This list-style will be used by default

Kind: instance property of Tasks

tasks.caret

Instantiate caret helper

Kind: instance property of Tasks

tasks.listStyle ⇒ string

Get list style name

Kind: instance property of Tasks

tasks.listStyle

Set list style

Kind: instance property of Tasks

Param Type Description
style string new style to set

tasks.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Tasks

tasks.render() ⇒ Element

Returns list tag with items

Kind: instance method of Tasks
Access: public

tasks.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Tasks
Access: public

tasks.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Tasks

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

tasks.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Tasks

Param Type Description
content string item content to render
[items] Array.<ListItem> children

tasks.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Tasks

tasks.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Tasks

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

tasks.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Tasks

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

tasks.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

tasks.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Tasks

tasks.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Tasks

Param Type Description
item Element item wrapper ()

tasks.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Tasks

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

tasks.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Tasks

tasks.backspace(event)

Handle backspace

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

tasks.addTab(event)

Add indentation to current item

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

tasks.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

tasks.render() ⇒ Element

Returns list tag with items

Kind: instance method of Tasks
Access: public

tasks.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Tasks
Access: public

tasks.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Tasks

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

tasks.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Tasks

Param Type Description
content string item content to render
[items] Array.<ListItem> children

tasks.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Tasks

tasks.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Tasks

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

tasks.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Tasks

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

tasks.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

tasks.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Tasks

tasks.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Tasks

Param Type Description
item Element item wrapper ()

tasks.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Tasks

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

tasks.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Tasks

tasks.backspace(event)

Handle backspace

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

tasks.addTab(event)

Add indentation to current item

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

tasks.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

Tasks.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Tasks

Tasks.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Tasks
Access: public

Tasks.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Tasks

Tasks.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Tasks

Tasks.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Tasks
Access: public

Tasks.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Tasks

Ordered

NestedList Tool for EditorJS

Kind: global class

new Ordered(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

new Ordered(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

ordered.nodes

HTML nodes used in tool

Kind: instance property of Ordered

ordered.defaultListStyle

This list-style will be used by default

Kind: instance property of Ordered

ordered.caret

Instantiate caret helper

Kind: instance property of Ordered

ordered.listStyle ⇒ string

Get list style name

Kind: instance property of Ordered

ordered.listStyle

Set list style

Kind: instance property of Ordered

Param Type Description
style string new style to set

ordered.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Ordered

ordered.nodes

HTML nodes used in tool

Kind: instance property of Ordered

ordered.defaultListStyle

This list-style will be used by default

Kind: instance property of Ordered

ordered.caret

Instantiate caret helper

Kind: instance property of Ordered

ordered.listStyle ⇒ string

Get list style name

Kind: instance property of Ordered

ordered.listStyle

Set list style

Kind: instance property of Ordered

Param Type Description
style string new style to set

ordered.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Ordered

ordered.render() ⇒ Element

Returns list tag with items

Kind: instance method of Ordered
Access: public

ordered.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Ordered
Access: public

ordered.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Ordered

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

ordered.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Ordered

Param Type Description
content string item content to render
[items] Array.<ListItem> children

ordered.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Ordered

ordered.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Ordered

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

ordered.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Ordered

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

ordered.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

ordered.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Ordered

ordered.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Ordered

Param Type Description
item Element item wrapper ()

ordered.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Ordered

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

ordered.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Ordered

ordered.backspace(event)

Handle backspace

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

ordered.addTab(event)

Add indentation to current item

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

ordered.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

ordered.render() ⇒ Element

Returns list tag with items

Kind: instance method of Ordered
Access: public

ordered.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Ordered
Access: public

ordered.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Ordered

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

ordered.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Ordered

Param Type Description
content string item content to render
[items] Array.<ListItem> children

ordered.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Ordered

ordered.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Ordered

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

ordered.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Ordered

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

ordered.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

ordered.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Ordered

ordered.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Ordered

Param Type Description
item Element item wrapper ()

ordered.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Ordered

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

ordered.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Ordered

ordered.backspace(event)

Handle backspace

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

ordered.addTab(event)

Add indentation to current item

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

ordered.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

Ordered.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Ordered

Ordered.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Ordered
Access: public

Ordered.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Ordered

Ordered.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Ordered

Ordered.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Ordered
Access: public

Ordered.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Ordered

Events

NestedList Tool for EditorJS

Kind: global class

new Events(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

new Events(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

events.nodes

HTML nodes used in tool

Kind: instance property of Events

events.defaultListStyle

This list-style will be used by default

Kind: instance property of Events

events.caret

Instantiate caret helper

Kind: instance property of Events

events.listStyle ⇒ string

Get list style name

Kind: instance property of Events

events.listStyle

Set list style

Kind: instance property of Events

Param Type Description
style string new style to set

events.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Events

events.nodes

HTML nodes used in tool

Kind: instance property of Events

events.defaultListStyle

This list-style will be used by default

Kind: instance property of Events

events.caret

Instantiate caret helper

Kind: instance property of Events

events.listStyle ⇒ string

Get list style name

Kind: instance property of Events

events.listStyle

Set list style

Kind: instance property of Events

Param Type Description
style string new style to set

events.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Events

events.render() ⇒ Element

Returns list tag with items

Kind: instance method of Events
Access: public

events.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Events
Access: public

events.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Events

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

events.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Events

Param Type Description
content string item content to render
[items] Array.<ListItem> children

events.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Events

events.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Events

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

events.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Events

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

events.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

events.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Events

events.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Events

Param Type Description
item Element item wrapper ()

events.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Events

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

events.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Events

events.backspace(event)

Handle backspace

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

events.addTab(event)

Add indentation to current item

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

events.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

events.render() ⇒ Element

Returns list tag with items

Kind: instance method of Events
Access: public

events.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Events
Access: public

events.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Events

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

events.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Events

Param Type Description
content string item content to render
[items] Array.<ListItem> children

events.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Events

events.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Events

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

events.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Events

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

events.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

events.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Events

events.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Events

Param Type Description
item Element item wrapper ()

events.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Events

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

events.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Events

events.backspace(event)

Handle backspace

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

events.addTab(event)

Add indentation to current item

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

events.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Events

Param Type Description
event KeyboardEvent keydown

Events.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Events

Events.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Events
Access: public

Events.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Events

Events.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Events

Events.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Events
Access: public

Events.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Events

Notes

NestedList Tool for EditorJS

Kind: global class

new Notes(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

new Notes(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

notes.nodes

HTML nodes used in tool

Kind: instance property of Notes

notes.defaultListStyle

This list-style will be used by default

Kind: instance property of Notes

notes.caret

Instantiate caret helper

Kind: instance property of Notes

notes.listStyle ⇒ string

Get list style name

Kind: instance property of Notes

notes.listStyle

Set list style

Kind: instance property of Notes

Param Type Description
style string new style to set

notes.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Notes

notes.nodes

HTML nodes used in tool

Kind: instance property of Notes

notes.defaultListStyle

This list-style will be used by default

Kind: instance property of Notes

notes.caret

Instantiate caret helper

Kind: instance property of Notes

notes.listStyle ⇒ string

Get list style name

Kind: instance property of Notes

notes.listStyle

Set list style

Kind: instance property of Notes

Param Type Description
style string new style to set

notes.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Notes

notes.render() ⇒ Element

Returns list tag with items

Kind: instance method of Notes
Access: public

notes.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Notes
Access: public

notes.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Notes

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

notes.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Notes

Param Type Description
content string item content to render
[items] Array.<ListItem> children

notes.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Notes

notes.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Notes

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

notes.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Notes

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

notes.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

notes.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Notes

notes.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Notes

Param Type Description
item Element item wrapper ()

notes.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Notes

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

notes.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Notes

notes.backspace(event)

Handle backspace

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

notes.addTab(event)

Add indentation to current item

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

notes.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

notes.render() ⇒ Element

Returns list tag with items

Kind: instance method of Notes
Access: public

notes.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Notes
Access: public

notes.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Notes

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

notes.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Notes

Param Type Description
content string item content to render
[items] Array.<ListItem> children

notes.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Notes

notes.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Notes

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

notes.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Notes

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

notes.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

notes.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Notes

notes.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Notes

Param Type Description
item Element item wrapper ()

notes.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Notes

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

notes.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Notes

notes.backspace(event)

Handle backspace

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

notes.addTab(event)

Add indentation to current item

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

notes.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Notes

Param Type Description
event KeyboardEvent keydown

Notes.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Notes

Notes.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Notes
Access: public

Notes.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Notes

Notes.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Notes

Notes.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Notes
Access: public

Notes.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Notes

Tasks

NestedList Tool for EditorJS

Kind: global class

new Tasks(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

new Tasks(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

tasks.nodes

HTML nodes used in tool

Kind: instance property of Tasks

tasks.defaultListStyle

This list-style will be used by default

Kind: instance property of Tasks

tasks.caret

Instantiate caret helper

Kind: instance property of Tasks

tasks.listStyle ⇒ string

Get list style name

Kind: instance property of Tasks

tasks.listStyle

Set list style

Kind: instance property of Tasks

Param Type Description
style string new style to set

tasks.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Tasks

tasks.nodes

HTML nodes used in tool

Kind: instance property of Tasks

tasks.defaultListStyle

This list-style will be used by default

Kind: instance property of Tasks

tasks.caret

Instantiate caret helper

Kind: instance property of Tasks

tasks.listStyle ⇒ string

Get list style name

Kind: instance property of Tasks

tasks.listStyle

Set list style

Kind: instance property of Tasks

Param Type Description
style string new style to set

tasks.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Tasks

tasks.render() ⇒ Element

Returns list tag with items

Kind: instance method of Tasks
Access: public

tasks.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Tasks
Access: public

tasks.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Tasks

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

tasks.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Tasks

Param Type Description
content string item content to render
[items] Array.<ListItem> children

tasks.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Tasks

tasks.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Tasks

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

tasks.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Tasks

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

tasks.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

tasks.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Tasks

tasks.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Tasks

Param Type Description
item Element item wrapper ()

tasks.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Tasks

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

tasks.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Tasks

tasks.backspace(event)

Handle backspace

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

tasks.addTab(event)

Add indentation to current item

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

tasks.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

tasks.render() ⇒ Element

Returns list tag with items

Kind: instance method of Tasks
Access: public

tasks.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Tasks
Access: public

tasks.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Tasks

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

tasks.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Tasks

Param Type Description
content string item content to render
[items] Array.<ListItem> children

tasks.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Tasks

tasks.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Tasks

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

tasks.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Tasks

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

tasks.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

tasks.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Tasks

tasks.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Tasks

Param Type Description
item Element item wrapper ()

tasks.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Tasks

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

tasks.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Tasks

tasks.backspace(event)

Handle backspace

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

tasks.addTab(event)

Add indentation to current item

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

tasks.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Tasks

Param Type Description
event KeyboardEvent keydown

Tasks.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Tasks

Tasks.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Tasks
Access: public

Tasks.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Tasks

Tasks.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Tasks

Tasks.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Tasks
Access: public

Tasks.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Tasks

Ordered

NestedList Tool for EditorJS

Kind: global class

new Ordered(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

new Ordered(params)

Render plugin`s main Element and fill it with saved data

Param Type Description
params object tool constructor options
params.data ListData previously saved data
params.config object user config for Tool
params.api object Editor.js API
params.readOnly boolean read-only mode flag

ordered.nodes

HTML nodes used in tool

Kind: instance property of Ordered

ordered.defaultListStyle

This list-style will be used by default

Kind: instance property of Ordered

ordered.caret

Instantiate caret helper

Kind: instance property of Ordered

ordered.listStyle ⇒ string

Get list style name

Kind: instance property of Ordered

ordered.listStyle

Set list style

Kind: instance property of Ordered

Param Type Description
style string new style to set

ordered.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Ordered

ordered.nodes

HTML nodes used in tool

Kind: instance property of Ordered

ordered.defaultListStyle

This list-style will be used by default

Kind: instance property of Ordered

ordered.caret

Instantiate caret helper

Kind: instance property of Ordered

ordered.listStyle ⇒ string

Get list style name

Kind: instance property of Ordered

ordered.listStyle

Set list style

Kind: instance property of Ordered

Param Type Description
style string new style to set

ordered.currentItem ⇒ Element

Returns current List item by the caret position

Kind: instance property of Ordered

ordered.render() ⇒ Element

Returns list tag with items

Kind: instance method of Ordered
Access: public

ordered.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Ordered
Access: public

ordered.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Ordered

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

ordered.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Ordered

Param Type Description
content string item content to render
[items] Array.<ListItem> children

ordered.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Ordered

ordered.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Ordered

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

ordered.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Ordered

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

ordered.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

ordered.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Ordered

ordered.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Ordered

Param Type Description
item Element item wrapper ()

ordered.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Ordered

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

ordered.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Ordered

ordered.backspace(event)

Handle backspace

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

ordered.addTab(event)

Add indentation to current item

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

ordered.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

ordered.render() ⇒ Element

Returns list tag with items

Kind: instance method of Ordered
Access: public

ordered.renderSettings() ⇒ Element

Creates Block Tune allowing to change the list style

Kind: instance method of Ordered
Access: public

ordered.appendItems(items, parentItem) ⇒ void

Renders children list

Kind: instance method of Ordered

Param Type Description
items Array.<ListItem> items data to append
parentItem Element where to append

ordered.createItem(content, [items]) ⇒ Element

Renders the single item

Kind: instance method of Ordered

Param Type Description
content string item content to render
[items] Array.<ListItem> children

ordered.save() ⇒ ListData

Extracts tool's data from the DOM

Kind: instance method of Ordered

ordered.addChildrenList(parentItem, items)

Append children list to passed item

Kind: instance method of Ordered

Param Type Description
parentItem Element item that should contain passed sub-items
items Array.<ListItem> sub items to append

ordered.makeListWrapper([style], [classes]) ⇒ HTMLOListElement | HTMLUListElement

Creates main or tag depended on style

Kind: instance method of Ordered

Param Type Description
[style] string 'ordered' or 'unordered'
[classes] Array.<string> additional classes to append

ordered.enterPressed(event) ⇒ void

Handles Enter keypress

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

ordered.unshiftItem() ⇒ void

Decrease indentation of the current item

Kind: instance method of Ordered

ordered.getItemContent(item) ⇒ string

Return the item content

Kind: instance method of Ordered

Param Type Description
item Element item wrapper ()

ordered.focusItem(item, atStart) ⇒ void

Sets focus to the item's content

Kind: instance method of Ordered

Param Type Default Description
item Element item () to select
atStart boolean true where to set focus: at the start or at the end

ordered.getOutOfList() ⇒ void

Get out from List Tool by Enter on the empty last item

Kind: instance method of Ordered

ordered.backspace(event)

Handle backspace

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

ordered.addTab(event)

Add indentation to current item

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

ordered.shiftTab(event) ⇒ void

Reduce indentation for current item

Kind: instance method of Ordered

Param Type Description
event KeyboardEvent keydown

Ordered.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Ordered

Ordered.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Ordered
Access: public

Ordered.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Ordered

Ordered.isReadOnlySupported ⇒ boolean

Notify core that read-only mode is supported

Kind: static property of Ordered

Ordered.enableLineBreaks ⇒ boolean

Allow to use native Enter behaviour

Kind: static property of Ordered
Access: public

Ordered.toolbox ⇒ Object

Get Tool toolbox settings icon - Tool icon's SVG title - title to show in toolbox

Kind: static property of Ordered

PageSchema

Kind: global class

UserSchema

Kind: global class

JournalSchema

Kind: global class

DailySchema

Kind: global class

range ⇒ Range | null

Returns the first range

Kind: global variable

express

express module

Kind: global constant

connectDB()

Connect to MongoDB database

Kind: global function

/calendar(URL, ensureAuth, middleware)

Month view

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/calendar(URL, ensureGuest, middleware)

Login page

Kind: global function

Param Type Description
URL string Express path
ensureGuest callback Ensure user not enter the page before login
middleware callback Express middleware.

/main(URL, ensureAuth, middleware)

Responds with a list of all journals belonging to the user (json)

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/calendar/journals(URL, ensureAuth, middleware)

Responds with a list of all journals belonging to the user (json)

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/journal/:id(URL, ensureAuth, middleware)

Get a specific journal from its id

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/:id/pages(URL, ensureAuth, middleware)

Gets the pages of a specific journal

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/page/:id(URL, ensureAuth, middleware)

Get a specific page from a specific journal

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/page/:id/fetch(URL, ensureAuth, middleware)

Get a specific page from a specific journal

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/daily/:id(URL, ensureAuth, middleware)

Get a specific daily from its id

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/daily/:month/:date/:year(URL, ensureAuth, middleware)

Get a specific daily by month-date-year

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/daily/:month/:year(URL, ensureAuth, middleware)

Gets all dailies based on month and year

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/journal(URL, ensureAuth, middleware)

Creates a new journal from a post request

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/post/journal/:id(URL, ensureAuth, middleware)

Creates a page in the specified journal from a post request

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/daily(URL, ensureAuth, middleware)

Creates a new daily object

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/page/:id(URL, ensureAuth, middleware)

Updates a page given its id

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/daily/:id(URL, ensureAuth, middleware)

Updates a daily given its _id

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/journal/:id(URL, ensureAuth, middleware)

Deletes a journal given its _id

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/page/:id(URL, ensureAuth, middleware)

Deletes a page given its _id

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/daily/:id(URL, ensureAuth, middleware)

Deletes a daily given its _id

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/daily/:month/:date/:year(URL, ensureAuth, middleware)

Deletes a daily given the month-date-year

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/add/journal(URL, ensureAuth, middleware)

Add a new journal

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/main/add/:journalId/page(URL, ensureAuth, middleware)

Add a page to a specific journal

Kind: global function

Param Type Description
URL string Express path
ensureAuth callback Ensure user security when refreshing the page
middleware callback Express middleware.

/auth/google(URL, middleware)

Auth w Google

Kind: global function

Param Type Description
URL string Express path
middleware callback Express middleware.

/auth/google/callback(URL, middleware)

Callback function after login

Kind: global function

Param Type Description
URL string Express path
middleware callback Express middleware.

/auth/logout(URL, middleware)

Logout user

Kind: global function

Param Type Description
URL string Express path
middleware callback Express middleware.

createCalendar(calendar, element, adjuster)

Creates a calendar

Kind: global function

Param Type
calendar Calendar
element Element
adjuster *

createCalendar~AddDateTime()

Creates today's date, next/prev month button in the HTML

Kind: inner method of createCalendar

createCalendar~AddLabels()

Adds weekday labels to the HTML

Kind: inner method of createCalendar

createCalendar~AddDays()

Add days to the HTML

Kind: inner method of createCalendar

AddDays~DayNumber(n) ⇒ number

Create Number Element

Kind: inner method of AddDays

Param Type
n int

calendar(el, data)

Create calendar

Kind: global function

Param Type Description
el Element html element
data Event array of events

fetchEvents(month, year)

Fetches events for a specified month and year and calls the calendar function. This function should only called once on page load.

Kind: global function

Param Type
month *
year *

fetchevents(month, year, calendar, element, adjuster)

Fetches events for a specified month and year. Replaces old calendar with a new calendar. Adjuster is used to view the previous or next month.

Kind: global function

Param Type
month *
year *
calendar *
element *
adjuster *

changeFont(the)

Changes the font of the app

Kind: global function

Param Type Description
the selectTag selection made

toggledarkmode()

Changes the background of the app

Kind: global function

save() ⇒ void

Saves caret position using hidden

Kind: global function

restore() ⇒ void

Restores the caret position saved by the save() method

Kind: global function

extractFragmentFromCaretPositionTillTheEnd() ⇒ DocumentFragment | void

Extract content fragment from Caret position to the end of contenteditable element

Kind: global function

focus(element, atStart) ⇒ void

Set focus to contenteditable or native input element

Kind: global function

Param Type Default Description
element HTMLElement element where to set focus
atStart boolean true where to set focus: at the start or at the end

isAtStart() ⇒ void

Check if the caret placed at the start of the contenteditable element

Kind: global function

getHigherLevelSiblings(from, direction) ⇒ Array.<HTMLElement>

Get all first-level (first child of [contenteditabel]) siblings from passed node Then you can check it for emptiness

Kind: global function

Param Type Default Description
from HTMLElement element from which siblings should be searched
direction 'left' | 'right' left direction of search

Example

<div contenteditable>
<p></p>                            |
<p></p>                            | left first-level siblings
<p></p>                            |
<blockquote><a><b>adaddad</b><a><blockquote>       <-- passed node for example <b>
<p></p>                            |
<p></p>                            | right first-level siblings
<p></p>                            |
</div>

make(tagName, classNames, attributes) ⇒ Element

Helper for making Elements with attributes

Kind: global function

Param Type Description
tagName string new Element tag name
classNames Array | string list or name of CSS classname(s)
attributes object any attributes

fragmentToString(fragment) ⇒ string

Returns the HTML content of passed Document Fragment

Kind: global function

Param Type Description
fragment DocumentFragment document fragment to process

isEmpty(node) ⇒ boolean

Pushes to stack all DOM leafs and checks for emptiness

Kind: global function

Param Type Description
node Node node to check

isEmpty~content

Don't count s as content

Kind: inner property of isEmpty

ListData : object

Kind: global typedef
Properties

Name Type Description
style string list type 'ordered' or 'unordered'
items Array.<ListItem> list of first-level elements

ListItem : object

Kind: global typedef
Properties

Name Type Description
content string list item text content
items Array.<ListItem> sublist items

ListData : object

Kind: global typedef
Properties

Name Type Description
style string list type 'ordered' or 'unordered'
items Array.<ListItem> list of first-level elements

ListItem : object

Kind: global typedef
Properties

Name Type Description
content string list item text content
items Array.<ListItem> sublist items