The NFC Reader mobile component
An interface to capture data from an NFC tag.
NFC Reader currently supports reading NDEF-formatted tags. Please reach out if your use case requires reading other NFC formats.
Settings
NFC Reader includes the following configurable options when building apps in the IDE.
| Content | LabelDataSuffix iconPrefix icon |
| Interaction | DisabledEvent handlers |
| Appearance | SizeShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStylesWidth |
Properties
All properties for NFC Reader with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
buttonSize
The size of the button.
Properties
event
The event type.
Values
0
A user changes the value.
1
A user clicks or taps the component.
2
A user submits the value.
3
A user selects the input field.
4
A user deselects the input field.
5
A user scans a barcode.
6
A user opens the component.
7
A user closes the component.
8
A user sets the value to true.
9
A user sets the value to false.
10
A user selects a value.
11
A user clears the value.
12
A user uploads a file.
13
An uploaded file is parsed.
14
A user changes the value of the input field.
change | A user changes the value. |
click | A user clicks or taps the component. |
submit | A user submits the value. |
focus | A user selects the input field. |
blur | A user deselects the input field. |
scan | A user scans a barcode. |
open | A user opens the component. |
close | A user closes the component. |
true | A user sets the value to |
false | A user sets the value to |
select | A user selects a value. |
clear | A user clears the value. |
upload | A user uploads a file. |
parse | An uploaded file is parsed. |
inputValueChange | A user changes the value of the input field. |
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
Values
0
Control query.
1
Control component.
2
Run script.
3
Set variable.
4
Set localStorage.
5
Perform utility action (e.g., Open URL or Confetti).
datasource | Control query. |
widget | Control component. |
script | Run script. |
state | Set variable. |
localStorage | Set localStorage. |
util | Perform utility action (e.g., Open URL or Confetti). |
Values
You can select an icon or dynamically set one with a valid icon key.
iconBefore
The prefix icon to display.
Values
You can select an icon or dynamically set one with a valid icon key.
id
The name.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden is true.
pluginType
The plugin type.
rawData
The initial query data before any transformation of results.
showInEditor
Whether to remain visible in the editor if hidden is true.
Methods
JavaScript API methods for interacting with NFC Reader. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
read
Read data.
nfcReader.read()
reset
Reset all child inputs to default values or clears them if no default values are set.
nfcReader.reset()
setDisabled
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
setHidden
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
nfcReader.setHidden(hidden)
Parameters
Events
Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.
capture
A user inputs a value.