-
Notifications
You must be signed in to change notification settings - Fork 318
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(account-settings): starting docs (#3084)
* Update links * Barebone pages * Update description * Use DeveloperPreview * Move ReactPropsTable to `@components` * Remove unnecessary space * Update index.page.mdx
- Loading branch information
Showing
12 changed files
with
93 additions
and
4 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15
docs/src/pages/[platform]/connected-components/account-settings/DeveloperPreview.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
import { Alert } from '@aws-amplify/ui-react'; | ||
import { useRouter } from 'next/router'; | ||
|
||
export const DeveloperPreview = () => { | ||
const { | ||
query: { platform = 'react' }, | ||
} = useRouter(); | ||
if (platform !== 'react') return null; | ||
|
||
return ( | ||
<Alert variation="info" heading="Developer Preview"> | ||
Account Settings components are currently in developer preview. | ||
</Alert> | ||
); | ||
}; |
13 changes: 13 additions & 0 deletions
13
...[platform]/connected-components/account-settings/change-password/index.page.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: ChangePassword | ||
metaTitle: ChangePassword | ||
description: ChangePassword component enables end users to change their password. | ||
supportedFrameworks: react | ||
--- | ||
|
||
import { Fragment } from '@/components/Fragment'; | ||
import { DeveloperPreview } from '../DeveloperPreview'; | ||
|
||
<DeveloperPreview /> | ||
|
||
<Fragment>{({ platform }) => import(`./${platform}.mdx`)}</Fragment> |
3 changes: 3 additions & 0 deletions
3
...ages/[platform]/connected-components/account-settings/change-password/react.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## Change Password | ||
|
||
TODO |
13 changes: 13 additions & 0 deletions
13
...ges/[platform]/connected-components/account-settings/delete-user/index.page.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: DeleteUser | ||
metaTitle: DeleteUser | ||
description: DeleteUser component allows end users to delete their account permanently from their app. | ||
supportedFrameworks: react | ||
--- | ||
|
||
import { Fragment } from '@/components/Fragment'; | ||
import { DeveloperPreview } from '../DeveloperPreview'; | ||
|
||
<DeveloperPreview /> | ||
|
||
<Fragment>{({ platform }) => import(`./${platform}.mdx`)}</Fragment> |
2 changes: 2 additions & 0 deletions
2
...rc/pages/[platform]/connected-components/account-settings/delete-user/react.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## Delete User | ||
TODO |
27 changes: 27 additions & 0 deletions
27
docs/src/pages/[platform]/connected-components/account-settings/index.page.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
title: Account Settings | ||
description: Amplify UI provides account settings components to manage account settings. | ||
supportedFrameworks: react | ||
--- | ||
|
||
import { Fragment } from '@/components/Fragment'; | ||
import { getCustomStaticPath } from '@/utils/getCustomStaticPath'; | ||
import { DeveloperPreview } from './DeveloperPreview'; | ||
|
||
|
||
export async function getStaticPaths() { | ||
return getCustomStaticPath(frontmatter.supportedFrameworks); | ||
} | ||
|
||
{/* `getStaticProps` is required to prevent "Error: getStaticPaths was added without a getStaticProps. Without getStaticProps, getStaticPaths does nothing" */} | ||
|
||
export async function getStaticProps() { | ||
return { props: {} } | ||
} | ||
|
||
<DeveloperPreview /> | ||
|
||
## Account Settings | ||
|
||
TODO | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 0 additions & 1 deletion
1
docs/src/pages/[platform]/connected-components/in-app-messaging/props/index.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
.../[platform]/connected-components/in-app-messaging/props/styles.react-native.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
import ReactPropsTable from './ReactPropsTable'; | ||
import ReactPropsTable from '@/components/propsTable/ReactPropsTable'; | ||
import { REACT_NATIVE_MESSAGE_STYLE_PROPS } from './props'; | ||
|
||
<ReactPropsTable props={REACT_NATIVE_MESSAGE_STYLE_PROPS} /> |
2 changes: 1 addition & 1 deletion
2
...c/pages/[platform]/connected-components/in-app-messaging/props/styles.react.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters