CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 4/API
Class

CKEDITOR.dialog.definition.textInput

class
See source

The definition of a text field (single line).

This class is not really part of the API. It just illustrates the properties that developers can use to define and create text fields.

Once the dialog is opened, the created element becomes a CKEDITOR.ui.dialog.textInput object and can be accessed with CKEDITOR.dialog.getContentElement.

For a complete example of dialog definition, please check CKEDITOR.dialog.add.

// There is no constructor for this class, the user just has to define an
// object with the appropriate properties.

{
    type: 'text',
    id: 'name',
    label: 'Your name',
    'default': '',
    validate: function() {
        if ( !this.getValue() ) {
            api.openMsgDialog( '', 'Name cannot be empty.' );
            return false;
        }
    }
}

Filtering

Properties

  • align : String

    See source

    Horizontal alignment (in the container) of the UI element.

  • bidi : Boolean

    See source

    Whether the text direction of this input should be togglable using the following keystrokes:

    • Shift+Alt+End – switch to Right-To-Left,
    • Shift+Alt+Home – switch to Left-To-Right.

    By default the input will be loaded without any text direction set, which means that the direction will be inherited from the editor's text direction.

    If the direction was set, a marker will be prepended to every non-empty value of this input:

    • \u202A – for Right-To-Left,
    • \u202B – for Left-To-Right.

    This marker allows for restoring the same text direction upon the next dialog opening.

  • className : String

    See source

    CSS class names to append to the UI element.

  • commit : Function

    See source

    Function to execute whenever the UI element's parent dialog's CKEDITOR.dialog.commitContent method is executed. It usually takes care of the respective UI element as a standalone element.

  • since 3.6.1

    controlStyle : String

    See source

    Specify the inline style of the input element container.

    {
    type: 'text',
    label: 'My Label',
    controlStyle: 'width: 3em'
}

  • default : String

    See source

    The default value.

  • id : String

    See source

    The ID of the UI element.

  • since 3.6.1

    inputStyle : String

    See source

    Specify the inline style of the input element.

    {
    type: 'text',
    label: 'My Label',
    inputStyle: 'text-align: center'
}

  • label : String

    See source

    The label of the UI element.

    {
    type: 'text',
    label: 'My Label'
}

  • labelLayout : String

    See source

    (Optional) Specify the layout of the label. Set to 'horizontal' for horizontal layout. The default layout is vertical.

    {
    type: 'text',
    label: 'My Label',
    labelLayout: 'horizontal'
}

  • labelStyle : String

    See source

    Specify the inline style of the uiElement label.

    {
    type: 'text',
    label: 'My Label',
    labelStyle: 'color: red'
}

  • maxLength : Number

    See source

    (Optional) The maximum length.

  • onHide : Function

    See source

    Function to execute whenever the UI element's parent dialog is closed.

  • onLoad : Function

    See source

    Function to execute the first time the UI element is displayed.

  • onShow : Function

    See source

    Function to execute whenever the UI element's parent dialog is displayed.

  • requiredContent : String | Object | style

    See source

    The content that needs to be allowed to enable this UI element. All formats accepted by CKEDITOR.filter.check may be used.

    When all UI elements in a tab are disabled, this tab will be disabled automatically.

  • setup : Function

    See source

    Function to execute whenever the UI element's parent dialog's CKEDITOR.dialog.setupContent method is executed. It usually takes care of the respective UI element as a standalone element.

  • size : Number

    See source

    (Optional) The size of the input field.

  • style : String

    See source

    Inline CSS classes to append to the UI element.

  • title : String

    See source

    The popup label of the UI element.

  • type : String

    See source

    The type of the UI element. Required.

  • validate : Function

    See source

    (Optional) The validation function.

  • widths : Array

    See source

    (Optional) Applies only to horizontal layouts: a two elements array of lengths to specify the widths of the label and the content element. See also labelLayout.

    {
    type: 'text',
    label: 'My Label',
    labelLayout: 'horizontal',
    widths: [100, 200]
}