Class: SquibView

The main editor class that provides a live-rendering editor for various content types.

Constructor

newSquibView(element, options)

Parameters

Example

// Create editor with default optionsconst editor = newSquibView('#editor');

// Create editor with custom optionsconst editor = newSquibView('#editor', {
  initialContent: '# Hello World',
  inputContentType: 'md',
  initialView: 'split',
  showControls: true,
  showLineNumbers: true
});

Static Properties

SquibView.version

Returns version information for the library.

console.log(SquibView.version);
// { version: '1.0.18', url: 'https://github.com/...' }

SquibView.defaultOptions

Default configuration options for new instances.

{
  initialContent: '',
  inputContentType: 'md',
  showControls: true,
  titleShow: false,
  titleContent: '',
  initialView: 'split',
  baseClass: 'squibview',
  preserveImageTags: true,
  showLineNumbers: false,
  lineNumberStart: 1,
  lineNumberMinDigits: 2,
  autoload_deps: null
}

SquibView.DEFAULT_CDN_URLS

Default CDN URLs for autoloading external dependencies.

Instance Properties

Core Methods

Content Management

• setContent(content, contentType, saveRevision) - Set editor content
• getContent() - Get current source content
• getRenderedHTML() - Get rendered HTML output
• clearContent() - Clear all content

View Control

• setView(view) - Change view mode
• toggleView() - Cycle through view modes
• showSource() - Show source view only
• showHTML() - Show rendered view only
• showSplit() - Show split view

Content Type

• setContentType(type) - Change content type
• getContentType() - Get current content type

Revision Management

• undo() - Undo last change
• redo() - Redo previously undone change
• canUndo() - Check if undo is available
• canRedo() - Check if redo is available
• getRevisionCount() - Get number of saved revisions

Selection & Copy

• copyToClipboard(copyMode) - Copy content to clipboard
• getSelectedText() - Get currently selected text
• getSelectionData() - Get detailed selection information
• setOnReplaceSelectedText(handler) - Set text replacement handler

Renderer System

• registerRenderer(type, config) - Register custom renderer
• render() - Manually trigger rendering

Events

• on(event, handler) - Subscribe to event
• off(event, handler) - Unsubscribe from event
• emit(event, data) - Emit custom event

Events

See Events Documentation for complete event reference.

Core Events

• content-change - Content has changed
• view-change - View mode has changed
• type-change - Content type has changed
• render - Content has been rendered
• selection-change - Text selection has changed
• revision-added - New revision saved
• undo - Undo performed
• redo - Redo performed

See Also

• Methods Reference
• Options Reference
• Events Reference
• Examples