From Documentation

(Difference between revisions)
Jump to: navigation, search
m (Next)
m (Supported Events)
 
Line 95: Line 95:
Denotes that the user has opened or closed a component.
Denotes that the user has opened or closed a component.
-
Note: unlike <tt>onClose</tt>, this event is only a notification. The client sends this event after opening or closing the component.
+
Note: unlike <tt>onClose</tt>, this event is only a notification. The client sends this event after the component is opened or closed.
|-
|-
| <center><tt>onTargetClick</tt></center>
| <center><tt>onTargetClick</tt></center>

Latest revision as of 02:48, 29 November 2019





Contents

Coachmark

  • Available for ZK:
  • http://www.zkoss.org/product/zkhttp://www.zkoss.org/whyzk/zkeeVersion ee.png
[ since 9.0.0 ]

Employment/Purpose

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.

Example

Coachmark-2.png
<zk>
	<button id="button" label="Information"></button>
	<coachmark target="button" position="before_center">
		<label>Wellcome! click here for more information!</label>
		<button style="display: block;margin: 10px auto 0" label="got it!"></button>
	</coachmark>
</zk>


Supported Browsers

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

Open / Close the Coachmark

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


Properties

Target

The target component that the Coachmark will point itself to.

Example

Coachmark-1.png
<zk>
	<button id="button" label="button"></button>
	<coachmark target="button">
		<label>Wellcome!</label>
	</coachmark>
</zk>

Position

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

Next

The next coachmark which will be opened when the onTargetClick event or the next() method is called.

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

Methods

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

Name
Event Type
onOpen
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.

onTargetClick
Event: MouseEvent

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

Supported Children

*ALL

Version History

Last Update : 2019/11/29


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




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