Skip to content

Commit 1528717

Browse files
Update understand-page-design.mdx
Added all pages to custom page list
1 parent 220ff06 commit 1528717

File tree

1 file changed

+76
-6
lines changed

1 file changed

+76
-6
lines changed

src/content/docs/design/customize-with-code/understand-page-design.mdx

Lines changed: 76 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ If you are using React for templating, note this code is rendered on the server.
144144
145145
</Aside>
146146
147-
### Page structure in the Git directory
147+
## Page structure in the Git directory
148148
149149
The code for your pages must live in a GitHub repository (other git providers to be supported later). Your directory structure in the repo is critical to Kinde being able to run your design code.
150150
@@ -162,7 +162,7 @@ myApp/
162162
└── kinde.json
163163
```
164164
165-
### Kinde.json
165+
## Kinde.json
166166
167167
The `kinde.json` file defines the config for all custom code in Kinde, including workflows and custom pages. A typical config file will look as follows:
168168
@@ -177,13 +177,19 @@ The `kinde.json` file defines the config for all custom code in Kinde, including
177177
178178
`version` - based on the date when the API version was released. Any breaking changes will be released in a new API version.
179179
180-
### Which pages can I customize?
180+
## Which pages can I customize?
181181
182182
All Kinde hosted pages can be customized and use url route mapping to determine which template to use.
183183
184184
If a specific mapped route does not exist, a special route called `(default)` will be rendered. Set up the `(default)` page to ensure all your pages follow this design unless you have overridden them with custom code.
185185
186-
Available routes:
186+
<Aside type="warning">
187+
188+
Once you start customizing pages, it's on you not to break them. We recommend always applying custom code to pages in a non-prod environment first.
189+
190+
</Aside>
191+
192+
Common routes
187193
188194
`(default)` - The page template that will be used for all Kinde hosted pages when a specific one cannot be found.
189195
@@ -193,9 +199,73 @@ Available routes:
193199
194200
`(index)` - If someone visits the root domain for your business, e.g. `https://<yourdomain>.kinde.com`
195201

202+
Errors
203+
204+
`(account_locked)`
205+
206+
`(account_not_found)`
207+
208+
`(error)`
209+
210+
`(invalid_redirect_url)`
211+
212+
Authentication & MFA
213+
214+
`(clickwrap)`
215+
216+
`(sso_home_realm)`
217+
218+
`(provide_email)`
219+
220+
`(mfa_authenticator_app)`
221+
222+
`(mfa_method_selection)`
223+
224+
`(mfa_setup_email)`
225+
226+
`(mfa_setup_phone)`
227+
228+
`(mfa_use_email_otp)`
229+
230+
`(mfa_use_phone_otp)`
231+
232+
`(mfa_use_recovery_code)`
233+
234+
`(mfa_view_recovery_codes)`
235+
236+
Passwords
237+
238+
`(reset_password)`
239+
240+
`(reset_password_verify_email_otp)`
241+
242+
`(set_password)`
243+
244+
`(verify_password)`
245+
246+
Verify code
247+
248+
`(sign_in_sign_up_use_phone_otp)`
249+
250+
`(sign_in_use_email_otp)`
251+
252+
`(sign_up_use_email_otp)`
253+
254+
`(subscription_success)`
255+
256+
Other routes
257+
258+
`(request_access)` - before you launch and want to collect subscribers
259+
260+
`(request_access_success)`
261+
262+
`(choose_plan)` - coming soon, relates to billing
263+
264+
`(collect_payment_details)` - coming soon, related to billing
265+
196266
If you want specific customization for a page not listed here, reach out and let us know.
197267

198-
### Set the page default export function
268+
## Set the page default export function
199269

200270
Your `page.[ext]` file should contain a default export. It doesn’t matter what this is called, but the general convention is to call it `Page`. This is provided a single `event` argument which is an object containing 2 keys `context` and `request`.
201271

@@ -225,7 +295,7 @@ The top level `context` key object contains information about the page itself, l
225295
- `description` the page description
226296
- `logoAlt` the alt text for your company logo
227297

228-
### Page settings
298+
## Page settings
229299

230300
Sometimes additional information needs to be passed to Kinde from your page. You can use the page settings object for this.
231301

0 commit comments

Comments
 (0)