Add optional prop to createTextLinkBlock function to set custom displ…

…ayName
vivid-planet · Oct 9, 2024 · 24af64d · 24af64d
1 parent ec57e2d
commit 24af64d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/.changeset/tiny-tasks-tackle.md b/.changeset/tiny-tasks-tackle.md
@@ -0,0 +1,5 @@
+---
+"@comet/cms-admin": minor
+---
+
+Add optional prop to `createTextLinkBlock` function to set a custom displayName
diff --git a/packages/admin/cms-admin/src/blocks/createTextLinkBlock.tsx b/packages/admin/cms-admin/src/blocks/createTextLinkBlock.tsx
@@ -11,16 +11,22 @@ import {
     withAdditionalBlockAttributes,
 } from "@comet/blocks-admin";
 import { Box } from "@mui/material";
+import { ReactNode } from "react";
 import { FormattedMessage } from "react-intl";
 
 import { TextLinkBlockData, TextLinkBlockInput } from "../blocks.generated";
 
 interface CreateTextLinkBlockOptions {
     name?: string;
+    displayName?: ReactNode;
     link: BlockInterface;
 }
 
-export function createTextLinkBlock({ link: LinkBlock, name = "TextLink" }: CreateTextLinkBlockOptions): BlockInterface {
+export function createTextLinkBlock({
+    link: LinkBlock,
+    name = "TextLink",
+    displayName = <FormattedMessage {...messages.link} />,
+}: CreateTextLinkBlockOptions): BlockInterface {
     const { api: composedApi, block: composedBlock } = composeBlocks({ link: LinkBlock });
 
     const block = withAdditionalBlockAttributes<Pick<TextLinkBlockData, "text">>({
@@ -33,7 +39,7 @@ export function createTextLinkBlock({ link: LinkBlock, name = "TextLink" }: Crea
 
         name,
 
-        displayName: <FormattedMessage {...messages.link} />,
+        displayName,
 
         category: BlockCategory.Navigation,