fix(core): rename studioAnnouncements subtitle to preHeader

sanity-io · Sep 23, 2024 · c85bd1b · c85bd1b
1 parent 51defa8
commit c85bd1b
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 15 deletions.
diff --git a/packages/sanity/src/core/studio/studioAnnouncements/StudioAnnouncementsCard.tsx b/packages/sanity/src/core/studio/studioAnnouncements/StudioAnnouncementsCard.tsx
@@ -81,7 +81,7 @@ interface StudioAnnouncementCardProps {
   id: string
   name: string
   isOpen: boolean
-  subtitle: string
+  preHeader: string
   onCardClick: () => void
   onCardDismiss: () => void
 }
@@ -95,7 +95,7 @@ export function StudioAnnouncementsCard({
   id,
   isOpen,
   name,
-  subtitle,
+  preHeader,
   onCardClick,
   onCardDismiss,
 }: StudioAnnouncementCardProps) {
@@ -139,7 +139,7 @@ export function StudioAnnouncementsCard({
             <Stack space={3}>
               <Box marginRight={6}>
                 <Text as={'h3'} size={1} muted>
-                  {subtitle}
+                  {preHeader}
                 </Text>
               </Box>
               <Text size={1} weight="medium">

diff --git a/packages/sanity/src/core/studio/studioAnnouncements/StudioAnnouncementsProvider.tsx b/packages/sanity/src/core/studio/studioAnnouncements/StudioAnnouncementsProvider.tsx
@@ -140,7 +140,7 @@ export function StudioAnnouncementsProvider({children}: StudioAnnouncementsProvi
       {children}
       {unseenAnnouncements.length > 0 && (
         <StudioAnnouncementsCard
-          subtitle={unseenAnnouncements[0].subtitle}
+          preHeader={unseenAnnouncements[0].preHeader}
           title={unseenAnnouncements[0].title}
           name={unseenAnnouncements[0].name}
           id={unseenAnnouncements[0]._id}

diff --git a/...ges/sanity/src/core/studio/studioAnnouncements/__tests__/StudioAnnouncementsCard.test.tsx b/...ges/sanity/src/core/studio/studioAnnouncements/__tests__/StudioAnnouncementsCard.test.tsx
@@ -36,7 +36,7 @@ jest.mock('../../../version', () => ({
 const announcementCardProps = {
   title: 'New Features Available',
   id: 'foo',
-  subtitle: "What's new",
+  preHeader: "What's new",
   name: 'new-features',
 } as const
 
@@ -73,24 +73,24 @@ describe('StudioAnnouncementsCard', () => {
     expect(screen.getByText("What's new")).toBeInTheDocument()
     expect(screen.getByText(announcementCardProps.title)).toBeInTheDocument()
   })
-  test('renders a different subtitle', async () => {
+  test('renders a different preHeader', async () => {
     const onCardClickMock = jest.fn()
     const onCardDismissMock = jest.fn()
 
-    const subtitle = 'Check out the new features'
+    const preHeader = 'Check out the new features'
     const wrapper = await createAnnouncementWrapper()
     render(
       <StudioAnnouncementsCard
         {...announcementCardProps}
-        subtitle={subtitle}
+        preHeader={preHeader}
         isOpen
         onCardClick={onCardClickMock}
         onCardDismiss={onCardDismissMock}
       />,
       {wrapper},
     )
 
-    expect(screen.getByText(subtitle)).toBeInTheDocument()
+    expect(screen.getByText(preHeader)).toBeInTheDocument()
     expect(screen.getByText(announcementCardProps.title)).toBeInTheDocument()
   })
   test('does not render when isOpen is false', async () => {

diff --git a/...s/sanity/src/core/studio/studioAnnouncements/__tests__/StudioAnnouncementsDialog.test.tsx b/...s/sanity/src/core/studio/studioAnnouncements/__tests__/StudioAnnouncementsDialog.test.tsx
@@ -31,7 +31,7 @@ const MOCKED_ANNOUNCEMENTS: StudioAnnouncementDocument[] = [
     _updatedAt: '',
     title: 'Announcement 1',
     name: 'announcement-1',
-    subtitle: "What's new",
+    preHeader: "What's new",
     body: [
       {
         _type: 'block',
@@ -72,7 +72,7 @@ const MOCKED_ANNOUNCEMENTS: StudioAnnouncementDocument[] = [
     _updatedAt: '',
     title: 'Announcement 2',
     name: 'announcement-2',
-    subtitle: "What's new",
+    preHeader: "What's new",
     body: [
       {
         _type: 'block',

diff --git a/...sanity/src/core/studio/studioAnnouncements/__tests__/StudioAnnouncementsMenuItem.test.tsx b/...sanity/src/core/studio/studioAnnouncements/__tests__/StudioAnnouncementsMenuItem.test.tsx
@@ -34,7 +34,7 @@ const MOCKED_ANNOUNCEMENT: StudioAnnouncementDocument = {
   publishedDate: '2024-09-10T14:44:00.000Z',
   audience: 'everyone',
   name: 'announcement-1',
-  subtitle: "What's new",
+  preHeader: "What's new",
 }
 const useStudioAnnouncementsMock = useStudioAnnouncements as jest.Mock<
   typeof useStudioAnnouncements

diff --git a/...sanity/src/core/studio/studioAnnouncements/__tests__/StudioAnnouncementsProvider.test.tsx b/...sanity/src/core/studio/studioAnnouncements/__tests__/StudioAnnouncementsProvider.test.tsx
@@ -76,7 +76,7 @@ const mockAnnouncements: StudioAnnouncementDocument[] = [
     title: 'Announcement 1',
     body: [],
     announcementType: 'whats-new',
-    subtitle: "What's new",
+    preHeader: "What's new",
     publishedDate: '2024-09-10T14:44:00.000Z',
     audience: 'everyone',
     name: 'announcement-1',
@@ -90,7 +90,7 @@ const mockAnnouncements: StudioAnnouncementDocument[] = [
     title: 'Announcement 2',
     body: [],
     announcementType: 'whats-new',
-    subtitle: "What's new",
+    preHeader: "What's new",
     publishedDate: '2024-09-10T14:44:00.000Z',
     audience: 'everyone',
     name: 'announcement-2',

diff --git a/packages/sanity/src/core/studio/studioAnnouncements/types.ts b/packages/sanity/src/core/studio/studioAnnouncements/types.ts
@@ -30,7 +30,7 @@ export interface StudioAnnouncementDocument {
     | 'below-than-or-equal-version'
   audienceRole?: AudienceRole[] | undefined
   studioVersion?: string
-  subtitle: string
+  preHeader: string
 }
 
 export interface StudioAnnouncementsContextValue {