ui.mentionsuggest
A suggest control with mentioning functionality.
Mentionsuggest is a list with suggestions for text auto-completion. It is most commonly used in Textarea (e.g. in the Comment widget) for inserting user names, tags, etc. into text. It can also be used for other input controls (e.g. TextHighlight, Text).
Check MentionSuggest documentation for more detailed description.
Constructor
webix.ui({
view:"textarea",
height:200,
width:500,
labelPosition:"top",
label:"Type some text here",
suggest:{
view:"mentionsuggest",
data:countries
}
});
Where to start
Based on:
ui.suggest,
ui.popup,
ui.window,
ui.view,
ui.baseview,
Settings,
Destruction,
BaseBind,
Movable,
Modality,
EventSystem,
ResizeArea
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 |
getBody | gets the UI view of the window body |
getChildViews | returns child views of the calling component |
getFormView | returns master form for the input |
getItemId | returns the id of the suggest's item |
getItemText | returns the rendered text of the suggest's item |
getList | returns list view of the suggest |
getMasterValue | returns current value of master control |
getNode | returns the main HTML container for the calling object |
getParentView | returns the parent view of the component |
getSuggestion | returns id of top suggestion from the suggest list |
getTopParentView | returns the top parent view |
getValue | gets the ID of a selected item in the option list |
hasEvent | checks whether the component has the specified event handler |
hide | hides the view |
isEnabled | checks whether the view is enabled |
isVisible | checks whether the view is visible |
linkInput | links a suggest list to an input field |
mapEvent | routes events from one object to another |
queryView | returns inner element/elements of a widget that correspond(s) to the defined parameters |
resize | adjusts the view to a new size |
resizeChildren | resizes all children of the calling component |
setMasterValue | set value in master control |
setPosition | sets window's position |
setValue | selects an item in the options list |
show | makes the component visible |
unbind | breaks "bind" link |
unblockEvent | cancels events blocking that was enabled by the 'blockEvent' command |
Events
onAfterScroll | occurs when some webix view has been scrolled |
onBeforeShow | fires right after show() method is called for the window (popup) and before the window is shown |
onBindRequest | fires when the component is ready to receive data from the master component |
onBlur | fires when focus is moved out of the view |
onDestruct | occurs when component destroyed |
onEnter | fires when the Enter key has been pressed |
onFocus | fires when a view gets focus |
onHide | fires when window is hidden |
onKeyPress | occurs when keyboard key is pressed for the control in focus |
onLongTouch | fires on holding finger in some position for a certain period of time |
onShow | fires when window is shown |
onSwipeX | occurs on a horizontal swipe movement |
onSwipeY | occurs on a vertical swipe movement |
onTimedKeyPress | fires after typing has been finished in the field |
onTouchEnd | occurs when the touch event is ended |
onTouchMove | occurs during touch movement |
onTouchStart | fires when some webix view has been touched |
onValueSuggest | some item selected in the suggest control |
onViewMove | fires while view is moving |
onViewMoveEnd | fires when view has stopped moving |
onViewResize | fires on resizing a view |
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 |
autofit | adjusts window size to the size of an html node it is initiated in |
autofocus | sets focus on the window the moment it appears on the page |
body | the content of window body: template, or a view configuration object |
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 |
data | JavaScript array containing data for the component |
disabled | indicates whether an item is enabled |
escHide | toggles default 'hide on escape' behaviour |
filter | custom filtering function |
fitMaster | adjusts the size of the suggest box to the master control |
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 |
input | points to an HTML input field that houses the suggest list |
keyPressTimeout | a delay between the key press and the action |
left | the left offset of the window |
master | the master component id (a read-only property) |
maxHeight | defines the maximum height of the view |
maxWidth | defines the maximum width of the view |
minHeight | sets the minimal height for the view |
minWidth | sets the minimal width for the view |
modal | switches window modality |
on | allows attaching custom handlers to inner events of the component |
padding | sets padding for all four sides of the widget |
point | adds an arrow to a popup window or removes it |
position | sets the position of the window relative to the the screen |
relative | positions a popup window relative to the component it's connected with |
resize | enables resizing of a widget |
symbol | sets a symbol for opening mentionsuggest |
template | template which will be used to fill parent input from selected record |
textValue | defines which field from suggest list will be used as text after selecting an option |
toFront | places window above other windows on clicking it |
top | the top offset of a window |
type | defines the type of the suggest control |
url | the URL which the component will use to load data after its initialization |
width | sets the width of a widget |
zIndex | the stack order of the component |
Other
$dragCreate | the method is called at the moment when drag-n-drop has started |
$dragDestroy | the method is called at the moment when drag-n-drop has ended |
$dragPos | defines the position of a dragged view |
$enterKey | the method that will be called when the Enter key is pressed |
$getSize | returns the current size of the component |
$height | the current height of the view |
$scope | scope for resolving event and method names |
$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