Skip to content
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.

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

docs(account-settings): change password docs #3085

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
e73933d
Initial draft
wlee221 Nov 24, 2022
ae2ce72
Initial draft
wlee221 Nov 24, 2022
8d99897
Merge branch 'account-settings/docs-setup' into account-settings/chan…
wlee221 Nov 24, 2022
37cd3c9
Progress!
wlee221 Nov 24, 2022
244ba16
Minor wording change
wlee221 Nov 24, 2022
ac7d097
Main props table
wlee221 Nov 24, 2022
bfeb1b7
Add missing override
wlee221 Nov 24, 2022
e4f2869
Merge branch 'account-settings/docs-setup' into account-settings/chan…
wlee221 Nov 24, 2022
80c39ef
Merge branch 'account-settings/main' into account-settings/change-pas…
wlee221 Nov 29, 2022
32ed1a2
Update docs/src/pages/[platform]/connected-components/account-setting…
wlee221 Nov 29, 2022
1c99eff
Merge branch 'account-settings/main' into account-settings/change-pas…
wlee221 Dec 2, 2022
2e4cf9d
Use Example / ExampleCode
wlee221 Dec 2, 2022
ed88693
Merge branch 'account-settings/change-password-docs' of github.com:aw…
wlee221 Dec 2, 2022
a51b7cd
Fix typo
wlee221 Dec 2, 2022
907a3ca
Fix more typo
wlee221 Dec 2, 2022
cf604b3
Merge branch 'account-settings/delete-user-docs' into account-setting…
wlee221 Dec 3, 2022
89a146a
revert unrelated changes
wlee221 Dec 3, 2022
c9bddf6
Update component names
wlee221 Dec 3, 2022
f79cfb7
Start override component props doc
wlee221 Dec 3, 2022
7fb3349
Merge branch 'account-settings/delete-user-docs' into account-setting…
wlee221 Dec 3, 2022
297b176
Merge branch 'account-settings/change-password-docs' of github.com:aw…
wlee221 Dec 3, 2022
7b58201
Finish override props section!
wlee221 Dec 3, 2022
c969ec7
Merge branch 'account-settings/delete-user-docs' into account-setting…
wlee221 Dec 3, 2022
84a3ef2
Wording
wlee221 Dec 3, 2022
acada20
Merge branch 'account-settings/delete-user-docs' into account-setting…
wlee221 Dec 3, 2022
718a752
Merge branch 'account-settings/delete-user-docs' into account-setting…
wlee221 Dec 5, 2022
c041156
Merge branch 'account-settings/delete-user-docs' into account-setting…
wlee221 Dec 5, 2022
e59a2be
Merge branch 'account-settings/delete-user-docs' into account-setting…
wlee221 Dec 5, 2022
5d58b91
ChangePassword theme example
wlee221 Dec 5, 2022
c1ac541
Update docs/src/pages/[platform]/connected-components/account-setting…
wlee221 Dec 5, 2022
72b91b6
Update docs/src/pages/[platform]/connected-components/account-setting…
wlee221 Dec 5, 2022
dd0ce10
Apply suggestions from @joebuono
wlee221 Dec 5, 2022
65388d0
Add additional validator
wlee221 Dec 5, 2022
e566a50
Merge branch 'account-settings/change-password-docs' of github.com:aw…
wlee221 Dec 5, 2022
d71e2ff
Update docs/src/pages/[platform]/connected-components/account-setting…
wlee221 Dec 5, 2022
9d64b17
Update docs/src/pages/[platform]/connected-components/account-setting…
wlee221 Dec 5, 2022
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
export const CHANGE_PASSWORD = [
{
name: `onSuccess?`,
description:
'Callback function triggered when password is successfully updated',
type: `() => void`,
},
{
name: `onError?`,
description: 'Callback function triggered when change password fails',
type: `(error: Error) => void`,
},
{
name: `validators?`,
description: 'Custom password validations',
type: `ValidatorOptions[]`,
},
{
name: `components?`,
description: 'Submit button',
type: `ChangePasswordComponents`,
},
];

export const OVERRIDES = [
{
name: `CurrentPasswordField?`,
description: 'Password field for current password',
type: `PasswordFieldProps`,
},
{
name: `NewPasswordField?`,
description: 'Password field for new password',
type: `PasswordFieldProps`,
},
{
name: `ConfirmPasswordField?`,
description: 'Password field for confirm password',
type: `PasswordFieldProps`,
},
{
name: `ErrorMessage?`,
description: 'Error alert that displays on delete user errors',
type: `ErrorMessageComponentProps`,
},
{
name: `SubmitButton?`,
description: 'Submit button',
type: `SubmitButtonProps`,
},
];

export const PASSWORD_FIELDS = [
{
name: `onBlur`,
description:
'Blur handler for the input. This must be passed to your input element.',
type: `React.FocusEventHandler<HTMLInputElement>`,
},
{
name: `onChange`,
description:
'Change handler for the input. This must be passed to your input element.',
type: `React.ChangeEventHandler<HTMLInputElement>`,
},
{
name: `name`,
description:
'HTML name for the input. This must be passed to your input element.',
type: `React.ChangeEventHandler<HTMLInputElement>`,
},
{
name: `fieldValidationErrors?`,
description: 'List of validation errors for the password field.',
type: `string[]`,
},
];

export const SUBMIT_BUTTON = [
{
name: `isDisabled`,
description:
'Boolean representing whether account deletion is in progress. Your delete button should be disabled if this is set to true.',
type: `boolean`,
},
];
Loading