From Documentation


Since 9.0.0

  • Available for ZK:
  • ee.png


Coachmark is used to attract users' attention to the target component and display a dialog. Once a coachmark is opened, the background mask will be displayed and the target component will be highlighted.The content of coachmark should be as relevant as possible to the context. You can use more than one coachmarks to guide users to perform a series of operations in the desired order.



    <button id="infoButton" label="Information" />
    <coachmark target="infoButton" onTargetClick="self.close()">
        <label>Wellcome! click here for more information!</label>
        <button style="display: block;margin: 10px auto 0" label="got it!" onClick="self.parent.close()"/>

Multiple Steps

 1         <button label="Step 1" sclass="big-margin"/>
 2         <coachmark target="${self.previousSibling}" next="mark2" onTargetClick="" >
 3             click here
 4         </coachmark>
 5         <button id="s2" label="Step 2" sclass="big-margin"/>
 6         <coachmark id="mark2" target="${self.previousSibling}" next="mark3" onTargetClick="" visible="false">
 7             click here
 8         </coachmark>
 9         <button label="Step 3" sclass="big-margin"/>
10         <coachmark id="mark3" target="${self.previousSibling}" onTargetClick="" visible="false">
11             click here
12         </coachmark>
  • Line 2: need to specify next and onTargetClick

Supported Browsers

This component uses CSS keyframes. Browsers that support CSS keyframes (IE10+, Edge, Chrome, Firefox, Safari) are compatible with this feature. Please check browser compatibility.

Open / Close the Coachmark

By default, a Coachmark opens itself after a page loading without user interaction. If you want to open a Coachmark in a specific timing, please set visible="false".

Both visible attribute and open/close methods allow you to open or close the Coachmark.



The target component that the Coachmark will point itself to. You need to specify a component's id or an EL expression that resolved to a component e.g. ${self.previousSibling}

	<button id="infoButton" label="button"/>
	<coachmark target="infoButton">


The positions of a coachmark(default: after_center). Here are the available options:

start/before center end/after
top before_start before_center before_end
bottom after_start after_center after_end
left start_before start_center start_after
right end_before end_center end_after


The next Coachmar which will be opened when the onTargetClick event or the next() method is called. You need to specify a Coachmark's id or an EL expression that resolved to a Coachmark e.g. ${self.previousSibling}

Note: if you call next(Coachmark coachmark), it will open the specified coachmark instead of the predefined "next" coachmark.


public void next() : Closes the current coachmark and opens the next one.

public void next(Coachmark coachmark) : Close the current coachmark and opens the one you passed. (ignore the next coachmark you already set)

Supported Events

Event Type
Event: OpenEvent

Denotes that the user has opened or closed a component.

Note: unlike onClose, this event is only a notification. The client sends this event after the component is opened or closed.

Event: MouseEvent

Represents an event caused by a user's click on a highlighted target component.

Supported Children


Version History

Last Update : 2022/09/20

Version Date Content
9.0.0 Nov, 2019 ZK-4382: Provide a Coachmark component

Last Update : 2022/09/20

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.