Skip to content
This repository was archived by the owner on Nov 3, 2025. It is now read-only.

Commit 6bba5fd

Browse files
committed
📝 (createCanal) add docs for Stop onBack hook
1 parent 88f7e28 commit 6bba5fd

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

src/createCanal.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@ route: /api/create-canal
1212

1313
## Stop
1414

15-
| Key name | Required | Default | Usage |
16-
| :------------: | :------: | ----------- | ----------------------------------------------------------------------------- |
17-
| `name` | `true` | `undefined` | Unique identifier. |
18-
| `component` | `true` | `undefined` | The component that will be rendered when the user progress reaches that stop. |
19-
| `isFullScreen` | `false` | `undefined` | Indicates if the stop needs to be rendered in the `FullScreenPortal`. |
15+
| Key name | Required | Default | Usage |
16+
| :------------: | :------: | ----------- | ------------------------------------------------------------------------------- |
17+
| `name` | `true` | `undefined` | Unique identifier. |
18+
| `Component` | `true` | `undefined` | The component that will be rendered when the user progress reaches that stop. |
19+
| `props` | `false` | `undefined` | Optional. Props that will be passed down to the component. |
20+
| `onBack` | `false` | `undefined` | Optional. Android Back button Callback. |
21+
| `isFullScreen` | `false` | `undefined` | Optional. Indicates if the stop needs to be rendered in the `FullScreenPortal`. |
2022

2123
## Canal Props
2224

0 commit comments

Comments
 (0)