feat: 🎸 improve the block menu config api

[Saul-Mirone]

✅ Closes: #1916

• I read the contributing guide
• I agree to follow the code of conduct

Summary

Improve the block menu config api.

1. Restructured Configuration Interface

• Replaced flat configuration properties with nested group-based configuration
• Introduced three main configuration groups:
  • textGroup: For text-related blocks (paragraphs, headings, quotes, dividers)
  • listGroup: For list-related blocks (bullet, ordered, task lists)
  • advancedGroup: For advanced blocks (images, code blocks, tables, math)

2. Enhanced Type Safety

• Added DeepPartial utility type for better type inference
• Introduced nullable configuration options to allow disabling specific menu items
• Improved type definitions for menu item configurations

3. Improved Customization

• Each menu item can now be individually enabled/disabled by setting it to null
• Groups can be completely hidden by setting the entire group to null
• Maintained backward compatibility with default values

4. Code Organization

• Added new types.ts utility file for shared type definitions
• Refactored menu configuration logic to be more maintainable
• Improved conditional rendering of menu items based on feature flags

Breaking Changes

The configuration interface has been significantly changed. Users will need to update their configurations to use the new nested structure. For example:

// Old configuration
{
  slashMenuTextGroupLabel: 'Text Blocks',
  slashMenuH1Label: 'Large Heading'
}

// New configuration
{
  textGroup: {
    label: 'Text Blocks',
    h1: {
      label: 'Large Heading'
    }
  }
}

Migration Guide

1. Group your existing configuration properties into the appropriate groups
2. Convert flat properties to nested objects
3. Use null to disable specific menu items or entire groups
4. Update any custom menu building logic to work with the new structure

How did you test this change?

CI, Manually.

• main
  • feat: 🎸 improve the block menu config api #1953 👈

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
milkdown-storybook	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 7, 2025 4:35am