Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexvcasillas authored Jul 11, 2024
1 parent 34bf5c8 commit af840ef
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ Currently there are formidable solutions in the React ecosystem to handle form's
NPM

```
npm i --save @reactive-labs/onboarding
npm i --save @alexvcasillas/react-onboarding
```

Yarn

```
yarn add @reactive-labs/onboarding
yarn add @alexvcasillas/react-onboarding
```

# Onboarding components
Expand All @@ -60,7 +60,7 @@ yarn add @reactive-labs/onboarding
The Onboarding Component is what you'll need at the top-level of your application. It's that one that will be in charge of handling the Step generations and dealing with rendering Steps, Infos, End components and rending everything that's not related to a particular step or end page.

```
import { Onboarding } from '@reactive-labs/onboarding';
import { Onboarding } from '@alexvcasillas/react-onboarding';
<Onboarding>
...
Expand All @@ -74,7 +74,7 @@ It won't take any props so you just drop it there and it will start working out
The Step component is what you will have to include within an Onboarding component to tell the system that you would want a step to be rendered and therefore, displayed in the browser.

```
import { Step } from '@reactive-labs/onboarding';
import { Step } from '@alexvcasillas/react-onboarding';
<Step name="user-details">
{({ nextStep, prevStep, validStep, finish }) => (
Expand Down Expand Up @@ -107,7 +107,7 @@ As you can see, the Step component is a component that takes a function as a chi
The Field component is what you will have to include within a Field component to tell the system that this is a field that could have validations attached to them to deal with your business logic.

```
import { Step } from '@reactive-labs/onboarding';
import { Step } from '@alexvcasillas/react-onboarding';
<Field name="email" type="email" validations={}>
{({ type, value, onChange, onFocus, onBlur, onEnter, valid, error }) => (
Expand All @@ -116,7 +116,7 @@ import { Step } from '@reactive-labs/onboarding';
</Field>
```

The field component that's various props as:
The field component has various props as:

- name
- type: String
Expand Down

0 comments on commit af840ef

Please sign in to comment.