Zebble.CoachMarks

CoachMarks is a plugin for Zebble apps to show a brief help to the users.

Setup

• Available on NuGet: https://www.nuget.org/packages/Zebble.CoachMarks/
• Install in your platform client projects.
• Available for iOS, Android and UWP.
• After installing the Nuget copy this SCSS file to your project.
• Import the SCSS file to common.scss file.

@import "CoachMarks.scss";

• Call its mixin in the common.scss just like the other mixins.

@include coach-marks(45); // Your navbar height

• As it depends on PopOver, you should follow its setup steps as well.

Api Usage

var settings = new CoachMarksSettings
{
    DisableRealEvents = true,
    TopButtons = CoachMarksSettings.Buttons.Skip,
    BottomButtons = CoachMarksSettings.Buttons.Next | CoachMarksSettings.Buttons.Back
};

var coach = new CoachMarks(settings);

coach.CreateStep("Tap this button to skip this part.", SkipButton.Id);
coach.CreateStep("When you are not 100% sure tap this button.", NotSureButton.Id);
coach.CreateStep("You could find more feature here.", "MenuButton");

await coach.Show();

As the coaching would take time, it would be a good idea to call the Coach method without using await keyword when something is happening especialy in UI thread.

coach.Show().RunInParallel();

Setting

Property	Type	description
MoveOnByTime	bool	It is used for moving on the steps when the specific time passes.
Delay	TimeSpan	The specific time for the MoveOnByTime.
ElementPadding	int	The element you are pointed at for any steps would be held in a container and its the padding of the holder.
DisableRealEvents	bool	Disable the events to suppress any interaction in middle of the coach time.
TopButtons	CoachMarksSettings.Buttons	There are two default sections to add buttons (Skip, Next and Back).
BottomButtons	CoachMarksSettings.Buttons	There are two default sections to add buttons (Skip, Next and Back).

Properties

Property	Type	Android	iOS	Windows
IsCoaching	bool	x	x	x
Settings	CoachMarksSettings	x	x	x

Exception

Exception	Reason
InvalidOperationException	It happens when you call the Coach method while the coach is processing.

Methods

Method	Return Type	Parameters	Android	iOS	Windows
Show	Task	CancellationToken => cancellationToken	x	x	x
Hide	void		x	x	x
CreateStep	void	string => text, string => elementId	x	x	x