Skip to content

An open source design system that's fully customizable and agent ready

TypeScript
2.2 KB
Raw Blame
// Copyright (c) Meta Platforms, Inc. and affiliates.

/** @type {import('@astryxdesign/cli/authoring').ComponentDoc} */

export const docs = {
  name: 'CommandPaletteFooter',
  subComponentOf: 'CommandPalette',
  displayName: 'Command Palette Footer',
  isHiddenFromOverview: true,
  description:
    'Footer with keyboard guidance. CommandPalette renders the default arrow, Enter, and Escape hints automatically.',
  usage: {
    description:
      'CommandPalette renders CommandPaletteFooter automatically. Pass a CommandPaletteFooter to the footer slot only when replacing the default guidance.',
    anatomy: [
      {
        name: 'Footer',
        required: true,
        description:
          'Supporting region that presents default guidance or caller-provided footer content.',
      },
      {
        name: 'Keyboard shortcut',
        required: false,
        description:
          'Default Kbd badges for navigation, selection, and dismissal.',
      },
    ],
  },
  props: [
    {
      name: 'children',
      type: 'ReactNode',
      description:
        'Custom footer content. When omitted, renders default keyboard hints via Kbd.',
    },
    {
      name: 'xstyle',
      type: 'StyleXStyles',
      description:
        'StyleX styles for layout customization. Must be a stylex.create() value.',
    },
  ],
  theming: {
    targets: [{className: 'astryx-command-palette-footer'}],
  },
};

export const docsZh = {
  name: 'CommandPaletteFooter',
  isHiddenFromOverview: true,
  displayName: 'Command Palette Footer',
  description:
    '显示键盘导航提示的页脚。未提供子元素时渲染默认方向键/Enter/Escape 提示。',
  propDescriptions: {
    children: '自定义页脚内容。省略时通过 Kbd 渲染默认键盘提示。',
    xstyle: 'StyleX 布局自定义样式。必须是 stylex.create() 的值。',
  },
};

export const docsDense = {
  name: 'CommandPaletteFooter',
  isHiddenFromOverview: true,
  displayName: 'Command Palette Footer',
  description: 'footer w/ kbd hints; default=arrow/Enter/Escape hints via Kbd',
  propDescriptions: {
    children: 'custom content; default renders kbd hints',
    xstyle: 'StyleX layout styles; must be stylex.create() value',
  },
};