Skip to main content

UIControl

Class

Class in the Lens Scripting API.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

TypeScript only

Index

Constructors

Constructor

new UIControl(): UIControl

Returns

UIControl

Properties

hint

protected hint: string


label

protected label: string


showIf

protected showIf: string


showIfValue

protected showIfValue: string | number | boolean


widget

protected widget: UIWidget

Methods

addExportRequired()

addExportRequired(exportRequired): this

Parameters

ParameterType
exportRequiredboolean

Returns

this


addHint()

addHint(hint): this

Parameters

ParameterType
hintstring

Returns

this


addLabel()

addLabel(label): this

Parameters

ParameterType
labelstring

Returns

this


addShowIf()

addShowIf(showIf, showIfValue?): this

Parameters

ParameterType
showIfstring
showIfValue?string | number | boolean

Returns

this


addWidget()

addWidget(widget): this

Parameters

ParameterType
widgetUIWidget

Returns

this


getShowIf()

getShowIf(): string

Returns

string


getShowIfValue()

getShowIfValue(): string | number | boolean

Returns

string | number | boolean


toString()

toString(): string

Returns

string

Nested types

Classes