stream-chat-react-native-core 9.4.0-beta.6 → 9.4.0-beta.7

package/src/hooks/actions/useChannelActionItems.tsx

@@ -15,18 +15,50 @@ import { useIsChannelMuted } from '../../components/ChannelPreview/hooks/useIsCh
 import { useUserMuteActive } from '../../components/Message/hooks/useUserMuteActive';
 import { useTheme, useTranslationContext } from '../../contexts';
 import type { TranslationContextValue } from '../../contexts/translationContext/TranslationContext';
-import { IconProps, Mute, BlockUser, Delete, Sound } from '../../icons';
+import { IconProps, Mute, BlockUser, Delete, Pin, Sound, Unpin } from '../../icons';
 import { ArrowBoxLeft } from '../../icons/leave';
 import { useChannelMembershipState } from '../useChannelMembershipState';
 import { useIsDirectChat } from '../useIsDirectChat';
 import { useStateStore } from '../useStateStore';
 
 export type ChannelActionItem = ActionItem<
-  'mute' | 'muteUser' | 'block' | 'leave' | 'deleteChannel' | string
+  'mute' | 'muteUser' | 'block' | 'leave' | 'deleteChannel' | 'pin' | string
 > & {
+  /**
+   * Per item routing **within a channel preview interaction** (swipe row vs
+   * the sheet that opens from it). Only meaningful when the items are consumed
+   * from `<ChannelSwipableWrapper>`:
+   *
+   * - `'swipe'`: shown only in the swipe-row chips.
+   * - `'sheet'`: shown only in the swipe-triggered options sheet.
+   * - `'both'`: shown in both swipe row and sheet.
+   *
+   * The standalone Channel Details screen does **not** filter by `placement` -
+   * use {@link ChannelActionSurface} (`surface`) instead to vary items between
+   * the channel list and the Channel Details screen.
+   */
   placement: 'both' | 'sheet' | 'swipe';
 };
 
+/**
+ * Identifies which top level UI surface is requesting channel action items.
+ * Passed verbatim into {@link ChannelActionItemsParams} so the default builder
+ * and any integrator supplied `getChannelActionItems` can branch on it - i.e.
+ * to drop or relabel an item on a specific surface or to provide an entirely
+ * different builder per surface.
+ *
+ * - `'list'`: anything driven by a ChannelList interaction, the swipe row
+ *   chips on a channel preview and the bottom sheet that opens from them.
+ *   Subrouting between the swipe row and the sheet is handled by the per item
+ *   {@link ChannelActionItem.placement} field.
+ * - `'details'`: items for the standalone Channel Details screen.
+ *
+ * `surface` operates at the call site level (which UI is asking). It is
+ * optional and when omitted, the default builder applies no surface specific
+ * filtering and returns every item it would otherwise produce.
+ */
+export type ChannelActionSurface = 'list' | 'details';
+
 export type ChannelActionItemsParams = {
   actions: ChannelActions;
   channel: Channel;
@@ -35,6 +67,7 @@ export type ChannelActionItemsParams = {
   isBlocked: boolean | undefined;
   isDirectChat: boolean;
   isPinned: boolean;
+  surface?: ChannelActionSurface;
   t: TranslationContextValue['t'];
   userMuteActive: boolean;
 };
@@ -67,10 +100,14 @@ export const buildDefaultChannelActionItems: BuildDefaultChannelActionItems = (
       unmuteUser,
       blockUser,
       unblockUser,
+      pin,
+      unpin,
     },
     channelMuteActive,
     isBlocked,
     isDirectChat,
+    isPinned,
+    surface,
     userMuteActive,
     t,
     channel,
@@ -135,6 +172,23 @@ export const buildDefaultChannelActionItems: BuildDefaultChannelActionItems = (
     });
   }
 
+  if (surface !== 'details') {
+    actionItems.push({
+      action: isPinned ? unpin : pin,
+      Icon: (props) => <ChannelActionsIcon Icon={isPinned ? Unpin : Pin} {...props} />,
+      id: 'pin',
+      label: isDirectChat
+        ? isPinned
+          ? t('Unpin Chat')
+          : t('Pin Chat')
+        : isPinned
+          ? t('Unpin Group')
+          : t('Pin Group'),
+      placement: 'sheet',
+      type: 'standard',
+    });
+  }
+
   actionItems.push({
     action: leave,
     Icon: (props) => <ChannelActionsIcon Icon={ArrowBoxLeft} {...props} />,
@@ -186,6 +240,7 @@ export const getChannelActionItems: GetChannelActionItems = ({ defaultItems }) =
 
 type UseChannelActionItemsParams = {
   channel: Channel;
+  surface?: ChannelActionSurface;
   getChannelActionItems?: GetChannelActionItems;
 };
 
@@ -194,6 +249,7 @@ const blockedUsersStateSelector = (state: BlockedUsersState) =>
 
 export const useChannelActionItems = ({
   channel,
+  surface,
   getChannelActionItems: getChannelActionItemsProp = getChannelActionItems,
 }: UseChannelActionItemsParams) => {
   const { t } = useTranslationContext();
@@ -225,6 +281,7 @@ export const useChannelActionItems = ({
       isBlocked,
       isDirectChat,
       isPinned,
+      surface,
       t,
       userMuteActive,
     }),
@@ -236,6 +293,7 @@ export const useChannelActionItems = ({
       isBlocked,
       isDirectChat,
       isPinned,
+      surface,
       t,
       userMuteActive,
     ],

package/src/hooks/actions/useChannelActionItemsById.ts

@@ -2,23 +2,30 @@ import { useMemo } from 'react';
 
 import type { Channel } from 'stream-chat';
 
-import type { ChannelActionItem, GetChannelActionItems } from './useChannelActionItems';
+import type {
+  ChannelActionItem,
+  ChannelActionSurface,
+  GetChannelActionItems,
+} from './useChannelActionItems';
 import { useChannelActionItems } from './useChannelActionItems';
 
 export type ChannelActionItemsById = Partial<Record<ChannelActionItem['id'], ChannelActionItem>>;
 
 type UseChannelActionItemsByIdParams = {
   channel: Channel;
+  surface?: ChannelActionSurface;
   getChannelActionItems?: GetChannelActionItems;
 };
 
 export const useChannelActionItemsById = ({
   channel,
+  surface,
   getChannelActionItems,
 }: UseChannelActionItemsByIdParams) => {
   const channelActionItems = useChannelActionItems({
     channel,
     getChannelActionItems,
+    surface,
   });
 
   return useMemo(

package/src/i18n/ar.json

@@ -274,6 +274,7 @@
   "a11y/Loading failed": "Loading failed",
   "a11y/Message actions": "Message actions",
   "a11y/Muted": "مكتوم",
+  "a11y/Pinned": "مثبت",
   "a11y/New message from {{user}}": "New message from {{user}}",
   "a11y/Offline": "Offline",
   "a11y/Open message actions": "Open message actions",
@@ -435,5 +436,9 @@
   "a11y/Message from {{sender}}": "رسالة من {{sender}}",
   "a11y/Gallery Image": "صورة من المعرض",
   "a11y/Gallery Video": "فيديو من المعرض",
-  "a11y/{{position}} of {{count}}": "{{position}} من {{count}}"
+  "a11y/{{position}} of {{count}}": "{{position}} من {{count}}",
+  "Pin Chat": "تثبيت الدردشة",
+  "Pin Group": "تثبيت المجموعة",
+  "Unpin Chat": "إلغاء تثبيت الدردشة",
+  "Unpin Group": "إلغاء تثبيت المجموعة"
 }

package/src/i18n/en.json

@@ -246,6 +246,8 @@
   "Leave Group": "Leave Group",
   "Mute Chat": "Mute Chat",
   "Mute Group": "Mute Group",
+  "Pin Chat": "Pin Chat",
+  "Pin Group": "Pin Group",
   "Admin": "Admin",
   "Moderator": "Moderator",
   "Offline": "Offline",
@@ -255,6 +257,8 @@
   "Unarchive Group": "Unarchive Group",
   "Unmute Chat": "Unmute Chat",
   "Unmute Group": "Unmute Group",
+  "Unpin Chat": "Unpin Chat",
+  "Unpin Group": "Unpin Group",
   "{{memberCount}} members, {{onlineCount}} online_one": "{{memberCount}} member, {{onlineCount}} online",
   "{{memberCount}} members, {{onlineCount}} online_other": "{{memberCount}} members, {{onlineCount}} online",
   "{{memberCount}} members, {{onlineCount}} online_many": "{{memberCount}} members, {{onlineCount}} online",
@@ -284,6 +288,7 @@
   "a11y/Message from you": "Message from you",
   "a11y/Message from {{sender}}": "Message from {{sender}}",
   "a11y/Muted": "Muted",
+  "a11y/Pinned": "Pinned",
   "a11y/New message from {{user}}": "New message from {{user}}",
   "a11y/Offline": "Offline",
   "a11y/Open message actions": "Open message actions",

package/src/i18n/es.json

@@ -274,6 +274,7 @@
   "a11y/Loading failed": "Error al cargar",
   "a11y/Message actions": "Acciones del mensaje",
   "a11y/Muted": "Silenciado",
+  "a11y/Pinned": "Fijado",
   "a11y/New message from {{user}}": "Nuevo mensaje de {{user}}",
   "a11y/Offline": "Sin conexión",
   "a11y/Open message actions": "Abrir acciones del mensaje",
@@ -435,5 +436,9 @@
   "a11y/Message from {{sender}}": "Mensaje de {{sender}}",
   "a11y/Gallery Image": "Imagen de la galería",
   "a11y/Gallery Video": "Vídeo de la galería",
-  "a11y/{{position}} of {{count}}": "{{position}} de {{count}}"
+  "a11y/{{position}} of {{count}}": "{{position}} de {{count}}",
+  "Pin Chat": "Fijar chat",
+  "Pin Group": "Fijar grupo",
+  "Unpin Chat": "Desfijar chat",
+  "Unpin Group": "Desfijar grupo"
 }

package/src/i18n/fr.json

@@ -274,6 +274,7 @@
   "a11y/Loading failed": "Échec du chargement",
   "a11y/Message actions": "Actions du message",
   "a11y/Muted": "Mis en sourdine",
+  "a11y/Pinned": "Épinglé",
   "a11y/New message from {{user}}": "Nouveau message de {{user}}",
   "a11y/Offline": "Hors ligne",
   "a11y/Open message actions": "Ouvrir les actions du message",
@@ -435,5 +436,9 @@
   "a11y/Message from {{sender}}": "Message de {{sender}}",
   "a11y/Gallery Image": "Image de la galerie",
   "a11y/Gallery Video": "Vidéo de la galerie",
-  "a11y/{{position}} of {{count}}": "{{position}} sur {{count}}"
+  "a11y/{{position}} of {{count}}": "{{position}} sur {{count}}",
+  "Pin Chat": "Épingler la discussion",
+  "Pin Group": "Épingler le groupe",
+  "Unpin Chat": "Détacher la discussion",
+  "Unpin Group": "Détacher le groupe"
 }

package/src/i18n/he.json

@@ -274,6 +274,7 @@
   "a11y/Loading failed": "הטעינה נכשלה",
   "a11y/Message actions": "פעולות הודעה",
   "a11y/Muted": "מושתק",
+  "a11y/Pinned": "מוצמד",
   "a11y/New message from {{user}}": "הודעה חדשה מ-{{user}}",
   "a11y/Offline": "לא מקוון",
   "a11y/Open message actions": "פתח פעולות הודעה",
@@ -435,5 +436,9 @@
   "a11y/Message from {{sender}}": "הודעה מאת {{sender}}",
   "a11y/Gallery Image": "תמונה מהגלריה",
   "a11y/Gallery Video": "סרטון מהגלריה",
-  "a11y/{{position}} of {{count}}": "{{position}} מתוך {{count}}"
+  "a11y/{{position}} of {{count}}": "{{position}} מתוך {{count}}",
+  "Pin Chat": "הצמד/י צ'אט",
+  "Pin Group": "הצמד/י קבוצה",
+  "Unpin Chat": "בטל/י הצמדת צ'אט",
+  "Unpin Group": "בטל/י הצמדת קבוצה"
 }

package/src/i18n/hi.json

@@ -274,6 +274,7 @@
   "a11y/Loading failed": "लोड नहीं हो सका",
   "a11y/Message actions": "संदेश की कार्रवाइयां",
   "a11y/Muted": "म्यूट किया गया",
+  "a11y/Pinned": "पिन किया गया",
   "a11y/New message from {{user}}": "{{user}} से नया संदेश",
   "a11y/Offline": "ऑफलाइन",
   "a11y/Open message actions": "संदेश की कार्रवाइयां खोलें",
@@ -435,5 +436,9 @@
   "a11y/Message from {{sender}}": "{{sender}} से संदेश",
   "a11y/Gallery Image": "गैलरी छवि",
   "a11y/Gallery Video": "गैलरी वीडियो",
-  "a11y/{{position}} of {{count}}": "{{count}} में से {{position}}"
+  "a11y/{{position}} of {{count}}": "{{count}} में से {{position}}",
+  "Pin Chat": "चैट पिन करें",
+  "Pin Group": "ग्रुप पिन करें",
+  "Unpin Chat": "चैट अनपिन करें",
+  "Unpin Group": "ग्रुप अनपिन करें"
 }

package/src/i18n/it.json

@@ -274,6 +274,7 @@
   "a11y/Loading failed": "Caricamento non riuscito",
   "a11y/Message actions": "Azioni del messaggio",
   "a11y/Muted": "Silenziato",
+  "a11y/Pinned": "Fissato",
   "a11y/New message from {{user}}": "Nuovo messaggio da {{user}}",
   "a11y/Offline": "Offline",
   "a11y/Open message actions": "Apri azioni del messaggio",
@@ -435,5 +436,9 @@
   "a11y/Message from {{sender}}": "Messaggio da {{sender}}",
   "a11y/Gallery Image": "Immagine della galleria",
   "a11y/Gallery Video": "Video della galleria",
-  "a11y/{{position}} of {{count}}": "{{position}} di {{count}}"
+  "a11y/{{position}} of {{count}}": "{{position}} di {{count}}",
+  "Pin Chat": "Fissa chat",
+  "Pin Group": "Fissa gruppo",
+  "Unpin Chat": "Sfissa chat",
+  "Unpin Group": "Sfissa gruppo"
 }

package/src/i18n/ja.json

@@ -274,6 +274,7 @@
   "a11y/Loading failed": "読み込みに失敗しました",
   "a11y/Message actions": "メッセージの操作",
   "a11y/Muted": "ミュート中",
+  "a11y/Pinned": "ピン留め中",
   "a11y/New message from {{user}}": "{{user}}からの新しいメッセージ",
   "a11y/Offline": "オフライン",
   "a11y/Open message actions": "メッセージの操作を開く",
@@ -435,5 +436,9 @@
   "a11y/Message from {{sender}}": "{{sender}}からのメッセージ",
   "a11y/Gallery Image": "ギャラリー画像",
   "a11y/Gallery Video": "ギャラリービデオ",
-  "a11y/{{position}} of {{count}}": "{{count}} 中 {{position}}"
+  "a11y/{{position}} of {{count}}": "{{count}} 中 {{position}}",
+  "Pin Chat": "チャットをピン留め",
+  "Pin Group": "グループをピン留め",
+  "Unpin Chat": "チャットのピン留めを解除",
+  "Unpin Group": "グループのピン留めを解除"
 }

package/src/i18n/ko.json

@@ -274,6 +274,7 @@
   "a11y/Loading failed": "로드 실패",
   "a11y/Message actions": "메시지 작업",
   "a11y/Muted": "음소거됨",
+  "a11y/Pinned": "고정됨",
   "a11y/New message from {{user}}": "{{user}}님의 새 메시지",
   "a11y/Offline": "오프라인",
   "a11y/Open message actions": "메시지 작업 열기",
@@ -435,5 +436,9 @@
   "a11y/Message from {{sender}}": "{{sender}}님의 메시지",
   "a11y/Gallery Image": "갤러리 이미지",
   "a11y/Gallery Video": "갤러리 동영상",
-  "a11y/{{position}} of {{count}}": "{{count}}개 중 {{position}}번째"
+  "a11y/{{position}} of {{count}}": "{{count}}개 중 {{position}}번째",
+  "Pin Chat": "채팅 고정",
+  "Pin Group": "그룹 고정",
+  "Unpin Chat": "채팅 고정 해제",
+  "Unpin Group": "그룹 고정 해제"
 }

package/src/i18n/nl.json

@@ -274,6 +274,7 @@
   "a11y/Loading failed": "Laden mislukt",
   "a11y/Message actions": "Berichtacties",
   "a11y/Muted": "Gedempt",
+  "a11y/Pinned": "Vastgemaakt",
   "a11y/New message from {{user}}": "Nieuw bericht van {{user}}",
   "a11y/Offline": "Offline",
   "a11y/Open message actions": "Berichtacties openen",
@@ -435,5 +436,9 @@
   "a11y/Message from {{sender}}": "Bericht van {{sender}}",
   "a11y/Gallery Image": "Galerij-afbeelding",
   "a11y/Gallery Video": "Galerij-video",
-  "a11y/{{position}} of {{count}}": "{{position}} van {{count}}"
+  "a11y/{{position}} of {{count}}": "{{position}} van {{count}}",
+  "Pin Chat": "Chat vastmaken",
+  "Pin Group": "Groep vastmaken",
+  "Unpin Chat": "Chat losmaken",
+  "Unpin Group": "Groep losmaken"
 }

package/src/i18n/pt-br.json

@@ -274,6 +274,7 @@
   "a11y/Loading failed": "Falha ao carregar",
   "a11y/Message actions": "Ações da mensagem",
   "a11y/Muted": "Silenciado",
+  "a11y/Pinned": "Fixado",
   "a11y/New message from {{user}}": "Nova mensagem de {{user}}",
   "a11y/Offline": "Offline",
   "a11y/Open message actions": "Abrir ações da mensagem",
@@ -435,5 +436,9 @@
   "a11y/Message from {{sender}}": "Mensagem de {{sender}}",
   "a11y/Gallery Image": "Imagem da galeria",
   "a11y/Gallery Video": "Vídeo da galeria",
-  "a11y/{{position}} of {{count}}": "{{position}} de {{count}}"
+  "a11y/{{position}} of {{count}}": "{{position}} de {{count}}",
+  "Pin Chat": "Fixar conversa",
+  "Pin Group": "Fixar grupo",
+  "Unpin Chat": "Desafixar conversa",
+  "Unpin Group": "Desafixar grupo"
 }

package/src/i18n/ru.json

@@ -274,6 +274,7 @@
   "a11y/Loading failed": "Не удалось загрузить",
   "a11y/Message actions": "Действия с сообщением",
   "a11y/Muted": "Без звука",
+  "a11y/Pinned": "Закреплено",
   "a11y/New message from {{user}}": "Новое сообщение от {{user}}",
   "a11y/Offline": "Не в сети",
   "a11y/Open message actions": "Открыть действия с сообщением",
@@ -435,5 +436,9 @@
   "a11y/Message from {{sender}}": "Сообщение от {{sender}}",
   "a11y/Gallery Image": "Изображение из галереи",
   "a11y/Gallery Video": "Видео из галереи",
-  "a11y/{{position}} of {{count}}": "{{position}} из {{count}}"
+  "a11y/{{position}} of {{count}}": "{{position}} из {{count}}",
+  "Pin Chat": "Закрепить чат",
+  "Pin Group": "Закрепить группу",
+  "Unpin Chat": "Открепить чат",
+  "Unpin Group": "Открепить группу"
 }

package/src/i18n/tr.json

@@ -274,6 +274,7 @@
   "a11y/Loading failed": "Yükleme başarısız",
   "a11y/Message actions": "Mesaj eylemleri",
   "a11y/Muted": "Sessize alındı",
+  "a11y/Pinned": "Sabitlendi",
   "a11y/New message from {{user}}": "{{user}} kullanıcısından yeni mesaj",
   "a11y/Offline": "Çevrimdışı",
   "a11y/Open message actions": "Mesaj eylemlerini aç",
@@ -435,5 +436,9 @@
   "a11y/Message from {{sender}}": "{{sender}} kullanıcısından mesaj",
   "a11y/Gallery Image": "Galeri görüntüsü",
   "a11y/Gallery Video": "Galeri videosu",
-  "a11y/{{position}} of {{count}}": "{{count}} öğeden {{position}}"
+  "a11y/{{position}} of {{count}}": "{{count}} öğeden {{position}}",
+  "Pin Chat": "Sohbeti sabitle",
+  "Pin Group": "Grubu sabitle",
+  "Unpin Chat": "Sohbetin sabitlemesini kaldır",
+  "Unpin Group": "Grubun sabitlemesini kaldır"
 }

package/src/version.json

@@ -1,3 +1,3 @@
 {
-  "version": "9.4.0-beta.6"
+  "version": "9.4.0-beta.7"
 }