ButtonUnorderedlist Class
The ButtonUnorderedlist class provides functionality for creating unordered lists in an editor.
Index
Methods
Methods
componentWillMount
()
Lifecycle. Invoked once, both on the client and server, immediately before the initial rendering occurs.
componentWillUnmount
()
Lifecycle. Invoked immediately before a component is unmounted from the DOM.
execCommand
-
data
Executes a CKEditor command and fires actionPerformed event.
Parameters:
-
dataObject=Optional data to be passed to CKEDITOR's
execCommandmethod.
getDefaultProps
()
Object
Lifecycle. Returns the default values of the properties used in the widget.
Returns:
The default properties.
getStateClasses
()
String
Returns the list of state classes associated to the current element's state, according to the results of the isActive and isDisabled methods.
Returns:
A string with the state CSS classes.
getStyle
()
CKEDITOR.style
Returns instance of CKEDITOR.style which represents the current button style.
Returns:
The current style representation.
isActive
()
Boolean
Checks if style is active in the current selection.
Returns:
True if style is active, false otherwise.
render
()
Object
Lifecycle. Renders the UI of the button.
Returns:
The content which should be rendered.
Properties
command
String
The command that should be executed.
editor
Object
The editor instance where the component is being used.
key
String
static
The name which will be used as an alias of the button in the configuration.
Default: ul
label
String
The label that should be used for accessibility purposes.
modifiesSelection
Boolean
Indicates that the command may cause the editor to have a different.
style
Object | String
The style the button should handle. Allowed values are:
- Object as described by http://docs.ckeditor.com/#!/api/CKEDITOR.style.
- String pointing to an object inside the editor instance configuration. For example,
style = 'coreStyles_bold'will try to retrieve the style object fromeditor.config.coreStyles_bold. Nested properties such asstyle = 'myplugin.myConfig.myStyle'are also supported and will try to retrieve the style object from the editor configuration as well.
tabIndex
Number
The tabIndex of the button in its toolbar current state. A value other than -1 means that the button has focus and is the active element.