Skip to content

Commit

Permalink
adds examples for overrides use cases
Browse files Browse the repository at this point in the history
  • Loading branch information
rishabhpoddar committed Dec 21, 2023
1 parent a0289dd commit 6113311
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 12 deletions.
8 changes: 6 additions & 2 deletions v2/emailpassword/advanced-customizations/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ This section will guide you on overriding our default behaviour to achieve custo
This will allow you to customize parts of the default UI without having to implement that whole UI widget from scratch

### 2) Override frontend functions
This will allow you to change the way our widgets query the backend. This can be useful for operations like implementing your own session management system that works with our auth widgets.
This will allow you to change the way our widgets query the backend. Example use cases are:
- Sending analytics events based on user action.
- Custom caching logic if needed.
- Providing a custom router for routing that happens within our pre built UI. For example, integrating the NextJS router.
- Implementing your own session management system that works with our auth widgets.

### 3) Override backend functions
This will allow you to change the behaviour of the functions that are used by the backend APIs exposed via our SDK. It can be useful for migration, using your own userID format, custom validation logic etc...
Expand All @@ -26,7 +30,7 @@ This will allow you to change the behaviour of the functions that are used by th
This will allow you to override the behaviour of any of the backend APIs our SDK exposes. It can be used for post / pre API callbacks or handling custom API input / output that deviate from our API specifications.

### 5) Frontend Hooks
This allows you to change the request (body, headers, url etc) that is sent to your server, handle events fired by various user actions, and control how a recipe redirects a user.
This allows you to change the request (body, headers, url etc) that is sent to your server, handle events fired by various user actions, and control how a recipe redirects a user. For example, you can use this to add an invite code to our sign up API call.

### 6) User Contexts
This allows you to pass information across recipe functions so that customisations can be made based on a specific "execution context".
Expand Down
8 changes: 6 additions & 2 deletions v2/passwordless/advanced-customizations/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ This section will guide you on overriding our default behaviour to achieve custo
This will allow you to customize parts of the default UI without having to implement that whole UI widget from scratch

### 2) Override frontend functions
This will allow you to change the way our widgets query the backend. This can be useful for operations like implementing your own session management system that works with our auth widgets.
This will allow you to change the way our widgets query the backend. Example use cases are:
- Sending analytics events based on user action.
- Custom caching logic if needed.
- Providing a custom router for routing that happens within our pre built UI. For example, integrating the NextJS router.
- Implementing your own session management system that works with our auth widgets.

### 3) Override backend functions
This will allow you to change the behaviour of the functions that are used by the backend APIs exposed via our SDK. It can be useful for migration, using your own userID format, custom validation logic etc...
Expand All @@ -26,7 +30,7 @@ This will allow you to change the behaviour of the functions that are used by th
This will allow you to override the behaviour of any of the backend APIs our SDK exposes. It can be used for post / pre API callbacks or handling custom API input / output that deviate from our API specifications.

### 5) Frontend Hooks
This allows you to change the request (body, headers, url etc) that is sent to your server, handle events fired by various user actions, and control how a recipe redirects a user.
This allows you to change the request (body, headers, url etc) that is sent to your server, handle events fired by various user actions, and control how a recipe redirects a user. For example, you can use this to add an invite code to our sign up API call.

### 6) User Contexts
This allows you to pass information across recipe functions so that customisations can be made based on a specific "execution context".
Expand Down
8 changes: 6 additions & 2 deletions v2/session/advanced-customizations/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ This section will guide you on overriding our default behaviour to achieve custo
This will allow you to customize parts of the default UI without having to implement that whole UI widget from scratch

### 2) Override frontend functions
This will allow you to change the way our widgets query the backend. This can be useful for operations like implementing your own session management system that works with our auth widgets.
This will allow you to change the way our widgets query the backend. Example use cases are:
- Sending analytics events based on user action.
- Custom caching logic if needed.
- Providing a custom router for routing that happens within our pre built UI. For example, integrating the NextJS router.
- Implementing your own session management system that works with our auth widgets.

### 3) Override backend functions
This will allow you to change the behaviour of the functions that are used by the backend APIs exposed via our SDK. It can be useful for migration, using your own userID format, custom validation logic etc...
Expand All @@ -26,7 +30,7 @@ This will allow you to change the behaviour of the functions that are used by th
This will allow you to override the behaviour of any of the backend APIs our SDK exposes. It can be used for post / pre API callbacks or handling custom API input / output that deviate from our API specifications.

### 5) Frontend Hooks
This allows you to change the request (body, headers, url etc) that is sent to your server, handle events fired by various user actions, and control how a recipe redirects a user.
This allows you to change the request (body, headers, url etc) that is sent to your server, handle events fired by various user actions, and control how a recipe redirects a user. For example, you can use this to add an invite code to our sign up API call.

### 6) User Contexts
This allows you to pass information across recipe functions so that customisations can be made based on a specific "execution context".
Expand Down
8 changes: 6 additions & 2 deletions v2/thirdparty/advanced-customizations/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ This section will guide you on overriding our default behaviour to achieve custo
This will allow you to customize parts of the default UI without having to implement that whole UI widget from scratch

### 2) Override frontend functions
This will allow you to change the way our widgets query the backend. This can be useful for operations like implementing your own session management system that works with our auth widgets.
This will allow you to change the way our widgets query the backend. Example use cases are:
- Sending analytics events based on user action.
- Custom caching logic if needed.
- Providing a custom router for routing that happens within our pre built UI. For example, integrating the NextJS router.
- Implementing your own session management system that works with our auth widgets.

### 3) Override backend functions
This will allow you to change the behaviour of the functions that are used by the backend APIs exposed via our SDK. It can be useful for migration, using your own userID format, custom validation logic etc...
Expand All @@ -26,7 +30,7 @@ This will allow you to change the behaviour of the functions that are used by th
This will allow you to override the behaviour of any of the backend APIs our SDK exposes. It can be used for post / pre API callbacks or handling custom API input / output that deviate from our API specifications.

### 5) Frontend Hooks
This allows you to change the request (body, headers, url etc) that is sent to your server, handle events fired by various user actions, and control how a recipe redirects a user.
This allows you to change the request (body, headers, url etc) that is sent to your server, handle events fired by various user actions, and control how a recipe redirects a user. For example, you can use this to add an invite code to our sign up API call.

### 6) User Contexts
This allows you to pass information across recipe functions so that customisations can be made based on a specific "execution context".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ This section will guide you on overriding our default behaviour to achieve custo
This will allow you to customize parts of the default UI without having to implement that whole UI widget from scratch

### 2) Override frontend functions
This will allow you to change the way our widgets query the backend. This can be useful for operations like implementing your own session management system that works with our auth widgets.
This will allow you to change the way our widgets query the backend. Example use cases are:
- Sending analytics events based on user action.
- Custom caching logic if needed.
- Providing a custom router for routing that happens within our pre built UI. For example, integrating the NextJS router.
- Implementing your own session management system that works with our auth widgets.

### 3) Override backend functions
This will allow you to change the behaviour of the functions that are used by the backend APIs exposed via our SDK. It can be useful for migration, using your own userID format, custom validation logic etc...
Expand All @@ -26,7 +30,7 @@ This will allow you to change the behaviour of the functions that are used by th
This will allow you to override the behaviour of any of the backend APIs our SDK exposes. It can be used for post / pre API callbacks or handling custom API input / output that deviate from our API specifications.

### 5) Frontend Hooks
This allows you to change the request (body, headers, url etc) that is sent to your server, handle events fired by various user actions, and control how a recipe redirects a user.
This allows you to change the request (body, headers, url etc) that is sent to your server, handle events fired by various user actions, and control how a recipe redirects a user. For example, you can use this to add an invite code to our sign up API call.

### 6) User Contexts
This allows you to pass information across recipe functions so that customisations can be made based on a specific "execution context".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ This section will guide you on overriding our default behaviour to achieve custo
This will allow you to customize parts of the default UI without having to implement that whole UI widget from scratch

### 2) Override frontend functions
This will allow you to change the way our widgets query the backend. This can be useful for operations like implementing your own session management system that works with our auth widgets.
This will allow you to change the way our widgets query the backend. Example use cases are:
- Sending analytics events based on user action.
- Custom caching logic if needed.
- Providing a custom router for routing that happens within our pre built UI. For example, integrating the NextJS router.
- Implementing your own session management system that works with our auth widgets.

### 3) Override backend functions
This will allow you to change the behaviour of the functions that are used by the backend APIs exposed via our SDK. It can be useful for migration, using your own userID format, custom validation logic etc...
Expand All @@ -26,7 +30,7 @@ This will allow you to change the behaviour of the functions that are used by th
This will allow you to override the behaviour of any of the backend APIs our SDK exposes. It can be used for post / pre API callbacks or handling custom API input / output that deviate from our API specifications.

### 5) Frontend Hooks
This allows you to change the request (body, headers, url etc) that is sent to your server, handle events fired by various user actions, and control how a recipe redirects a user.
This allows you to change the request (body, headers, url etc) that is sent to your server, handle events fired by various user actions, and control how a recipe redirects a user. For example, you can use this to add an invite code to our sign up API call.

### 6) User Contexts
This allows you to pass information across recipe functions so that customisations can be made based on a specific "execution context".
Expand Down

0 comments on commit 6113311

Please sign in to comment.