ui.richtext

Since 4.1

A rich text editor widget for entering and editing text.

Webix RichText is a widget that provides a WYSIWYG editing area for entering and formatting text.

Check RichText documentation for more details.

Constructor

var richtext = webix.ui({
    view: "richtext",
    id:"richtext1",
    label:"Mytext",
    labelPosition:"top"
});

Where to start

Methods
adjust adjusts the component to the size of the parent HTML container
attachEvent attaches the handler to an inner event of the component
bind binds components
blockEvent temporarily blocks triggering of ALL events of the calling object
callEvent calls an inner event
define redefines a single configuration property (or a object with properties)
destructor destructs the calling object
detachEvent detaches a handler from an event (which was attached before by the attachEvent method)
disable disables the calling view (makes it dimmed and unclickable)
enable enables the calling view that was disabled by the 'disable' method
focus sets focus to the richtext
getChildViews returns child views of the calling component
getFormView returns master form for the input
getInputNode gets the HTML element related to the component
getNode returns the main HTML container for the calling object
getParentView returns the parent view of the component
getTopParentView returns the top parent view
getValue returns the current value of the richtext editor
hasEvent checks whether the component has the specified event handler
hide hides the view
innerId returns the inner ID of an item by its public (real) ID
isEnabled checks whether the view is enabled
isVisible checks whether the view is visible
mapEvent routes events from one object to another
queryView returns inner element/elements of a widget that correspond(s) to the defined parameters
refresh repaints richtext editor
resize adjusts the view to a new size
setValue sets a new value for the richtext control
show makes the component visible
ui allows creating a new UI, the ID of which will be locked in the parent ID space
unbind breaks "bind" link
unblockEvent cancels events blocking that was enabled by the 'blockEvent' command
Events
onBindRequest fires when the component is ready to receive data from the master component
onChange fires when data in the input of the related form/toolbar is changed
onDestruct occurs when component destroyed
onViewShow fires when any hidden view is shown
Properties
animate defines the type of animation, with which the view is shown, if it is a Multiview cell
borderless used to hide the component borders
container an HTML container (or its ID) where the component should be initialized
css the name of the CSS class or the object with styles that will be applied to the view container
disabled indicates whether an item is enabled
gravity sets the view gravity
height sets the height of the component
hidden defines whether the view will be hidden initially
id the ID of a widget
label the text label of the rich text editor
labelPosition positions a label in relation to the control
labelWidth the width of the label
maxHeight sets the maximum height for the view
maxWidth sets the maximum width for the view
minHeight sets the minimal height for the view
minWidth sets the minimal width for the view
on allows attaching custom handlers to inner events of the component
padding defines the space between the element borders and content (applies the specified value to all sides).
paddingX sets the right and left padding (applies the specified value to both sides)
paddingY sets the top and bottom padding (applies the specified value to both sides)
type defines the layout borders
value sets the initial value for the RichText control
width sets the width of a widget
Other
$$ locates sub-item by id
$getSize returns the current size of the component
$height the current height of the view
$prepareValue adjusts the value that is going to be set to the format expected by the control
$setNode defines HTML element for the component
$setSize sets the component size
$skin the method which will be called when skin is defined
$view reference to the top HTML element of the view
$width the current width of the view
config all options from the initial component configuration
name indicates the name of the component (a read-only property)
Back to top