Class Viewer

Shows markdown as HTML, without the editing code; see docs/viewer.md.

Index

Constructors

Methods

setMarkdown setTheme on off addHook destroy isViewer isMarkdownMode isWysiwygMode

Constructors

constructor

new Viewer(options: ViewerOptions): Viewer
Parameters
- options: ViewerOptions
Returns Viewer
- Defined in src/editor/viewer.ts:32

Methods

setMarkdown

setMarkdown(markdown: string): void
Parameters
- markdown: string
Returns void
- Defined in src/editor/viewer.ts:112

setTheme

setTheme(theme: string): void
light, dark or a custom theme, styled through the uf-{theme} class
Parameters
- theme: string
Returns void
- Defined in src/editor/viewer.ts:123

on

on(type: EventName, handler: Handler): void
Parameters
- type: EventName
- handler: Handler
Returns void
- Defined in src/editor/viewer.ts:138

off

off(type: EventName): void
Removes all the handlers of an event.
Parameters
- type: EventName
Returns void
- Defined in src/editor/viewer.ts:143

addHook

addHook(type: string, handler: Handler): void
Replaces the handler of a hook.
Parameters
- type: string
- handler: Handler
Returns void
- Defined in src/editor/viewer.ts:148

destroy

destroy(): void
Returns void
- Defined in src/editor/viewer.ts:153

isViewer

isViewer(): boolean
Returns boolean
- Defined in src/editor/viewer.ts:158

isMarkdownMode

isMarkdownMode(): boolean
Returns boolean
- Defined in src/editor/viewer.ts:162

isWysiwygMode

isWysiwygMode(): boolean
Returns boolean
- Defined in src/editor/viewer.ts:166