Skip to content

docs: Fix React Native SDK README prop names, anchors, and comments #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
promptless wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Fix React Native SDK README prop names, anchors, and comments #166

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 19 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ Skyflow’s React Native SDK can be used to securely collect, tokenize, and reve
- [**Including Skyflow React Native**](#including-skyflow-react-native)
- [**Initializing Skyflow React Native**](#initializing-skyflow-react-native)
- [**Securely collecting data client-side**](#securely-collecting-data-client-side)
- [**Validations**](#validations)
Comment thread
promptless[bot] marked this conversation as resolved.
- [**Event Listener on Skyflow Elements**](#event-listener-on-skyflow-elements)
Comment thread
promptless[bot] marked this conversation as resolved.
- [**Securely collecting data client-side using composable elements**](#securely-collecting-data-client-side-using-composable-elements)
- [**Securely revealing data client-side**](#securely-revealing-data-client-side)
- [**Reporting a Vulnerability**](#reporting-a-vulnerability)
Expand Down Expand Up @@ -116,7 +118,7 @@ For `env` parameter, there are two accepted values in `Env`:
- `PROD`
- `DEV`

In [Event Listeners](#event-listener-on-collect-elements), the actual value of element can only be accessed inside the handler when the `env` is set to `DEV`.
In [Event Listeners](#event-listener-on-skyflow-elements), the actual value of element can only be accessed inside the handler when the `env` is set to `DEV`.
Comment thread
promptless[bot] marked this conversation as resolved.

**Note**:
- Since `env` is optional, by default the environment will be `PROD`.
Expand Down Expand Up @@ -162,12 +164,12 @@ The following `props` can be passed to Skyflow Collection Element:
placeholder: 'string', // Optional, placeholder for the form element.
validations: [], // Optional, array of validation rules.
onChange: Function, // Optional, function that is passed to trigger the onChange event.
onFocus: Function, // Optional, function that is passed to trigger the onChange event.
onBlur: Function, // Optional, function that is passed to trigger the onChange event.
onReady: Function, // Optional, function that is passed to trigger the onChange event.
onFocus: Function, // Optional, function that is passed to trigger the onFocus event.
Comment thread
promptless[bot] marked this conversation as resolved.
onBlur: Function, // Optional, function that is passed to trigger the onBlur event.
onReady: Function, // Optional, function that is passed to trigger the onReady event.
inputStyles: {}, // Optional, styles object applied to the textinput field.
labelStyles: {}, // Optional, styles object applied to label of textinput field.
errorTextStyle: {}, // Optional, styles object applied to errortext of textinput field.
errorTextStyles: {}, // Optional, styles object applied to errortext of textinput field.
Comment thread
promptless[bot] marked this conversation as resolved.
}
```

Expand Down Expand Up @@ -266,7 +268,6 @@ The following collection elements are supported in the React Native SDK:
- `ExpirationDateElement`
Comment thread
promptless[bot] marked this conversation as resolved.
- `CvvElement`
- `PinElement`
- `ExpirationDateElement`
- `ExpirationMonthElement`
- `ExpirationYearElement`
- `InputFieldElement`
Expand Down Expand Up @@ -597,12 +598,12 @@ The following `props` can be passed to Skyflow Collection Element:
placeholder: 'string', // Optional, placeholder for the form element.
validations: [], // Optional, array of validation rules.
onChange: Function, // Optional, function that is passed to trigger the onChange event.
onFocus: Function, // Optional, function that is passed to trigger the onChange event.
onBlur: Function, // Optional, function that is passed to trigger the onChange event.
onReady: Function, // Optional, function that is passed to trigger the onChange event.
onFocus: Function, // Optional, function that is passed to trigger the onFocus event.
Comment thread
promptless[bot] marked this conversation as resolved.
onBlur: Function, // Optional, function that is passed to trigger the onBlur event.
onReady: Function, // Optional, function that is passed to trigger the onReady event.
inputStyles: {}, // Optional, styles object applied to the textinput field.
labelStyles: {}, // Optional, styles object applied to label of textinput field.
errorTextStyle: {}, // Optional, styles object applied to errortext of textinput field.
errorTextStyles: {}, // Optional, styles object applied to errortext of textinput field.
Comment thread
promptless[bot] marked this conversation as resolved.
skyflowID: 'string' // The skyflow_id of the record to be updated.
}
```
Expand Down Expand Up @@ -1130,12 +1131,12 @@ The following `props` can be passed to Skyflow Composable Element:
placeholder: 'string', // Optional, placeholder for the form element.
validations: [], // Optional, array of validation rules.
onChange: Function, // Optional, function that is passed to trigger the onChange event.
onFocus: Function, // Optional, function that is passed to trigger the onChange event.
onBlur: Function, // Optional, function that is passed to trigger the onChange event.
onReady: Function, // Optional, function that is passed to trigger the onChange event.
onFocus: Function, // Optional, function that is passed to trigger the onFocus event.
Comment thread
promptless[bot] marked this conversation as resolved.
onBlur: Function, // Optional, function that is passed to trigger the onBlur event.
onReady: Function, // Optional, function that is passed to trigger the onReady event.
inputStyles: {}, // Optional, styles object applied to the textinput field.
labelStyles: {}, // Optional, styles object applied to label of textinput field.
errorTextStyle: {}, // Optional, styles object applied to errortext of textinput field.
errorTextStyles: {}, // Optional, styles object applied to errortext of textinput field.
Comment thread
promptless[bot] marked this conversation as resolved.
}
```

Expand Down Expand Up @@ -1214,7 +1215,6 @@ The following collection elements are supported in the React Native SDK:
- `ExpirationDateElement`
Comment thread
promptless[bot] marked this conversation as resolved.
- `CvvElement`
- `PinElement`
- `ExpirationDateElement`
- `ExpirationMonthElement`
- `ExpirationYearElement`
- `InputFieldElement`
Expand Down Expand Up @@ -1391,9 +1391,9 @@ For information on validations, see [validations](#validations).

### Retrieving data from the vault

For non-PCI use-cases, retrieving data from the vault and revealing it in the mobile can be done using the SkyflowID's or Unique Column Values as described below
Retrieving data from the vault and revealing it in the mobile app can be done using Skyflow IDs or unique column values, as described below.
Comment thread
promptless[bot] marked this conversation as resolved.

- #### Using Skyflow ID's or Unique Column Values
- #### Using Skyflow IDs or unique column values
For retrieving data from the vault, use the `get(getInput: IGetInput, options: IGetOptions)` method.

The `getInput` parameter takes an object that contains an array of the records to fetch. Each object inside the array should contain:
Expand All @@ -1415,8 +1415,8 @@ For non-PCI use-cases, retrieving data from the vault and revealing it in the mo
{
"records": [
{
"ids": Array, // Array of SkyflowID's of the records to be fetched
"table": String, // name of table holding the above skyflow_id's
"ids": Array, // Array of Skyflow IDs of the records to be fetched
"table": String, // name of table holding the above Skyflow IDs
"redaction": RedactionType, // redaction to be applied to retrieved data
"fields": Array // (optional) columns to return; omit to return all permitted columns
// NOTE: offset and limit are NOT supported when using ids
Expand Down
Loading