ui.hint

Since 5.0

A handy tool that helps users to navigate through complex websites or apps.

The Hint widget is based on Webix view. It is used to give instructions to users while they explore a complex website or an application by rendering step-by-step hints for them.

Check Hint documentation for more details.

Constructor

var hint = webix.ui({
    view: "hint",
    id: "hint",
    steps: [
        {
            el: ".div1",
            title: "Welcome to Booking App!",
            text: "Click here to check out regular flights",
            event:"click"
        },
        {
            el: ".div2",
            title: "Get Flights Info in a Click!",
            text: "Click here to take a look at all flights info",
            event:"click"
        }
    ]
});

Where to start

• Overview of the Hint Widget
• Samples

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
end	ends displaying of hints
getChildViews	returns child views of the calling component
getCurrentStep	returns the number of the Hint's current step
getFormView	returns master form for the input
getNode	returns the main HTML container for the calling object
getParentView	returns the parent view of the component
getSteps	returns an array of step objects within Hint
getTopParentView	returns the top parent view
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
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
resume	resumes showing Hint from the specified step
setSteps	initializes the Hint component with an array of steps
show	makes the component visible
start	starts showing hints from the beginning
unbind	breaks "bind" link
unblockEvent	cancels events blocking that was enabled by the 'blockEvent' command

onAfterScroll	occurs when some webix view has been scrolled
onAfterStart	fires after the first hint step is shown
onBeforeStart	fires before the first hint step 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
onEnd	fires after the user views the last hint
onEnter	fires when the Enter key has been pressed
onFocus	fires when a view gets focus
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
onNext	fires when a user clicks the Next button or completes the action of the current step
onPrevious	fires when the Previous button is clicked
onSkip	fires when the hint is closed
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
onViewResize	fires when the size of a view has been changed by resizer
onViewShow	fires when any hidden view is shown

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 that will be applied to the view container or the object with styles
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
keyPressTimeout	a delay between the key press and the action
left	sets the left position of the step
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
nextButton	sets the Next button or changes its name
on	allows attaching custom handlers to inner events of the component
prevButton	sets the Previous button or changes its name
stepTimeout	time of a step displaying before showing the next one
steps	an array of objects that define the look and behavior on each of the steps
top	sets the top position of the step
width	sets the width of a widget

$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