emdash-fields/src/types.ts at 50d1e4be26b3253a093094a0d52ce97dc1161dba · bnomei/emdash-fields · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
import type { ReactNode } from "react";

export type FieldsSubFieldType =
  | "text"
  | "textarea"
  | "number"
  | "integer"
  | "boolean"
  | "select"
  | "url";

export type FieldsChoice = {
  value: string;
  label?: string;
  description?: string;
  icon?: ReactNode;
};

export type FieldsSubField = {
  key: string;
  label: string;
  type?: FieldsSubFieldType;
  required?: boolean;
  placeholder?: string;
  suffix?: string;
  options?: FieldsChoice[] | string[];
};

export type ObjectOptions = {
  fields: FieldsSubField[];
  helpText?: string;
};

export type StructureOptions = {
  fields: FieldsSubField[];
  itemLabel?: string;
  min?: number;
  max?: number;
  sortable?: boolean;
  summary?: string;
  helpText?: string;
};

/** @deprecated Use FieldsSubFieldType. */
export type FieldKitSubFieldType = FieldsSubFieldType;

/** @deprecated Use FieldsChoice. */
export type FieldKitChoice = FieldsChoice;

/** @deprecated Use FieldsSubField. */
export type FieldKitSubField = FieldsSubField;

/** @deprecated Use ObjectOptions. */
export type ObjectFormOptions = ObjectOptions;

/** @deprecated Use StructureOptions. */
export type ListOptions = StructureOptions;

export type LinkValue = {
  type?: "url" | "email" | "tel" | "entry" | "media";
  value?: string;
  text?: string;
  target?: "_blank" | "_self";
};

export type ChoicesOptions = {
  choices?: FieldsChoice[] | string[];
  options?: FieldsChoice[] | string[];
  multiple?: boolean;
  orientation?: "vertical" | "horizontal";
  columns?: number;
  helpText?: string;
};