Class List

constructor

• new List(
      model: Omit<
          OmitNodeName<ListSchema.List>,
          "filter" | "updateDetailOnly",
      > & {
          actions?: Action.ActionPanel;
          defaultAction?: string;
          detail?: List.ItemDetail;
          filter?: "default" | "none";
          inherits?: (
              | "filter"
              | "items"
              | "sections"
              | "defaultAction"
              | "actions"
              | "detail"
          )[];
          items?: List.Item[];
          sections?: List.Section[];
      },
  ): List.List
• • updateDetailOnly: If true, the list view inherits previous list view items and only updates the detail view. This is useful when you want to update the detail view without changing the list view items. For example, when user goes over item by item, you can update the detail view without resending the items data. This could be more efficient when there are many items.

  Parameters

  • model: Omit<OmitNodeName<ListSchema.List>, "filter" | "updateDetailOnly"> & {
        actions?: Action.ActionPanel;
        defaultAction?: string;
        detail?: List.ItemDetail;
        filter?: "default" | "none";
        inherits?: (
            | "filter"
            | "items"
            | "sections"
            | "defaultAction"
            | "actions"
            | "detail"
        )[];
        items?: List.Item[];
        sections?: List.Section[];
    }

  Returns List.List

Optionalactions

OptionaldefaultAction

Optionaldetail

filter

Optionalinherits

Optionalitems

nodeName

Optionalsections

toModel

• toModel(): ListSchema.List

• Returns ListSchema.List