Spartan UI 项目中 Dropdown 组件拆分问题的解决方案

问题背景

在使用 Angular 17.3.7 和 Spartan UI 0.0.1-alpha.347 版本开发过程中，开发者遇到了一个关于下拉菜单(dropdown)组件拆分的问题。当尝试将下拉菜单功能拆分为多个组件时，系统抛出了一个依赖注入错误，提示缺少 InjectionToken cdk-menu-stack 的提供者。

错误分析

这个问题的根源在于 Angular CDK 的菜单系统设计。当菜单组件被拆分为多个独立组件时，Angular 的依赖注入系统无法自动维护菜单堆栈(menu stack)的上下文。菜单堆栈是 CDK 菜单系统用来跟踪当前活动菜单层级的重要机制。

错误信息显示的是一个典型的依赖注入链断裂问题，系统在尝试解析 InjectionToken cdk-menu-stack 时失败，因为拆分后的组件没有正确继承或提供菜单堆栈上下文。

解决方案

要解决这个问题，需要在拆分后的菜单组件中显式提供 PARENT_OR_NEW_MENU_STACK_PROVIDER。这个提供者来自 @angular/cdk/menu，它确保了菜单堆栈的正确继承或创建。

具体实现方式如下：

1. 在组件装饰器的 providers 数组中添加 PARENT_OR_NEW_MENU_STACK_PROVIDER
2. 确保所有相关的 CDK 和 Spartan UI 菜单组件都已正确导入

实现示例

import { PARENT_OR_NEW_MENU_STACK_PROVIDER } from '@angular/cdk/menu';
import { CommonModule } from '@angular/common';
import { Component, Input, TemplateRef, input } from '@angular/core';
import { HlmButtonDirective } from '@spartan-ng/ui-button-helm';
import { HlmIconComponent } from '@spartan-ng/ui-icon-helm';
import { BrnMenuTriggerDirective } from '@spartan-ng/ui-menu-brain';
import {
  HlmMenuComponent,
  HlmMenuGroupComponent,
  HlmMenuItemDirective,
  HlmMenuItemIconDirective,
  HlmMenuItemSubIndicatorComponent,
  HlmMenuLabelComponent,
  HlmMenuSeparatorComponent,
  HlmMenuShortcutComponent,
  HlmSubMenuComponent,
} from '@spartan-ng/ui-menu-helm';

@Component({
  selector: 'app-dropdown',
  standalone: true,
  imports: [
    CommonModule,
    BrnMenuTriggerDirective,
    HlmMenuComponent,
    HlmSubMenuComponent,
    HlmMenuItemDirective,
    HlmMenuItemSubIndicatorComponent,
    HlmMenuLabelComponent,
    HlmMenuShortcutComponent,
    HlmMenuSeparatorComponent,
    HlmMenuItemIconDirective,
    HlmMenuGroupComponent,
    HlmButtonDirective,
    HlmIconComponent,
  ],
  providers: [
    PARENT_OR_NEW_MENU_STACK_PROVIDER,
  ],
  template: `
    <button
      type="button"
      [disabled]="disabled()"
      [brnMenuTriggerFor]="menu">
      <ng-content select="[button]"></ng-content>
    </button>

    <ng-template #menu>
      <hlm-menu>
        <ng-container [ngTemplateOutlet]="content"></ng-container>
      </hlm-menu>
    </ng-template>
  `,
})
export class DropdownComponent {
  @Input() content: TemplateRef<unknown> | null = null;
  disabled = input<boolean>(false);
}

技术原理

PARENT_OR_NEW_MENU_STACK_PROVIDER 是 Angular CDK 菜单系统提供的一个特殊提供者，它的作用是：

1. 当组件位于现有菜单上下文内时，继承父级的菜单堆栈
2. 当组件是独立使用时，创建一个新的菜单堆栈

这种设计模式确保了菜单组件无论在何种上下文中使用，都能保持正确的层级关系和行为。对于复杂的、可拆分的菜单系统来说，这种显式的上下文管理是必要的。

最佳实践建议

1. 组件拆分粒度：合理控制菜单组件的拆分粒度，避免过度拆分导致管理复杂度增加
2. 上下文一致性：确保所有拆分后的菜单组件都提供 PARENT_OR_NEW_MENU_STACK_PROVIDER
3. 模板设计：使用 ng-template 和 ng-content 提高组件的灵活性和复用性
4. 状态管理：考虑使用输入属性和信号(Signal)来管理组件状态，如示例中的 disabled 状态

总结

在 Spartan UI 项目中使用可拆分的下拉菜单组件时，正确处理菜单堆栈上下文是关键。通过显式提供 PARENT_OR_NEW_MENU_STACK_PROVIDER，开发者可以构建灵活、可维护的菜单系统，同时避免依赖注入错误。这种解决方案不仅适用于当前问题，也为其他需要上下文继承的组件设计提供了参考模式。