@prismicio/client/dist/types/value/table.d.cts

The official JavaScript + TypeScript client library for Prismic

import { RichTextField } from "./richText.cjs";
import { FieldState } from "./types.cjs";

//#region src/types/value/table.d.ts

/**
 * A table field.
 *
 * @typeParam State - State of the field which determines its shape.
 *
 * @see More details: {@link https://prismic.io/docs/table}
 */
type TableField<State extends FieldState = FieldState> = State extends "empty" ? null : {
  /**
   * The head of the table.
   */
  head?: TableFieldHead;
  /**
   * The body of the table.
   */
  body: TableFieldBody;
};
/**
 * Represents a table head.
 */
type TableFieldHead = {
  rows: TableFieldHeadRow[];
};
/**
 * Represents a table body.
 */
type TableFieldBody = {
  rows: TableFieldBodyRow[];
};
/**
 * Represents a row in a table head.
 */
type TableFieldHeadRow = {
  /**
   * Unique key of the row.
   */
  key: string;
  /**
   * Cells in the row.
   */
  cells: TableFieldHeaderCell[];
};
/**
 * Represents a table header cell.
 */
type TableFieldHeaderCell = {
  /**
   * Unique key of the cell.
   */
  key: string;
  /**
   * The type of the cell.
   */
  type: "header";
  /**
   * The content of the cell.
   */
  content: RichTextField;
};
/**
 * Represents a row in a table body.
 */
type TableFieldBodyRow = {
  /**
   * Unique key of the row.
   */
  key: string;
  /**
   * Cells in the row.
   */
  cells: (TableFieldHeaderCell | TableFieldDataCell)[];
};
/**
 * Represents a table data cell.
 */
type TableFieldDataCell = {
  /**
   * Unique key of the cell.
   */
  key: string;
  /**
   * The type of the cell.
   */
  type: "data";
  /**
   * The content of the cell.
   */
  content: RichTextField;
};
//#endregion
export { TableField, TableFieldBody, TableFieldBodyRow, TableFieldDataCell, TableFieldHead, TableFieldHeadRow, TableFieldHeaderCell };
//# sourceMappingURL=table.d.cts.map