react-native-sdk/src/inbox/types/IterableInboxCustomizations.ts at 464a845cab67f73645bbb6be565876270d2157d6 · Iterable/react-native-sdk · 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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
/**
 * Interface representing customizations for the Iterable Inbox.
 */
export interface IterableInboxCustomizations {
  /**
   * The title that appears at the top of the inbox screen.
   */
  navTitle?: string;

  /**
   * The title that appears in the middle of the screen when the inbox contains
   * no messages.
   *
   * @defaultValue "No saved messages".
   */
  noMessagesTitle?: string;

  /**
   * The body text that appears in the middle of the screen when the inbox
   * contains no messages.
   *
   * @defaultValue "Check again later!"
   */
  noMessagesBody?: string;

  /**
   * The container that holds the unread indicator.
   */
  unreadIndicatorContainer?: {
    /** The flex direction of the container.  */
    flexDirection?: string;

    /** The justification of the container's content. */
    justifyContent?: string;
  };

  /**
   * Customizations for the unread indicator icon.
   */
  unreadIndicator?: {
    /** The width of the unread indicator. */
    width?: number;

    /** The height of the unread indicator. */
    height?: number;

    /** The border radius of the unread indicator. */
    borderRadius?: number;

    /** The background color of the unread indicator. */
    backgroundColor?: string;

    /** The left margin of the unread indicator. */
    marginLeft?: number;

    /** The right margin of the unread indicator. */
    marginRight?: number;

    /** The top margin of the unread indicator. */
    marginTop?: number;
  };

  /**
   * For an unread message, this is the container for the thumbnail image
   * associated with the message (as configured when setting up the template in
   * Iterable).
   */
  unreadMessageThumbnailContainer?: {
    /** The left padding of the container. */
    paddingLeft?: number;

    /** The flex direction of the container. */
    flexDirection?: string;

    /** The justification of the container's content. */
    justifyContent?: string;
  };

  /**
   * For a read message, this is the container for the thumbnail image
   * associated with the message (as configured when setting up the template in
   * Iterable).
   */
  readMessageThumbnailContainer?: {
    /** The left padding of the container. */
    paddingLeft?: number;

    /** The flex direction of the container. */
    flexDirection?: string;

    /** The justification of the container's content. */
    justifyContent?: string;
  };

  /**
   * A container around various elements in the message item: title, body, and
   * created at.
   */
  messageContainer?: {
    /** The left padding of the container. */
    paddingLeft?: number;

    /** The width of the container. */
    width?: string;

    /** The flex direction of the container. */
    flexDirection?: string;

    /** The justification of the container's content. */
    justifyContent?: string;
  };

  /**
   * The title of the message, as displayed in the inbox.
   */
  title?: {
    /** The font size of the title. */
    fontSize?: number;

    /** The bottom padding of the title. */
    paddingBottom?: number;
  };

  /**
   * The body of the message, as displayed in the inbox (not when the message
   * has been opened).
   */
  body?: {
    /** The font size of the body text. */
    fontSize?: number;

    /** The color of the body text. */
    color?: string;

    /** The width of the body text. */
    width?: string;

    /** The flex wrap property of the body text. */
    flexWrap?: string;

    /** The bottom padding of the body text. */
    paddingBottom?: number;
  };

  /**
   * The message date.
   */
  createdAt?: {
    /** The font size of the creation date text. */
    fontSize?: number;

    /** The color of the creation date text. */
    color?: string;
  };

  /**
   * A message row.
   *
   * Use these styles to customize row height, padding, background color,
   * border, etc.
   */
  messageRow?: {
    /** The flex direction of the message row. */
    flexDirection?: string;

    /** The background color of the message row. */
    backgroundColor?: string;

    /** The top padding of the message row. */
    paddingTop?: number;

    /** The bottom padding of the message row. */
    paddingBottom?: number;

    /** The height of the message row. */
    height?: number;

    /** The border style of the message row. */
    borderStyle?: string;

    /** The border color of the message row. */
    borderColor?: string;

    /** The top border width of the message row. */
    borderTopWidth?: number;
  };
}