feat: add icon to BlockStyleDefinition

sanity-io · May 10, 2024 · c150712 · c150712
1 parent c43ccf4
commit c150712
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 1 deletion.
diff --git a/packages/@sanity/schema/src/sanity/validation/types/block.ts b/packages/@sanity/schema/src/sanity/validation/types/block.ts
@@ -20,7 +20,7 @@ const allowedKeys = [
   'validation',
 ]
 const allowedMarkKeys = ['decorators', 'annotations']
-const allowedStyleKeys = ['blockEditor', 'title', 'value', 'component']
+const allowedStyleKeys = ['blockEditor', 'title', 'value', 'icon', 'component']
 const allowedDecoratorKeys = ['blockEditor', 'title', 'value', 'icon', 'component']
 const allowedListKeys = ['title', 'value', 'icon', 'component']
 const supportedBuiltInObjectTypes = ['file', 'image', 'object', 'reference']

diff --git a/packages/@sanity/schema/test/validation/validation.test.ts b/packages/@sanity/schema/test/validation/validation.test.ts
@@ -1,4 +1,5 @@
 import {describe, expect, test} from '@jest/globals'
+import {SquareIcon} from '@sanity/icons'
 import {flatten} from 'lodash'
 
 import {validateSchema} from '../../src/sanity/validateSchema'
@@ -171,4 +172,35 @@ describe('Validation test', () => {
       helpId: 'schema-array-of-type-builtin-type-conflict',
     })
   })
+
+  test('accepts blocks with a style icon', () => {
+    const schemaDef = [
+      {
+        name: 'testBlock',
+        type: 'block',
+        styles: [{icon: SquareIcon, title: 'Normal text', value: 'normal'}],
+      },
+    ]
+
+    const validation = validateSchema(schemaDef).get('testBlock')
+    const validationErrors = validation._problems.filter(
+      (problem: any) => problem.severity === 'error',
+    )
+    expect(validationErrors).toHaveLength(0)
+  })
+  test('accepts blocks without a style icon', () => {
+    const schemaDef = [
+      {
+        name: 'testBlock',
+        type: 'block',
+        styles: [{title: 'Normal text', value: 'normal'}],
+      },
+    ]
+
+    const validation = validateSchema(schemaDef).get('testBlock')
+    const validationErrors = validation._problems.filter(
+      (problem: any) => problem.severity === 'error',
+    )
+    expect(validationErrors).toHaveLength(0)
+  })
 })
diff --git a/packages/@sanity/types/src/schema/definition/type/block.ts b/packages/@sanity/types/src/schema/definition/type/block.ts
@@ -113,6 +113,7 @@ export interface BlockStyleDefinition {
   title: string
   value: string
   i18nTitleKey?: string
+  icon?: ReactNode | ComponentType
 }
 
 /**