Skip to main content

Story

tw5-typed

tw5-typed / hooks / Story

Class: Story

Defined in: src/modules/story.d.ts:2

Constructors​

Constructor​

new Story(options?): Story

Defined in: src/modules/story.d.ts:7

Parameters​

options?​
historyTitle?​

string

storyTitle?​

string

wiki?​

Wiki

Returns​

Story

Properties​

historyTitle​

historyTitle: string

Defined in: src/modules/story.d.ts:5

storyTitle​

storyTitle: string

Defined in: src/modules/story.d.ts:4

wiki​

wiki: Wiki

Defined in: src/modules/story.d.ts:3

Methods​

addToHistory()​

addToHistory(navigateTo, navigateFromClientRect?): any

Defined in: src/modules/story.d.ts:29

Parameters​

string | string[]

DOMRect

Returns​

any

addToStory()​

addToStory(navigateTo, navigateFromTitle?, options?): any

Defined in: src/modules/story.d.ts:21

Parameters​

string

string

options?​
openLinkFromInsideRiver?​

"bottom" | "top" | "above" | "below"

Returns​

any

getStoryList()​

getStoryList(): string[]

Defined in: src/modules/story.d.ts:13

Returns​

string[]

navigateTiddler(navigateTo, navigateFromTitle?, navigateFromClientRect?): any

Defined in: src/modules/story.d.ts:15

Parameters​

string

string

DOMRect

Returns​

any

saveStoryList()​

saveStoryList(storyList): any

Defined in: src/modules/story.d.ts:34

Parameters​

storyList​

string | string[]

Returns​

any

storyCancelTiddler()​

storyCancelTiddler(targetTitle): any

Defined in: src/modules/story.d.ts:48

Parameters​

targetTitle​

string

Returns​

any

storyCloseAllTiddlers()​

storyCloseAllTiddlers(): any

Defined in: src/modules/story.d.ts:38

Returns​

any

storyCloseOtherTiddlers()​

storyCloseOtherTiddlers(targetTitle): any

Defined in: src/modules/story.d.ts:40

Parameters​

targetTitle​

string

Returns​

any

storyCloseTiddler()​

storyCloseTiddler(targetTitle): any

Defined in: src/modules/story.d.ts:36

Parameters​

targetTitle​

string

Returns​

any

storyDeleteTiddler()​

storyDeleteTiddler(targetTitle): any

Defined in: src/modules/story.d.ts:44

Parameters​

targetTitle​

string

Returns​

any

storyEditTiddler()​

storyEditTiddler(targetTitle): any

Defined in: src/modules/story.d.ts:42

Parameters​

targetTitle​

string

Returns​

any

storyNewTiddler()​

storyNewTiddler(targetTitle): any

Defined in: src/modules/story.d.ts:50

Parameters​

targetTitle​

string

Returns​

any

storySaveTiddler()​

storySaveTiddler(targetTitle): any

Defined in: src/modules/story.d.ts:46

Parameters​

targetTitle​

string

Returns​

any