Skip to content

Spotlight

Non-Visible component
Category Requires Version
User Interface API 19, Android 4.4 - 4.4.4 KitKat 2

Overview

A non-visible component that brings emphasis to the specified component by means of darkening the screen around that component.

Events

Clicked

Event triggered when the spotlight is clicked.

Methods

Show Spotlight

Use this block to show the spotlight.

Show Spotlight On FAB

Use this block to show the spotlight on a floating action button.

Params
floating Action Button Component

Properties

Circle Padding

Number Default: 20 ➖ Read Write - Designer Blocks

The padding for the circle spotlight. Default is '20'.

Component

Component ➖ Read Write - Designer Blocks

The component to show in the spotlight.

Dismiss On Back Press

Boolean Default: True ➖ Read Write - Designer Blocks

Dismiss the spotlight on back pressed.

Dismiss On Touch

Boolean Default: True ➖ Read Write - Designer Blocks

Dismiss the spotlight on touch

Enable Dismiss After Shown

Boolean Default: True ➖ Read Write - Designer Blocks

Dismiss spotlight on touch after spotlight is completely visible.

Enable Reveal Animation

Boolean Default: True ➖ Read Write - Designer Blocks

Enable reveal animation (Only for Lollipop and above).

Fadein Text Duration

Number Default: 400 ➖ Read Write - Designer Blocks

Fade in animation duration for spotlight text (Heading and Sub-heading).

Font Heading Typeface

Number Default: 0 ➖ Write - Designer

Font Heading Typeface Import

Available as Advanced Property

Text ➖ Write - Designer Blocks

Set a custom font.

Font Subheading Typeface

Number Default: 0 ➖ Write - Designer

Font Subheading Typeface Import

Available as Advanced Property

Text ➖ Write - Designer Blocks

Set a custom font.

Heading Text

Text ➖ Read Write - Designer Blocks

The Spotlight heading text.

Heading Text Color

Color Default: #3F51B5FF  ➖ Read Write - Designer Blocks

The Spotlight heading text color.

Heading Text Size

Number Default: 32 ➖ Read Write - Designer Blocks

The Spotlight heading size.

Intro Animation Duration

Number Default: 400 ➖ Read Write - Designer Blocks

Intro animation duration (For Reveal and Fadein).

Line And Arc Color

Color Default: #3F51B5FF  ➖ Read Write - Designer Blocks

The Spotlight line and arc color.

Line Animation Duration

Number Default: 400 ➖ Read Write - Designer Blocks

Line animation duration

Mask Color

Color Default: #000000be  ➖ Read Write - Designer Blocks

The Spotlight mask color

Show Target Arc

Boolean Default: True ➖ Read Write - Designer Blocks

If set to true you will see a half round circle below the spotlight circle.

Subheading Text

Text ➖ Read Write - Designer Blocks

The Spotlight subheading text.

Subheading Text Color

Color Default: #FFFFFFFF  ➖ Read Write - Designer Blocks

The Spotlight subheading text color.

Subheading Text Size

Number Default: 16 ➖ Read Write - Designer Blocks

The Spotlight subheading text size.


Last update: January 27, 2020