Skip to content

Commit

Permalink
fix(docs): add callout for Amplify UI component usage in SSR for Angu…
Browse files Browse the repository at this point in the history
…lar/Vue (#6339)

* fix(docs): add callout about Amplify UI component usage in SSR for Angular/Vue

* chore: adjust wording feedback, fix angular heading sizes
  • Loading branch information
tiffanynwyeung authored Feb 10, 2025
1 parent 10b7c9e commit 6a394f8
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
import AngularPolyfill from './shared/angular-polyfill.mdx';
import AWSExports from './shared/add-aws-exports-type.mdx';

### Global and Process Shim
## Global and Process Shim

<AngularPolyfill />

### Could not find a declaration file for module './aws-exports'

<AWSExports />

### Problems with `OnPush` change detection
## Server-side Rendering (SSR)

Amplify UI components are interactive and designed to work with Client-side Rendering (CSR). You must ensure that Amplify UI components are not rendered on the server in SSR-enabled projects.

## Problems with `OnPush` change detection

The Authenticator component currently does not support use of the `OnPush` [change detection strategy](https://angular.io/api/core/ChangeDetectionStrategy). Please use the `Default` strategy instead.

### Warning: CommonJS or AMD dependencies
## Warning: CommonJS or AMD dependencies

If you see CommonJS or AMD dependencies optimization bailouts warnings, add the following [content](https://gist.github.com/wlee221/6d98d96740bea6f53327b4db4a432616) to your `angular.json`.
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,7 @@ When working with a [Vite](https://vitejs.dev) project you must make a few modif
<VitePolyfill />
</Tabs.Panel>
</Tabs.Container>

## Server-side Rendering (SSR)

Amplify UI components are interactive and designed to work with Client-side rendering (CSR). You must ensure that Amplify UI components are not rendered on the server in SSR-enabled projects.

0 comments on commit 6a394f8

Please sign in to comment.