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.

Sign up for GitHub

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

Jump to bottom

docs(account-settings): Account Settings intro docs #3127

Merged
merged 7 commits into from
Dec 5, 2022
Merged

docs(account-settings): Account Settings intro docs #3127

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5101438
Add intro contents
wlee221 Dec 2, 2022
c73a0cc
trigger ci
wlee221 Dec 2, 2022
c896ca8
Update docs/src/pages/[platform]/connected-components/account-setting…
wlee221 Dec 2, 2022
1b5b01e
Update docs/src/pages/[platform]/connected-components/account-setting…
wlee221 Dec 2, 2022
a59ec10
Merge branch 'account-settings/main' into account-settings/intro-docs
wlee221 Dec 2, 2022
905701b
Merge branch 'account-settings/main' into account-settings/intro-docs
wlee221 Dec 3, 2022
49adc9b
Update docs/src/pages/[platform]/connected-components/account-setting…
wlee221 Dec 3, 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
38 changes: 36 additions & 2 deletions docs/src/pages/[platform]/connected-components/account-settings/index.page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ description: Amplify UI provides account settings components to manage account s
supportedFrameworks: react
---

import { Alert, Tabs, TabItem } from '@aws-amplify/ui-react';
import { Fragment } from '@/components/Fragment';
import { InstallScripts } from '@/components/InstallScripts';
import { getCustomStaticPath } from '@/utils/getCustomStaticPath';
import { DeveloperPreview } from './DeveloperPreview';

Expand All @@ -21,7 +23,39 @@ export async function getStaticProps() {

<DeveloperPreview />

## Account Settings
Account Settings components are a set of standalone components that add [user management](https://docs.amplify.aws/lib/auth/manageusers/q/platform/js/) flows to your application with minimal boilerplate.

TODO
<Alert variation="warning">
Account Settings components require end user to be authenticated. You can use the [`Authenticator`](/connected-components/authenticator) component to add authentication UI to your application.
</Alert>

## Quick Start

### Step 1. Configure Backend
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for using "Step 1", "Step 2"!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I copied over from other docs 😈


Account settings components work seamlessly with the [Amplify CLI](https://docs.amplify.aws/cli/start/install/)
to **automatically** work with your backend.

First, update `@aws-amplify/cli` with [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
if you're using a version before `6.4.0`:

<Tabs>
<TabItem title="npm">

```shell
npm install -g @aws-amplify/cli@latest
```

</TabItem>
<TabItem title="yarn">

```shell
yarn global add @aws-amplify/cli@latest
```

</TabItem>
</Tabs>

### Step 2. Install Dependencies

<InstallScripts />