Skip to content

Commit

Permalink
chore: fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
szuperaz committed Aug 26, 2024
1 parent 4411374 commit b06af62
Show file tree
Hide file tree
Showing 143 changed files with 3,170 additions and 2,941 deletions.
10 changes: 5 additions & 5 deletions docusaurus/angular-docusaurus-dontent-docs.plugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ module.exports = {
{
lastVersion: "current",
versions: {
5: {
label: "v5 (beta)",
banner: "unreleased",
path: "5",
},
current: {
label: "v5",
},
4: {
label: "v4",
banner: "unmaintained",
path: "4",
},
},
},
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,14 @@ Add a reference to the template in your `app.component.ts`:

#### Displaying the invitations

The [`ChatClientService`](../services/ChatClientService.mdx) can keep track of pending invites, to enable this you have to initialize the service with the following flag:

```typescript
this.chatService.init("<API key>", "<user>", "<token provider>", {
trackPendingChannelInvites: true,
});
```

The `pendingInvites$` Observable on the [`ChatClientService`](../services/ChatClientService.mdx) can notify us about the pending invitations of the current user. Let's subscribe to this Observable and [display the invites](../services/NotificationService.mdx) in the `ngOnInit` method of the `app.component.ts`

```typescript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ The id of the message the attachments belong to

#### Defined in

[lib/attachment-list/attachment-list.component.ts:40](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L40)
[lib/attachment-list/attachment-list.component.ts:40](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L40)

---

Expand All @@ -134,7 +134,7 @@ The parent id of the message the attachments belong to

#### Defined in

[lib/attachment-list/attachment-list.component.ts:44](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L44)
[lib/attachment-list/attachment-list.component.ts:44](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L44)

---

Expand All @@ -146,7 +146,7 @@ The attachments to display

#### Defined in

[lib/attachment-list/attachment-list.component.ts:48](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L48)
[lib/attachment-list/attachment-list.component.ts:48](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L48)

---

Expand All @@ -158,6 +158,6 @@ Emits the state of the image carousel window

#### Defined in

[lib/attachment-list/attachment-list.component.ts:52](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L52)
[lib/attachment-list/attachment-list.component.ts:52](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/attachment-list/attachment-list.component.ts#L52)

[//]: # "End of generated content"
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ A stream that emits the current file uploads and their states

#### Defined in

[lib/attachment-preview-list/attachment-preview-list.component.ts:18](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts#L18)
[lib/attachment-preview-list/attachment-preview-list.component.ts:18](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts#L18)

---

Expand All @@ -59,7 +59,7 @@ An output to notify the parent component if the user tries to retry a failed upl

#### Defined in

[lib/attachment-preview-list/attachment-preview-list.component.ts:22](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts#L22)
[lib/attachment-preview-list/attachment-preview-list.component.ts:22](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts#L22)

---

Expand All @@ -71,6 +71,6 @@ An output to notify the parent component if the user wants to delete a file

#### Defined in

[lib/attachment-preview-list/attachment-preview-list.component.ts:26](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts#L26)
[lib/attachment-preview-list/attachment-preview-list.component.ts:26](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/attachment-preview-list/attachment-preview-list.component.ts#L26)

[//]: # "End of generated content"
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ TextareaInterface.value

#### Defined in

[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:49](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L49)
[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:49](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L49)

---

Expand All @@ -67,7 +67,7 @@ TextareaInterface.placeholder

#### Defined in

[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:53](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L53)
[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:53](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L53)

---

Expand All @@ -83,7 +83,7 @@ TextareaInterface.areMentionsEnabled

#### Defined in

[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:57](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L57)
[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:57](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L57)

---

Expand All @@ -99,7 +99,7 @@ TextareaInterface.inputMode

#### Defined in

[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:61](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L61)
[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:61](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L61)

---

Expand All @@ -115,7 +115,7 @@ TextareaInterface.mentionScope

#### Defined in

[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:65](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L65)
[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:65](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L65)

---

Expand All @@ -131,7 +131,7 @@ TextareaInterface.autoFocus

#### Defined in

[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:69](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L69)
[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:69](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L69)

---

Expand All @@ -147,7 +147,7 @@ TextareaInterface.valueChange

#### Defined in

[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:73](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L73)
[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:73](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L73)

---

Expand All @@ -163,7 +163,7 @@ TextareaInterface.send

#### Defined in

[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:77](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L77)
[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:77](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L77)

---

Expand All @@ -179,6 +179,6 @@ TextareaInterface.userMentions

#### Defined in

[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:81](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L81)
[lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts:81](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.ts#L81)

[//]: # "End of generated content"
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ An optional name of the image, used for fallback image or image title (if `image

#### Defined in

[lib/avatar/avatar.component.ts:35](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L35)
[lib/avatar/avatar.component.ts:35](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L35)

---

Expand All @@ -83,7 +83,7 @@ The URL of the image to be displayed. If the image can't be displayed the first

#### Defined in

[lib/avatar/avatar.component.ts:39](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L39)
[lib/avatar/avatar.component.ts:39](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L39)

---

Expand All @@ -95,7 +95,7 @@ The size in pixels of the avatar image.

#### Defined in

[lib/avatar/avatar.component.ts:43](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L43)
[lib/avatar/avatar.component.ts:43](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L43)

---

Expand All @@ -107,7 +107,7 @@ The location the avatar will be displayed in

#### Defined in

[lib/avatar/avatar.component.ts:47](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L47)
[lib/avatar/avatar.component.ts:47](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L47)

---

Expand All @@ -119,7 +119,7 @@ The channel the avatar belongs to (if avatar of a channel is displayed)

#### Defined in

[lib/avatar/avatar.component.ts:51](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L51)
[lib/avatar/avatar.component.ts:51](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L51)

---

Expand All @@ -131,7 +131,7 @@ The user the avatar belongs to (if avatar of a user is displayed)

#### Defined in

[lib/avatar/avatar.component.ts:55](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L55)
[lib/avatar/avatar.component.ts:55](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L55)

---

Expand All @@ -143,7 +143,7 @@ The type of the avatar: channel if channel avatar is displayed, user if user ava

#### Defined in

[lib/avatar/avatar.component.ts:59](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L59)
[lib/avatar/avatar.component.ts:59](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L59)

---

Expand All @@ -155,7 +155,7 @@ If a channel avatar is displayed, and if the channel has exactly two members a g

#### Defined in

[lib/avatar/avatar.component.ts:63](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L63)
[lib/avatar/avatar.component.ts:63](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L63)

---

Expand All @@ -167,6 +167,6 @@ If channel/user image isn't provided the initials of the name of the channel/use

#### Defined in

[lib/avatar/avatar.component.ts:67](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L67)
[lib/avatar/avatar.component.ts:67](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar/avatar.component.ts#L67)

[//]: # "End of generated content"
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ An optional name of the image, used for fallback image or image title (if `image

#### Defined in

[lib/avatar-placeholder/avatar-placeholder.component.ts:23](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L23)
[lib/avatar-placeholder/avatar-placeholder.component.ts:23](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L23)

---

Expand All @@ -24,7 +24,7 @@ The URL of the image to be displayed. If the image can't be displayed the first

#### Defined in

[lib/avatar-placeholder/avatar-placeholder.component.ts:27](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L27)
[lib/avatar-placeholder/avatar-placeholder.component.ts:27](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L27)

---

Expand All @@ -36,7 +36,7 @@ The size in pixels of the avatar image.

#### Defined in

[lib/avatar-placeholder/avatar-placeholder.component.ts:31](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L31)
[lib/avatar-placeholder/avatar-placeholder.component.ts:31](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L31)

---

Expand All @@ -48,7 +48,7 @@ The location the avatar will be displayed in

#### Defined in

[lib/avatar-placeholder/avatar-placeholder.component.ts:35](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L35)
[lib/avatar-placeholder/avatar-placeholder.component.ts:35](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L35)

---

Expand All @@ -60,7 +60,7 @@ The channel the avatar belongs to (if avatar of a channel is displayed)

#### Defined in

[lib/avatar-placeholder/avatar-placeholder.component.ts:39](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L39)
[lib/avatar-placeholder/avatar-placeholder.component.ts:39](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L39)

---

Expand All @@ -72,7 +72,7 @@ The user the avatar belongs to (if avatar of a user is displayed)

#### Defined in

[lib/avatar-placeholder/avatar-placeholder.component.ts:43](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L43)
[lib/avatar-placeholder/avatar-placeholder.component.ts:43](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L43)

---

Expand All @@ -84,7 +84,7 @@ The type of the avatar: channel if channel avatar is displayed, user if user ava

#### Defined in

[lib/avatar-placeholder/avatar-placeholder.component.ts:47](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L47)
[lib/avatar-placeholder/avatar-placeholder.component.ts:47](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L47)

---

Expand All @@ -96,7 +96,7 @@ If channel/user image isn't provided the initials of the name of the channel/use

#### Defined in

[lib/avatar-placeholder/avatar-placeholder.component.ts:51](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L51)
[lib/avatar-placeholder/avatar-placeholder.component.ts:51](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L51)

---

Expand All @@ -108,6 +108,6 @@ If a channel avatar is displayed, and if the channel has exactly two members a g

#### Defined in

[lib/avatar-placeholder/avatar-placeholder.component.ts:57](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L57)
[lib/avatar-placeholder/avatar-placeholder.component.ts:57](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts#L57)

[//]: # "End of generated content"
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ The channel to be displayed

#### Defined in

[lib/channel-preview/channel-preview.component.ts:25](https://github.com/GetStream/stream-chat-angular/blob/f9a1611/projects/stream-chat-angular/src/lib/channel-preview/channel-preview.component.ts#L25)
[lib/channel-preview/channel-preview.component.ts:28](https://github.com/GetStream/stream-chat-angular/blob/4411374/projects/stream-chat-angular/src/lib/channel-preview/channel-preview.component.ts#L28)

[//]: # "End of generated content"
Loading

0 comments on commit b06af62

Please sign in to comment.