Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions docs/components/deprecated/chameleon-ad.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Chameleon Ad

{>> Non-Visible component<<}

| Category | Requires | Version |
|:--------:|:-------:|:--------:|
|**Deprecated**|<span class="chip chip-any">API 21, Android 5.0 Lollipop</span>|<span class="chip chip-number">1</span>|

!!! danger "Deprecated component"
This component is deprecated. Projects that still contain it will fail to build until it is removed. You can still load existing projects in the Designer and live-test them with the Companion while you migrate, but APK and AAB builds are blocked. Look for an up-to-date replacement in the active component palette.

## Overview

A non-visible component to show interstitial ads form the Chameleon Ads Network.

## Events

### Ad Closed

Event triggered when ads are closed.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Chameleon%20Ad%22,%20%22name%22:%20%22Ad%20Closed%22,%20%22param%22:%20%5B%5D%7D"></div>

### Ad Failed To Load

Event triggered when ads failed to load. Here is the list with all possible error codes (int) and error messages (string): '1' = The before loaded ad was not finished. It is not allowed to load a new one. The first must be in finished loading process. '2' = Ad failed to load. No internet connection available. '3' = Please enter a valid chameleon 'App ID'. '4' = Please enter a valid chameleon 'User ID'. '5' = UNKNOWN_WEB_VIEW_ERROR. '6' = There was an error validating the SSL Certificate.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Chameleon%20Ad%22,%20%22name%22:%20%22Ad%20Failed%20To%20Load%22,%20%22param%22:%20%5B%22error%20Message%22,%20%22error%20Code%22%5D%7D"></div>

| Params | []() |
|--------|------|
|error Message|<span class="chip chip-text">Text</span>|
|error Code|<span class="chip chip-number">Number</span>|

### Ad Failed To Show

Event triggered when ads failed to show. Here is the list with all possible error codes (int) and error messages (string): '1' = UNKNOWN_ERROR_ON_SHOW_AD. '2' = The ad must first be loaded. After loading finished the ad can be shown.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Chameleon%20Ad%22,%20%22name%22:%20%22Ad%20Failed%20To%20Show%22,%20%22param%22:%20%5B%22error%20Message%22,%20%22error%20Code%22%5D%7D"></div>

| Params | []() |
|--------|------|
|error Message|<span class="chip chip-text">Text</span>|
|error Code|<span class="chip chip-number">Number</span>|

### Ad Loaded

Event triggered when ads are loaded.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Chameleon%20Ad%22,%20%22name%22:%20%22Ad%20Loaded%22,%20%22param%22:%20%5B%5D%7D"></div>

## Methods

### Load Ad

Load a new interstitial chameleon ad.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Chameleon%20Ad%22,%20%22name%22:%20%22Load%20Ad%22,%20%22output%22:%20false,%20%22param%22:%20%5B%5D%7D"></div>

### Show Ad

Show a chameleon interstitial ad after it was loaded.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Chameleon%20Ad%22,%20%22name%22:%20%22Show%20Ad%22,%20%22output%22:%20false,%20%22param%22:%20%5B%5D%7D"></div>

## Properties

### App ID

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-text">Text</span> :heavy_minus_sign: <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

Input here your own Chameleon Ad 'App ID' (request one at my.kodular.io).

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Chameleon%20Ad%22,%20%22name%22:%20%22App%20ID%22,%20%22getter%22:%20false%7D"></div>

### Test Mode

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>False</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

If set to true, the device will receive test ads. This option must be set before you load a new ad.

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Chameleon%20Ad%22,%20%22name%22:%20%22Test%20Mode%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Chameleon%20Ad%22,%20%22name%22:%20%22Test%20Mode%22,%20%22getter%22:%20false%7D"></div>

### User ID

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-text">Text</span> :heavy_minus_sign: <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

Input here your own Chameleon Ad 'User ID' (get yours at my.kodular.io).

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Chameleon%20Ad%22,%20%22name%22:%20%22User%20ID%22,%20%22getter%22:%20false%7D"></div>
121 changes: 121 additions & 0 deletions docs/components/deprecated/fingerprint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# Fingerprint

{>> Non-Visible component<<}

| Category | Requires | Version |
|:--------:|:-------:|:--------:|
|**Deprecated**|<span class="chip chip-any">API 21, Android 5.0 Lollipop</span>|<span class="chip chip-number">1</span>|

!!! danger "Deprecated component"
This component is deprecated. Projects that still contain it will fail to build until it is removed. You can still load existing projects in the Designer and live-test them with the Companion while you migrate, but APK and AAB builds are blocked. Look for an up-to-date replacement in the active component palette.

## Overview

A non-visible component that reads fingerprints using the device''s in-built fingerprint scanner.

??? example "Permissions"
* [android.permission.USE_FINGERPRINT](https://developer.android.com/reference/android/Manifest.permission.html#USE_FINGERPRINT)

## Events

### On Authentication Error

Triggers when there is a Authentication Error

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22On%20Authentication%20Error%22,%20%22param%22:%20%5B%22error%20Id%22,%20%22message%22%5D%7D"></div>

| Params | []() |
|--------|------|
|error Id|<span class="chip chip-number">Number</span>|
|message|<span class="chip chip-text">Text</span>|

### On Authentication Failed

Triggers when the Authentication Failed

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22On%20Authentication%20Failed%22,%20%22param%22:%20%5B%5D%7D"></div>

### On Authentication Help

Triggers when there is a Authentication Help

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22On%20Authentication%20Help%22,%20%22param%22:%20%5B%22help%20Id%22,%20%22message%22%5D%7D"></div>

| Params | []() |
|--------|------|
|help Id|<span class="chip chip-number">Number</span>|
|message|<span class="chip chip-text">Text</span>|

### On Authentication Succeeded

Trigger when the Authentication Succeeded

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22On%20Authentication%20Succeeded%22,%20%22param%22:%20%5B%5D%7D"></div>

## Methods

### Authenticate

Authenticate the user with a Fingerprint scanner

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22Authenticate%22,%20%22output%22:%20false,%20%22param%22:%20%5B%5D%7D"></div>

### Cancel Scan

Cancel the current Fingerprint Scan

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22Cancel%20Scan%22,%20%22output%22:%20false,%20%22param%22:%20%5B%5D%7D"></div>

### Has Fingerprint Scanner

<span class="chip chip-boolean">Returns: <i>Boolean</i></span>

True if hardware is present and functional, false otherwise

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22Has%20Fingerprint%20Scanner%22,%20%22output%22:%20true,%20%22param%22:%20%5B%5D%7D"></div>

### Has Fingers Added

<span class="chip chip-boolean">Returns: <i>Boolean</i></span>

True if at least one fingerprint is enrolled, false otherwise

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22Has%20Fingers%20Added%22,%20%22output%22:%20true,%20%22param%22:%20%5B%5D%7D"></div>

## Properties

### Dialog Help Text

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-text">Text</span> <span class="chip chip-text">Default: <i>Scan your finger</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

Sets the dialog help text

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22Dialog%20Help%20Text%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22Dialog%20Help%20Text%22,%20%22getter%22:%20false%7D"></div>

### Dialog Title

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-text">Text</span> <span class="chip chip-text">Default: <i>Sign in with your fingerprint</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

Sets the dialog title

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22Dialog%20Title%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22Dialog%20Title%22,%20%22getter%22:%20false%7D"></div>

### Light Theme

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>False</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

Sets the current theme

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22Light%20Theme%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22Light%20Theme%22,%20%22getter%22:%20false%7D"></div>

### Use Dialog

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>True</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

Whether to use a dialog

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22Use%20Dialog%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Fingerprint%22,%20%22name%22:%20%22Use%20Dialog%22,%20%22getter%22:%20false%7D"></div>
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@

| Category | Requires | Version |
|:--------:|:-------:|:--------:|
|**Google**|<span class="chip chip-any">API 21, Android 5.0 Lollipop</span>|<span class="chip chip-number">4</span>|
|**Deprecated**|<span class="chip chip-any">API 21, Android 5.0 Lollipop</span>|<span class="chip chip-number">5</span>|

!!! danger "Deprecated component"
This component is deprecated. Projects that still contain it will fail to build until it is removed. You can still load existing projects in the Designer and live-test them with the Companion while you migrate, but APK and AAB builds are blocked. Look for an up-to-date replacement in the active component palette.

## Overview

Expand Down
110 changes: 110 additions & 0 deletions docs/components/deprecated/floating-button.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# Floating Button

{>> Non-Visible component<<}

| Category | Requires | Version |
|:--------:|:-------:|:--------:|
|**Deprecated**|<span class="chip chip-any">API 21, Android 5.0 Lollipop</span>|<span class="chip chip-number">1</span>|

!!! danger "Deprecated component"
This component is deprecated. Projects that still contain it will fail to build until it is removed. You can still load existing projects in the Designer and live-test them with the Companion while you migrate, but APK and AAB builds are blocked. Look for an up-to-date replacement in the active component palette.

## Overview

Floating Button Component to make a Floating Action Button on the right bottom of the screen

## Events

### Click

FAB Clicked

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Click%22,%20%22param%22:%20%5B%5D%7D"></div>

### Long Click

FAB Long Clicked

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Long%20Click%22,%20%22param%22:%20%5B%5D%7D"></div>

## Methods

### Create

Create FAB

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Create%22,%20%22output%22:%20false,%20%22param%22:%20%5B%5D%7D"></div>

## Properties

### Color

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-color">Color</span> <span class="chip chip-color">Default: <i>#00000000</i>&nbsp;<span style="width: 15px; height: 15px; margin: auto; display: inline-block; border: 1px solid white; vertical-align: middle; border-radius: 3px; background-color: #000000;"></span></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

Returns Color

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Color%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Color%22,%20%22getter%22:%20false%7D"></div>

### Icon

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-text">Text</span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

Returns Icon Path

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Icon%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Icon%22,%20%22getter%22:%20false%7D"></div>

### Is Created

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> - <span class="chip chip-bd">Blocks</span></span>

Is FAB created?

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Is%20Created%22,%20%22getter%22:%20true%7D"></div>

### Margin Bottom

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-number">Number</span> <span class="chip chip-number">Default: <i>8</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

Set Bottom Margin in dp, Default = 16

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Margin%20Bottom%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Margin%20Bottom%22,%20%22getter%22:%20false%7D"></div>

### Margin Right

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-number">Number</span> <span class="chip chip-number">Default: <i>8</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

Set Right Margin in dp, Default = 16

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Margin%20Right%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Margin%20Right%22,%20%22getter%22:%20false%7D"></div>

### Size

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-number">Number</span> <span class="chip chip-number">Default: <i>1</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

Set FAB Size
Set it to 1 for Normal size, 2 for Mini.

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Size%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Size%22,%20%22getter%22:%20false%7D"></div>

### Use Animation

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>True</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

Are animations on?

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Use%20Animation%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Use%20Animation%22,%20%22getter%22:%20false%7D"></div>

### Visible

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>True</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

Is FAB visible?

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Visible%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Floating%20Button%22,%20%22name%22:%20%22Visible%22,%20%22getter%22:%20false%7D"></div>
Loading
Loading