Skip to content

Self-hosted, plugin-based server management.

3.3 KB
Raw Blame
import React from "react";
import { useTranslation } from "react-i18next";
import { useActionSlot } from "@/hooks/use-action-slot";
import { invokeAction, type SlotContribution } from "@/shell/action-registry";

interface ActionSlotProps {
  slotId: string;
  /**
   * Arguments for the action, read at click time rather than on render. A
   * getter keeps expensive context (a serialized terminal buffer, say) off the
   * render path.
   */
  context?: () => unknown[];
  /** Applied to the default button so a slot owner can match its own controls. */
  className?: string;
  /** Hides the whole slot. For a surface that is contextually unavailable. */
  enabled?: boolean;
  /** Renders a contribution the owner's own way instead of as a button. */
  renderItem?: (
    contribution: SlotContribution,
    invoke: () => void,
  ) => React.ReactNode;
  /** Icon-only, for toolbars that collapse their labels. */
  hideLabels?: boolean;
  /** Passed to each contribution's `when`. */
  when?: Record<string, unknown>;
}

/**
 * Renders whatever plugins have contributed to a named slot.
 *
 * Renders null when there is nothing to show, which covers both "no plugin
 * contributed" and "the user may not see what was contributed". Those two
 * cases are deliberately identical in the DOM: no placeholder, no disabled
 * button, nothing hinting at a feature the user cannot reach.
 */
export function ActionSlot({
  slotId,
  context,
  className,
  enabled = true,
  renderItem,
  hideLabels,
  when,
}: ActionSlotProps) {
  const { t } = useTranslation();
  const contributions = useActionSlot(slotId, when).filter(
    (contribution) => contribution.kind !== "component",
  );

  if (!enabled || contributions.length === 0) return null;

  return (
    <>
      {contributions.map((contribution) => {
        const invoke = () => {
          void invokeAction(contribution.actionId, ...(context?.() ?? []));
        };

        if (renderItem) {
          return (
            <React.Fragment key={contribution.actionId}>
              {renderItem(contribution, invoke)}
            </React.Fragment>
          );
        }

        const Icon = contribution.icon;
        const label = t(contribution.titleKey);

        return (
          <button
            key={contribution.actionId}
            type="button"
            className={className}
            aria-label={label}
            title={label}
            onClick={invoke}
          >
            {Icon && <Icon className="size-4 shrink-0" />}
            {!hideLabels && label}
          </button>
        );
      })}
    </>
  );
}

/**
 * Renders the component contributions in a slot, each with the owner's
 * props. Same permission and `when` filtering as buttons, and the same
 * nothing-at-all output when there is nothing to show.
 */
export function ComponentSlot({
  slotId,
  props,
  when,
}: {
  slotId: string;
  props?: Record<string, unknown>;
  when?: Record<string, unknown>;
}) {
  const contributions = useActionSlot(slotId, when).filter(
    (contribution) =>
      contribution.kind === "component" && contribution.component,
  );
  if (contributions.length === 0) return null;
  return (
    <>
      {contributions.map((contribution) => {
        const Contributed = contribution.component!;
        return <Contributed key={contribution.actionId} {...(props ?? {})} />;
      })}
    </>
  );
}