Skip to content

Commit e4476cd

Browse files
rnuinoci[bot]rnuinoci[bot]
authored
wix-noci: update api.json (#3578)
Co-authored-by: rnuinoci[bot] <182611266+rnuinoci[bot]@users.noreply.github.com>
1 parent 1b88687 commit e4476cd

File tree

1 file changed

+275
-4
lines changed

1 file changed

+275
-4
lines changed

‎src/components/timeline/timeline.api.json‎

Lines changed: 275 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,20 @@
22
"name": "Timeline",
33
"category": "lists",
44
"description": "A timeline item to render as part of a timeline list",
5-
"extends": ["View"],
6-
"extendsLink": ["https://reactnative.dev/docs/view"],
5+
"extends": [
6+
"View"
7+
],
8+
"extendsLink": [
9+
"https://reactnative.dev/docs/view"
10+
],
711
"example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TimelineScreen.tsx",
812
"images": [],
913
"props": [
10-
{"name": "backgroundColor", "type": "string", "description": "Background color for the item"},
14+
{
15+
"name": "backgroundColor",
16+
"type": "string",
17+
"description": "Background color for the item"
18+
},
1119
{
1220
"name": "renderContent",
1321
"type": "any",
@@ -35,7 +43,9 @@
3543
"description": "The point props"
3644
},
3745
{
38-
"name": "testID", "type": "string", "description": "The test id for e2e tests"
46+
"name": "testID",
47+
"type": "string",
48+
"description": "The test id for e2e tests"
3949
}
4050
],
4151
"snippet": [
@@ -57,5 +67,266 @@
5767
" alignmentTargetRef: target",
5868
" }$5}",
5969
"/>"
70+
],
71+
"docs": {
72+
"hero": {
73+
"title": "Timeline",
74+
"description": "markdown:\nThe timeline displays a vertical list of events or steps. \nIt provides the user with a sense of awareness around the progress and the remaining steps.",
75+
"type": "hero",
76+
"layout": "horizontal",
77+
"content": [
78+
{
79+
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components%20Docs/Timeline/timeline_overview_cover.png"
80+
}
81+
]
82+
},
83+
"tabs": [
84+
{
85+
"title": "Overview",
86+
"sections": [
87+
{
88+
"type": "list",
89+
"items": [
90+
{
91+
"title": "Log Timeline",
92+
"description": "A log of past and future activities or events.
The list starts with an empty state, and it keeps on updating and changing.",
93+
"content": [
94+
{
95+
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components%20Docs/Timeline/timeline_overview_usageExamples1.png"
96+
}
97+
]
98+
},
99+
{
100+
"title": "Steps Timeline",
101+
"description": "A list of suggested steps to take to achieve a certain goal.
Users usually need to take action with these steps.
The steps are usually decided in advance, meaning that the initial state is not empty.",
102+
"content": [
103+
{
104+
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components%20Docs/Timeline/timeline_overview_usageExamples2.png"
105+
}
106+
]
107+
}
108+
],
109+
"title": "Usage Examples",
110+
"description": "The timeline displays a vertical list of events or steps. \nIt provides the user with a sense of awareness around the progress and the remaining steps.",
111+
"layout": "horizontal"
112+
},
113+
{
114+
"type": "section",
115+
"title": "Structure",
116+
"description": "markdown:\nThe Timeline consists of points and lines, each with different styles and states. These elements can be combined in various ways to suit different product goals. \nPoints create visual breakpoints that make your timeline easier to read, they act as bullet points, representing each step or activity. The icons and colors can be customized. \nLines can either match the state and color of the points or be styled differently or in neutral tokens to emphasize the points.",
117+
"layout": "horizontal",
118+
"content": [
119+
{
120+
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components%20Docs/Timeline/timeline_overview_structure.png"
121+
}
122+
]
123+
},
124+
{
125+
"type": "table",
126+
"columns": [
127+
"State",
128+
"Preview",
129+
"DELETE ME"
130+
],
131+
"items": [
132+
{
133+
"title": "Current",
134+
"content": [
135+
{
136+
"props": {
137+
"state": "current",
138+
"point": {
139+
"type": {
140+
"type": "bullet"
141+
}
142+
},
143+
"bottomLine": {
144+
"type": {
145+
"type": "solid"
146+
}
147+
}
148+
}
149+
},
150+
{
151+
"props": {
152+
"point": {
153+
"type": {
154+
"type": "bullet",
155+
"color": "#116DFF"
156+
}
157+
}
158+
}
159+
}
160+
]
161+
},
162+
{
163+
"title": "Next",
164+
"content": [
165+
{
166+
"props": {
167+
"state": "next",
168+
"point": {
169+
"type": {
170+
"type": "bullet"
171+
}
172+
},
173+
"bottomLine": {
174+
"type": {
175+
"type": "solid"
176+
}
177+
}
178+
}
179+
}
180+
]
181+
},
182+
{
183+
"title": "Error",
184+
"content": [
185+
{
186+
"props": {
187+
"state": "error",
188+
"point": {
189+
"type": {
190+
"type": "bullet"
191+
}
192+
},
193+
"bottomLine": {
194+
"type": {
195+
"type": "solid"
196+
}
197+
}
198+
}
199+
}
200+
]
201+
},
202+
{
203+
"title": "Success",
204+
"content": [
205+
{
206+
"props": {
207+
"state": "success",
208+
"point": {
209+
"type": {
210+
"type": "bullet"
211+
}
212+
},
213+
"bottomLine": {
214+
"type": {
215+
"type": "solid"
216+
}
217+
}
218+
}
219+
}
220+
]
221+
}
222+
],
223+
"title": "States",
224+
"name": ""
225+
},
226+
{
227+
"type": "table",
228+
"columns": [
229+
"Style",
230+
"Preview"
231+
],
232+
"items": [
233+
{
234+
"title": "Bullet"
235+
},
236+
{
237+
"title": "New Item"
238+
},
239+
{
240+
"title": "New Item"
241+
},
242+
{
243+
"title": "New Item"
244+
},
245+
{
246+
"title": "New Item"
247+
}
248+
],
249+
"title": "Styles",
250+
"name": "Point"
251+
},
252+
{
253+
"type": "table",
254+
"columns": [
255+
"Style",
256+
"Preview"
257+
],
258+
"items": [
259+
{
260+
"title": "Solid",
261+
"content": [
262+
{
263+
"props": {
264+
"state": "current",
265+
"bottomLine": {
266+
"type": {
267+
"type": "solid"
268+
}
269+
}
270+
}
271+
}
272+
]
273+
},
274+
{
275+
"title": "Dashed",
276+
"content": [
277+
{
278+
"props": {
279+
"state": "current",
280+
"bottomLine": {
281+
"type": {
282+
"type": "dashed"
283+
}
284+
}
285+
}
286+
}
287+
]
288+
}
289+
],
290+
"name": "Line"
291+
},
292+
{
293+
"type": "section",
294+
"title": "Orientation",
295+
"description": "markdown:\nThe Timeline can be displayed in either ascending or descending order, depending on the context: \n\n - **Ascending:** Numbers increase as you move forward. \n - **Descending:** Numbers decrease as you move forward.",
296+
"content": [
297+
{
298+
"value": "https://embed.figma.com/design/xFjvYNkGTmYTGYMLrmz9Ir/Guidelines-to-Docs?node-id=2325-449060&embed-host=share"
299+
}
300+
]
301+
},
302+
{
303+
"type": "list",
304+
"items": [
305+
{
306+
"title": "Aligned to top",
307+
"description": "The Timeline can be configured to align its points with the top of a specific group of elements on the right. In the example, the points are aligned with the top of the first element within the Card.",
308+
"content": [
309+
{
310+
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components%20Docs/Timeline/timeline_overview_spec1.png"
311+
}
312+
]
313+
},
314+
{
315+
"title": "Aligned to center",
316+
"description": "The timeline points are aligned with the center of the element on the right.",
317+
"content": [
318+
{
319+
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components%20Docs/Timeline/timeline_overview_spec2.png"
320+
}
321+
]
322+
}
323+
],
324+
"layout": "horizontal",
325+
"title": "Spec",
326+
"description": "markdown:\n**Key rules:** \n- Maintain a minimum distance of S2 between the Timeline and the elements on the right. \n- Points can be aligned either to the top or the center of the elements on the right. \n- When points are center-aligned with the elements, set the line length to auto, with a minimum of 20px."
327+
}
328+
]
329+
}
60330
]
331+
}
61332
}

0 commit comments

Comments
 (0)