Skip to content

Commit f5af3f1

Browse files
Inbal-Tishethanshar
Inbal-Tish
and
ethanshar
authored
Docs - Timeline - fix live components (#3611)
* Timeline - fix live components * bump version --------- Co-authored-by: Ethan Sharabi <[email protected]>
1 parent 9ac7e43 commit f5af3f1

File tree

2 files changed

+56
-105
lines changed

2 files changed

+56
-105
lines changed

‎docuilib/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "uilib-docs",
3-
"version": "3.8.0",
3+
"version": "3.9.0",
44
"main": "./src/index.ts",
55
"scripts": {
66
"docusaurus": "docusaurus",

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

Lines changed: 55 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -29,30 +29,18 @@
2929
}
3030
],
3131
"snippet": [
32-
"<Timeline ",
33-
" topLine={{",
34-
" state: Timeline.states.ERROR",
35-
" }$1}",
36-
" bottomLine={{",
37-
" type: Timeline.lineTypes.DASHED,",
38-
" color: Colors.orange40",
39-
" }$2}",
40-
" point={{",
41-
" type: Timeline.pointTypes.OUTLINE,",
42-
" color: Colors.orange40,",
43-
" icon: Assets.icons.demo.camera,",
44-
" anchorRef: alignToTitle ? titleRef : undefined",
45-
" }$3}",
32+
"<Timeline",
33+
" topLine={{type: Timeline.lineTypes.DASHED}}",
34+
" bottomLine={{state: Timeline.states.SUCCESS}}",
35+
" point={{state: Timeline.states.SUCCESS}}",
4636
">",
47-
" <View flex centerH paddingH-20>",
48-
" <Text text70 dark10 ref={titleRef}>",
49-
" {title}",
50-
" </Text>",
51-
" <Text dark40>",
52-
" {description}",
53-
" </Text>",
54-
" </View>",
55-
"</Timeline>"
37+
" <View padding-20 bg-grey60 br30>",
38+
" <Text text70BO>Title</Text>",
39+
" <View marginT-5 padding-8 bg-white br30>",
40+
" <Text>Description</Text>",
41+
" </View>",
42+
" </View>",
43+
" </Timeline>"
5644
],
5745
"docs": {
5846
"hero": {
@@ -138,29 +126,7 @@
138126
"title": "Current",
139127
"content": [
140128
{
141-
"props": {
142-
"state": "current",
143-
"point": {
144-
"type": {
145-
"type": "bullet"
146-
}
147-
},
148-
"bottomLine": {
149-
"type": {
150-
"type": "solid"
151-
}
152-
}
153-
}
154-
},
155-
{
156-
"props": {
157-
"point": {
158-
"type": {
159-
"type": "bullet",
160-
"color": "#116DFF"
161-
}
162-
}
163-
}
129+
"snippet": "<Timeline topLine={{state: Timeline.states.CURRENT}} bottomLine={{state: Timeline.states.CURRENT}} point={{state: Timeline.states.CURRENT}}><View style={{height: 88}}/></Timeline>"
164130
}
165131
],
166132
"description": "state: current"
@@ -169,19 +135,7 @@
169135
"title": "Next",
170136
"content": [
171137
{
172-
"props": {
173-
"state": "next",
174-
"point": {
175-
"type": {
176-
"type": "bullet"
177-
}
178-
},
179-
"bottomLine": {
180-
"type": {
181-
"type": "solid"
182-
}
183-
}
184-
}
138+
"snippet": "<Timeline topLine={{state: Timeline.states.NEXT}} bottomLine={{state: Timeline.states.NEXT}} point={{state: Timeline.states.NEXT, type: Timeline.pointTypes.CIRCLE}}><View style={{height: 88}}/></Timeline>"
185139
}
186140
],
187141
"description": "state: next"
@@ -190,19 +144,7 @@
190144
"title": "Error",
191145
"content": [
192146
{
193-
"props": {
194-
"state": "error",
195-
"point": {
196-
"type": {
197-
"type": "bullet"
198-
}
199-
},
200-
"bottomLine": {
201-
"type": {
202-
"type": "solid"
203-
}
204-
}
205-
}
147+
"snippet": "<Timeline topLine={{state: Timeline.states.ERROR}} bottomLine={{state: Timeline.states.ERROR}} point={{state: Timeline.states.ERROR}}><View style={{height: 88}}/></Timeline>"
206148
}
207149
],
208150
"description": "state: error"
@@ -211,19 +153,7 @@
211153
"title": "Success",
212154
"content": [
213155
{
214-
"props": {
215-
"state": "success",
216-
"point": {
217-
"type": {
218-
"type": "bullet"
219-
}
220-
},
221-
"bottomLine": {
222-
"type": {
223-
"type": "solid"
224-
}
225-
}
226-
}
156+
"snippet": "<Timeline topLine={{state: Timeline.states.SUCCESS}} bottomLine={{state: Timeline.states.SUCCESS}} point={{state: Timeline.states.SUCCESS}}><View style={{height: 88}}/></Timeline>"
227157
}
228158
],
229159
"description": "state: success"
@@ -238,15 +168,30 @@
238168
"items": [
239169
{
240170
"title": "Bullet",
241-
"description": "type: bullet"
171+
"description": "type: bullet",
172+
"content": [
173+
{
174+
"snippet": "<Timeline point={{type: Timeline.pointTypes.BULLET}}><View style={{height: 88}}/></Timeline>"
175+
}
176+
]
242177
},
243178
{
244179
"title": "Circle",
245-
"description": "type: circle"
180+
"description": "type: circle",
181+
"content": [
182+
{
183+
"snippet": "<Timeline point={{state: Timeline.states.NEXT, type: Timeline.pointTypes.CIRCLE}}><View style={{height: 88}}/></Timeline>"
184+
}
185+
]
246186
},
247187
{
248188
"title": "Outline",
249-
"description": "type: outline"
189+
"description": "type: outline",
190+
"content": [
191+
{
192+
"snippet": "<Timeline point={{type: Timeline.pointTypes.OUTLINE}}><View style={{height: 88}}/></Timeline>"
193+
}
194+
]
250195
}
251196
],
252197
"title": "Point",
@@ -260,14 +205,7 @@
260205
"title": "Text",
261206
"content": [
262207
{
263-
"props": {
264-
"state": "current",
265-
"bottomLine": {
266-
"type": {
267-
"type": "solid"
268-
}
269-
}
270-
}
208+
"snippet": "<Timeline point={{label: '1'}}><View style={{height: 88}}/></Timeline>"
271209
}
272210
],
273211
"description": "text: “1”"
@@ -276,20 +214,18 @@
276214
"title": "Icon",
277215
"content": [
278216
{
279-
"props": {
280-
"state": "current",
281-
"bottomLine": {
282-
"type": {
283-
"type": "dashed"
284-
}
285-
}
286-
}
217+
"snippet": "<Timeline point={{state: Timeline.states.SUCCESS, icon: Assets.icons.checkSmall}}><View style={{height: 88}}/></Timeline>"
287218
}
288219
],
289220
"description": "icon: Assets.icons.general.checkmarkSmall"
290221
},
291222
{
292223
"title": "Icon without background",
224+
"content": [
225+
{
226+
"snippet": "<Timeline point={{state: Timeline.states.SUCCESS, icon: Assets.icons.search, removeIconBackground: true}}><View style={{height: 88}}/></Timeline>"
227+
}
228+
],
293229
"description": "icon: Assets.icons.general.favorite, removeIconBackground: true"
294230
}
295231
],
@@ -301,10 +237,20 @@
301237
"items": [
302238
{
303239
"title": "Solid",
240+
"content": [
241+
{
242+
"snippet": "<Timeline topLine={{state: Timeline.states.CURRENT}} point={{removeIconBackground: true}}><View style={{height: 88}}/></Timeline>"
243+
}
244+
],
304245
"description": "type: solid"
305246
},
306247
{
307248
"title": "Dashed",
249+
"content": [
250+
{
251+
"snippet": "<Timeline topLine={{state: Timeline.states.CURRENT, type: Timeline.lineTypes.DASHED}} point={{removeIconBackground: true}}><View style={{height: 88}}/></Timeline>"
252+
}
253+
],
308254
"description": "type: dashed"
309255
}
310256
],
@@ -317,6 +263,11 @@
317263
"items": [
318264
{
319265
"title": "Entry",
266+
"content": [
267+
{
268+
"snippet": "<Timeline topLine={{state: Timeline.states.NEXT, entry: true}} bottomLine={{state: Timeline.states.NEXT, entry: true}} point={{removeIconBackground: true}}><View style={{height: 88}}/></Timeline>"
269+
}
270+
],
320271
"description": "entry: true"
321272
}
322273
],

0 commit comments

Comments
 (0)