documenter.test.ts.snap

// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`definition for board matches the snapshot > board 1`] = `
{
  "dashCaseName": "board",
  "events": [
    {
      "cancelable": false,
      "description": "Called when a user modifies the size or position of board items.

The change detail has the following properties:

* \`items\`: (readonly Item<D>[]) - the updated items array.
* \`addedItem\`: (Item<D>, optional) - the item that was added as part of the update, if applicable.
* \`removedItem\`: (Item<D>, optional) - the item that was removed as part of the update, if applicable.
* \`resizedItem\`: (Item<D>, optional) - the item that was resized as part of the update, if applicable.
* \`movedItem\`: (Item<D>, optional) - the item that was moved as part of the update, if applicable.",
      "detailInlineType": {
        "name": "BoardProps.ItemsChangeDetail<D>",
        "properties": [
          {
            "name": "addedItem",
            "optional": true,
            "type": "BoardProps.Item<D>",
          },
          {
            "name": "items",
            "optional": false,
            "type": "ReadonlyArray<BoardProps.Item<D>>",
          },
          {
            "name": "movedItem",
            "optional": true,
            "type": "BoardProps.Item<D>",
          },
          {
            "name": "removedItem",
            "optional": true,
            "type": "BoardProps.Item<D>",
          },
          {
            "name": "resizedItem",
            "optional": true,
            "type": "BoardProps.Item<D>",
          },
        ],
        "type": "object",
      },
      "detailType": "BoardProps.ItemsChangeDetail<D>",
      "name": "onItemsChange",
    },
  ],
  "functions": [],
  "name": "Board",
  "properties": [
    {
      "description": "An object containing all the necessary localized strings required by the component.

Live announcements:
* \`liveAnnouncementDndStarted(BoardProps.DndOperationType): string\` - the function to create a live announcement string to indicate start of DnD ("reorder", "resize" or "insert").
* \`liveAnnouncementDndItemReordered(BoardProps.DndReorderState<D>): string\` - the function to create a live announcement string to indicate when DnD reorder is performed.
* \`liveAnnouncementDndItemResized(BoardProps.DndResizeState<D>): string\` - the function to create a live announcement string to indicate when DnD resize is performed.
* \`liveAnnouncementDndItemInserted(BoardProps.DndInsertState<D>): string\` - the function to create a live announcement string to indicate when DnD insert is performed.
* \`liveAnnouncementDndDiscarded(BoardProps.DndOperationType): string\` - the function to create a live announcement string to indicate commit of DnD ("reorder", "resize" or "insert").
* \`liveAnnouncementDndCommitted(BoardProps.DndOperationType): string\` - the function to create a live announcement string to indicate discard of DnD ("reorder", "resize" or "insert").
* \`liveAnnouncementItemRemoved(BoardProps.OperationStateRemove<D>): string\` - the function to create a live announcement string to indicate when item is removed.",
      "inlineType": {
        "name": "BoardProps.I18nStrings<D>",
        "properties": [
          {
            "name": "liveAnnouncementDndCommitted",
            "optional": false,
            "type": "(operationType: BoardProps.DndOperationType) => string",
          },
          {
            "name": "liveAnnouncementDndDiscarded",
            "optional": false,
            "type": "(operationType: BoardProps.DndOperationType) => string",
          },
          {
            "name": "liveAnnouncementDndItemInserted",
            "optional": false,
            "type": "(operation: BoardProps.DndInsertState<D>) => string",
          },
          {
            "name": "liveAnnouncementDndItemReordered",
            "optional": false,
            "type": "(operation: BoardProps.DndReorderState<D>) => string",
          },
          {
            "name": "liveAnnouncementDndItemResized",
            "optional": false,
            "type": "(operation: BoardProps.DndResizeState<D>) => string",
          },
          {
            "name": "liveAnnouncementDndStarted",
            "optional": false,
            "type": "(operationType: BoardProps.DndOperationType) => string",
          },
          {
            "name": "liveAnnouncementItemRemoved",
            "optional": false,
            "type": "(operation: BoardProps.ItemRemovedState<D>) => string",
          },
          {
            "name": "navigationAriaDescription",
            "optional": true,
            "type": "string",
          },
          {
            "name": "navigationAriaLabel",
            "optional": false,
            "type": "string",
          },
          {
            "name": "navigationItemAriaLabel",
            "optional": false,
            "type": "(item: BoardProps.Item<D> | null) => string",
          },
        ],
        "type": "object",
      },
      "name": "i18nStrings",
      "optional": false,
      "type": "BoardProps.I18nStrings<D>",
    },
    {
      "description": "Specifies the items displayed in the board. Each item includes its position on the board and
optional data. The content of an item is controlled by the \`renderItem\` property.

The BoardProps.Item includes:
* \`id\` (string) - the unique item identifier. The IDs of any two items in a page must be different.
* \`definition.minRowSpan\` (number, optional) - the minimal number of rows the item is allowed to take. It can't be less than two. Defaults to two.
* \`definition.minColumnSpan\` (number, optional) - the minimal number of columns the item is allowed to take. It can't be less than one. Defaults to one.
* \`definition.defaultRowSpan\` (number, optional) - the number or rows the item will take when inserted to the board. It can't be less than \`definition.minRowSpan\`.
* \`definition.defaultColumnSpan\` (number, optional) - the number or columns the item will take when inserted in the board. It can't be less than \`definition.minColumnSpan\`.
* \`columnOffset\` (mapping, optional) - the item's offset from the first column (per layout) starting from zero. The value is updated by \`onItemsChange\` after an update is committed.
* \`rowSpan\` (number, optional) - the item's vertical size starting from two. The value is updated by \`onItemsChange\` after an update is committed.
* \`columnSpan\` (number, optional) - the item's horizontal size starting from one. The value is updated by \`onItemsChange\` after an update is committed.
* \`data\` (D) - optional item data which can include the specific configurations of an item, such as its title.",
      "name": "items",
      "optional": false,
      "type": "ReadonlyArray<BoardProps.Item<D>>",
    },
    {
      "description": "Specifies a function to render content for board items. The return value must include board item component.

The function takes the item and its associated actions (BoardProps.ItemActions) that include:
* \`removeItem(): void\` - the callback to issue the item's removal. Once issued, the \`onItemsChange\` will fire to update the state.",
      "inlineType": {
        "name": "(item: BoardProps.Item<D>, actions: BoardProps.ItemActions) => JSX.Element",
        "parameters": [
          {
            "name": "item",
            "type": "BoardProps.Item<D>",
          },
          {
            "name": "actions",
            "type": "BoardProps.ItemActions",
          },
        ],
        "returnType": "JSX.Element",
        "type": "function",
      },
      "name": "renderItem",
      "optional": false,
      "type": "(item: BoardProps.Item<D>, actions: BoardProps.ItemActions) => JSX.Element",
    },
  ],
  "regions": [
    {
      "description": "Rendered when the \`items\` array is empty.

When items are loading the slot can be used to render the loading indicator.",
      "isDefault": false,
      "name": "empty",
    },
  ],
  "releaseStatus": "stable",
}
`;

exports[`definition for board-item matches the snapshot > board-item 1`] = `
{
  "dashCaseName": "board-item",
  "events": [],
  "functions": [],
  "name": "BoardItem",
  "properties": [
    {
      "description": "Determines whether the main content of the item has padding. If \`true\`, removes the default padding
from the content area.",
      "name": "disableContentPaddings",
      "optional": true,
      "type": "boolean",
    },
    {
      "description": "An object containing all the necessary localized strings required by the component.

ARIA labels:
* \`dragHandleAriaLabel\` (string) - the ARIA label for the drag handle.
* \`dragHandleAriaDescription\` (string, optional) - the ARIA description for the drag handle.
* \`resizeHandleAriaLabel\` (string) - the ARIA label for the resize handle.
* \`resizeHandleAriaDescription\` (string, optional) - the ARIA description for the resize handle.
* \`dragHandleTooltipText\` (string, optional) - the ARIA description for the resize handle.
* \`dragHandleTooltipText\` (string, optional) - the Text for the drag handle Tooltip.
* \`resizeHandleTooltipText\` (string, optional) - the Text for the resize handle Tooltip.",
      "inlineType": {
        "name": "BoardItemProps.I18nStrings",
        "properties": [
          {
            "name": "dragHandleAriaDescription",
            "optional": true,
            "type": "string",
          },
          {
            "name": "dragHandleAriaLabel",
            "optional": false,
            "type": "string",
          },
          {
            "name": "dragHandleTooltipText",
            "optional": true,
            "type": "string",
          },
          {
            "name": "resizeHandleAriaDescription",
            "optional": true,
            "type": "string",
          },
          {
            "name": "resizeHandleAriaLabel",
            "optional": false,
            "type": "string",
          },
          {
            "name": "resizeHandleTooltipText",
            "optional": true,
            "type": "string",
          },
        ],
        "type": "object",
      },
      "name": "i18nStrings",
      "optional": false,
      "type": "BoardItemProps.I18nStrings",
    },
  ],
  "regions": [
    {
      "description": "Main content of the item.",
      "isDefault": true,
      "name": "children",
    },
    {
      "description": "Footer of the item.",
      "isDefault": false,
      "name": "footer",
    },
    {
      "description": "Heading element of the item. Use the [header component](/components/header/).",
      "isDefault": false,
      "name": "header",
    },
    {
      "description": "Additional slot next to the heading. Use it to render an overflow actions menu in the form of a button dropdown.",
      "isDefault": false,
      "name": "settings",
    },
  ],
  "releaseStatus": "stable",
}
`;

exports[`definition for items-palette matches the snapshot > items-palette 1`] = `
{
  "dashCaseName": "items-palette",
  "events": [],
  "functions": [],
  "name": "ItemsPalette",
  "properties": [
    {
      "description": "An object containing all the necessary localized strings required by the component.

Live announcements:
* \`liveAnnouncementDndStarted\` (string) - live announcement string to indicate start of DnD.
* \`liveAnnouncementDndDiscarded\` (string) - live announcement string to indicate discard of DnD.",
      "inlineType": {
        "name": "ItemsPaletteProps.I18nStrings<D>",
        "properties": [
          {
            "name": "liveAnnouncementDndDiscarded",
            "optional": false,
            "type": "string",
          },
          {
            "name": "liveAnnouncementDndStarted",
            "optional": false,
            "type": "string",
          },
          {
            "name": "navigationAriaDescription",
            "optional": true,
            "type": "string",
          },
          {
            "name": "navigationAriaLabel",
            "optional": false,
            "type": "string",
          },
          {
            "name": "navigationItemAriaLabel",
            "optional": false,
            "type": "(item: ItemsPaletteProps.Item<D>) => string",
          },
        ],
        "type": "object",
      },
      "name": "i18nStrings",
      "optional": false,
      "type": "ItemsPaletteProps.I18nStrings<D>",
    },
    {
      "description": "Specifies the items displayed in the palette. The content of each item is controlled by the \`renderItem\` property.

The ItemsPaletteProps.Item includes:
* \`id\` (string) - the unique item identifier. The IDs of any two items in a page must be different.
* \`definition.minRowSpan\` (number, optional) - the minimal number of rows the item is allowed to take. It can't be less than two. Defaults to two.
* \`definition.minColumnSpan\` (number, optional) - the minimal number of columns the item is allowed to take (in a 4 column layout). It can't be less than one. Defaults to one.
* \`definition.defaultRowSpan\` (number) - the number or rows the item will take when inserted to the board. It can't be less than \`definition.minRowSpan\`.
* \`definition.defaultColumnSpan\` (number) - the number or columns the item will take (in a 4 column layout) when inserted to the board. It can't be less than \`definition.minColumnSpan\`.
* \`data\` (D) - optional item data which can include the specific configurations of an item, such as its title.",
      "name": "items",
      "optional": false,
      "type": "ReadonlyArray<ItemsPaletteProps.Item<D>>",
    },
    {
      "description": "Specifies a function to render content for a palette item. The return value must include board item component.

The function takes the item and its associated context (ItemsPaletteProps.ItemContext) that include:
* \`showPreview\` (boolean) - a flag that indicates if the item's content needs to be rendered in preview mode.",
      "inlineType": {
        "name": "(item: ItemsPaletteProps.Item<D>, context: ItemsPaletteProps.ItemContext) => JSX.Element",
        "parameters": [
          {
            "name": "item",
            "type": "ItemsPaletteProps.Item<D>",
          },
          {
            "name": "context",
            "type": "ItemsPaletteProps.ItemContext",
          },
        ],
        "returnType": "JSX.Element",
        "type": "function",
      },
      "name": "renderItem",
      "optional": false,
      "type": "(item: ItemsPaletteProps.Item<D>, context: ItemsPaletteProps.ItemContext) => JSX.Element",
    },
  ],
  "regions": [],
  "releaseStatus": "stable",
}
`;