docs: update upgrade guide

GetStream · Jul 1, 2024 · d6eabc3 · d6eabc3
1 parent 51c198f
commit d6eabc3
Show file tree

Hide file tree

Showing 41 changed files with 399 additions and 366 deletions.
diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml
@@ -59,9 +59,9 @@ jobs:
           STREAM_USER_ID: <dynamic user>
           STREAM_CHANNELS_FILTER: '{"type": "messaging"}'
         run: >
-          yarn vercel pull --yes --environment=${{ github.ref == 'refs/heads/master' && 'production' || 'preview' }} --token=${{ secrets.VERCEL_TOKEN }} &&
-          yarn vercel build ${{ github.ref == 'refs/heads/master' && '--prod' || '' }} --token=${{ secrets.VERCEL_TOKEN }} &&
-          yarn vercel deploy ${{ github.ref == 'refs/heads/master' && '--prod' || '' }} --prebuilt --token=${{ secrets.VERCEL_TOKEN }}
+          yarn vercel pull --yes --environment=${{ github.ref == 'refs/heads/v5' && 'production' || 'preview' }} --token=${{ secrets.VERCEL_TOKEN }} &&
+          yarn vercel build ${{ github.ref == 'refs/heads/v5' && '--prod' || '' }} --token=${{ secrets.VERCEL_TOKEN }} &&
+          yarn vercel deploy ${{ github.ref == 'refs/heads/v5' && '--prod' || '' }} --prebuilt --token=${{ secrets.VERCEL_TOKEN }}
       - name: Copy docs from stream-chat-css
         run: npm run ${{ (github.ref == 'refs/heads/v5' || contains(github.head_ref, 'v5')) && 'copy-css-docs:v5' || 'copy-css-docs' }}
       - name: Generate docs

diff --git a/README.md b/README.md
@@ -54,11 +54,32 @@ Check out our current openings and apply via [Stream's website](https://getstrea
 
 Supported Angular versions: **Angular 15-18**
 
+Run this command if you are using **Angular 18**:
+
+```shell
+// --force is only required until this issue is solved: https://github.com/tonysamperi/ngx-float-ui/issues/26
+npm install stream-chat-angular@beta ngx-float-ui@18 --force
+```
+
+Run this command if you are using **Angular 17**:
+
+```shell
+npm install stream-chat-angular@beta ngx-float-ui@17
+```
+
+Run this command if you are using **Angular 16**:
+
+```shell
+npm install stream-chat-angular@beta ngx-float-ui@16
+```
+
+Run this command if you are using **Angular 15**:
+
 ```shell
-npm install stream-chat-angular
+npm install stream-chat-angular@beta @ngx-translate/core@14 ngx-float-ui@15
 ```
 
-Supported node verison: 18+
+Supported node verisons: 18+
 
 ## Sample App
 

diff --git a/docusaurus/angular_versioned_docs/version-5/basics/overview.mdx b/docusaurus/angular_versioned_docs/version-5/basics/overview.mdx
@@ -30,30 +30,33 @@ We recommend using the component library through a package manager. Stream Chat
 
 ### Install with NPM
 
-Run the following command if you are using **Angular 16** or **Angular 15**:
+Run this command if you are using **Angular 18**:
 
 ```shell
-npm install stream-chat-angular stream-chat @ngx-translate/core
+// --force is only required until this issue is solved: https://github.com/tonysamperi/ngx-float-ui/issues/26
+npm install stream-chat-angular@beta ngx-float-ui@18 --force
 ```
 
-Run the following command if you are using **Angular 14**:
+Run this command if you are using **Angular 17**:
 
 ```shell
-npm install stream-chat-angular stream-chat @ngx-translate/core ngx-popperjs@14
+npm install stream-chat-angular@beta ngx-float-ui@17
 ```
 
-Run the following command if you are using **Angular 13**:
+Run this command if you are using **Angular 16**:
 
 ```shell
-npm install stream-chat-angular stream-chat @ngx-translate/core [email protected] ngx-popperjs@13 --legacy-peer-deps
+npm install stream-chat-angular@beta ngx-float-ui@16
 ```
 
-Run this command if you are using **Angular 12**:
+Run this command if you are using **Angular 15**:
 
 ```shell
-npm install stream-chat-angular stream-chat @ngx-translate/core [email protected] ngx-popperjs@12 --legacy-peer-deps
+npm install stream-chat-angular@beta @ngx-translate/core@14 ngx-float-ui@15
 ```
 
+Supported node verisons: 18+
+
 ## Tutorial
 
 Follow our [tutorial](https://getstream.io/chat/angular/tutorial/) and build your first Stream Angular chat application.
diff --git a/docusaurus/angular_versioned_docs/version-5/basics/upgrade-v4.mdx b/docusaurus/angular_versioned_docs/version-5/basics/upgrade-v4.mdx
@@ -18,7 +18,7 @@ import MessageEditAfter from "../assets/message-edit-after.png";
 - Provide more CSS customization options for the avatar and icon components (to avoid providing a custom component for even basic customization)
 - Drop support for [Angular 12-14](https://getstream.io/chat/docs/sdk/angular/basics/angular-version-support/) and [theme-v1](https://getstream.io/chat/docs/sdk/angular/concepts/themeing/)
 
-The full list of [features and progress](https://github.com/GetStream/stream-chat-angular/issues/584) are on GitHub.
+Want to see it all in action? Check out [the demo application](https://angular-chat-demo-getstreamio.vercel.app/) or try it out in your own application using the instructions below.
 
 <ImageShowcase
   border
@@ -57,24 +57,32 @@ The full list of [features and progress](https://github.com/GetStream/stream-cha
 ## Get started
 
 <Tabs groupId="examples">
-<TabItem value="Angular17" label="Angular 17">
+<TabItem value="Angular18" label="Angular 18">
 
+```bash
+# --force is only required until this issue is solved: https://github.com/tonysamperi/ngx-float-ui/issues/26
+npm install stream-chat-angular@beta ngx-float-ui@18 --force
 ```
-npm install stream-chat-angular@beta
+
+</TabItem>
+<TabItem value="Angular17" label="Angular 17">
+
+```bash
+npm install stream-chat-angular@beta ngx-float-ui@17
 ```
 
 </TabItem>
 <TabItem value="Angular16" label="Angular 16">
 
-```
+```bash
 npm install stream-chat-angular@beta ngx-float-ui@16
 ```
 
 </TabItem>
 <TabItem value="Angular15" label="Angular 15">
 
-```
-npm install stream-chat-angular@beta ngx-float-ui@15 @ngx-translate/core@14
+```bash
+npm install stream-chat-angular@beta @ngx-translate/core@14 ngx-float-ui@15
 ```
 
 </TabItem>

diff --git a/docusaurus/angular_versioned_docs/version-5/components/AttachmentListComponent.mdx b/docusaurus/angular_versioned_docs/version-5/components/AttachmentListComponent.mdx
@@ -122,7 +122,7 @@ The id of the message the attachments belong to
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts:39](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L39)
+[projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts:39](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L39)
 
 ---
 
@@ -134,7 +134,7 @@ The parent id of the message the attachments belong to
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts:43](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L43)
+[projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts:43](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L43)
 
 ---
 
@@ -146,7 +146,7 @@ The attachments to display
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts:47](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L47)
+[projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts:47](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L47)
 
 ---
 
@@ -158,6 +158,6 @@ Emits the state of the image carousel window
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts:51](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L51)
+[projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts:51](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L51)
 
 [//]: # "End of generated content"
diff --git a/.../angular_versioned_docs/version-5/components/AttachmentPreviewListComponent.mdx b/.../angular_versioned_docs/version-5/components/AttachmentPreviewListComponent.mdx
@@ -47,7 +47,7 @@ A stream that emits the current file uploads and their states
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts:17](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts#L17)
+[projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts:17](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts#L17)
 
 ---
 
@@ -59,7 +59,7 @@ An output to notify the parent component if the user tries to retry a failed upl
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts:21](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts#L21)
+[projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts:21](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts#L21)
 
 ---
 
@@ -71,6 +71,6 @@ An output to notify the parent component if the user wants to delete a file
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts:25](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts#L25)
+[projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts:25](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts#L25)
 
 [//]: # "End of generated content"
diff --git a/...s/angular_versioned_docs/version-5/components/AutocompleteTextareaComponent.mdx b/...s/angular_versioned_docs/version-5/components/AutocompleteTextareaComponent.mdx
@@ -51,7 +51,7 @@ TextareaInterface.value
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:49](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L49)
+[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:49](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L49)
 
 ---
 
@@ -67,7 +67,7 @@ TextareaInterface.placeholder
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:53](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L53)
+[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:53](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L53)
 
 ---
 
@@ -83,7 +83,7 @@ TextareaInterface.areMentionsEnabled
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:57](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L57)
+[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:57](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L57)
 
 ---
 
@@ -99,7 +99,7 @@ TextareaInterface.inputMode
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:61](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L61)
+[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:61](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L61)
 
 ---
 
@@ -115,7 +115,7 @@ TextareaInterface.mentionScope
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:65](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L65)
+[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:65](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L65)
 
 ---
 
@@ -131,7 +131,7 @@ TextareaInterface.autoFocus
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:69](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L69)
+[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:69](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L69)
 
 ---
 
@@ -147,7 +147,7 @@ TextareaInterface.valueChange
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:73](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L73)
+[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:73](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L73)
 
 ---
 
@@ -163,7 +163,7 @@ TextareaInterface.send
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:77](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L77)
+[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:77](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L77)
 
 ---
 
@@ -179,6 +179,6 @@ TextareaInterface.userMentions
 
 #### Defined in
 
-[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:81](https://github.com/GetStream/stream-chat-angular/blob/091a6702bb77aeb26a3f1d206952d9d4ea60a07a/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L81)
+[projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:81](https://github.com/GetStream/stream-chat-angular/blob/8e11a978ee2d9f884aa26b1d22441235f92d8da8/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L81)
 
 [//]: # "End of generated content"