Skip to content

Commit 5c14737

Browse files
committed
titles on code blocks
1 parent ddfe64d commit 5c14737

File tree

1 file changed

+22
-65
lines changed

1 file changed

+22
-65
lines changed

fern/docs/pages/references/snapkit.mdx

Lines changed: 22 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@ The `snap_kit_body` field has the following properties:
1010
- `snap_in_action_name`: The name of the action this snap-kit represents.
1111
- `body`: An object that holds the actual snap-kit content in the form of `snaps`.
1212

13-
Example
14-
15-
```json
13+
```json Example
1614
{
1715
"object": "<source_id>",
1816
"body": "Giphy",
@@ -54,9 +52,9 @@ Snap-kit generates payloads when a user interacts with an actionable snap. The p
5452
- [Tag picker](#tag-picker)
5553
- [User picker](#user-picker)
5654

57-
All actionable snaps share the same base payload structure. The base payload has the following structure:
55+
All actionable snaps share the same base payload structure.
5856

59-
```json
57+
```json Base payload structure
6058
{
6159
"type": "<type of snap that generated the payload>",
6260
"action_id": "<the action identifier of the snap that generated the payload>",
@@ -255,9 +253,7 @@ Many elements share the same base properties. The base types these elements inhe
255253
}
256254
```
257255

258-
_Example payload_
259-
260-
```json
256+
```json Example payload
261257
{
262258
"action_id": "PRIMARY",
263259
"action_type": "remote",
@@ -739,9 +735,7 @@ _Example_
739735
}
740736
```
741737

742-
_Example payload_
743-
744-
```json
738+
```json Example payload
745739
{
746740
"action_id": "checkboxes",
747741
"action_type": "remote",
@@ -820,7 +814,6 @@ _Example_
820814

821815
![plain_text_input](../../img/plain-text-input.png)
822816

823-
824817
```json
825818
{
826819
"element": {
@@ -859,9 +852,7 @@ _Example_
859852
}
860853
```
861854

862-
_Example payload_
863-
864-
```json
855+
```json Example payload
865856
{
866857
"type": "plain_text_input",
867858
"action_id": "name",
@@ -921,9 +912,7 @@ _Example_
921912
}
922913
```
923914

924-
_Example payload_
925-
926-
```json
915+
```json Example payload
927916
{
928917
"type": "number_input",
929918
"action_id": "age",
@@ -987,9 +976,7 @@ _Example_
987976
}
988977
```
989978

990-
_Example payload_
991-
992-
```json
979+
```json Example payload
993980
{
994981
"type": "email_text_input",
995982
"action_id": "email",
@@ -1060,9 +1047,7 @@ _Example_
10601047
}
10611048
```
10621049

1063-
_Example payload_
1064-
1065-
```json
1050+
```json Example payload
10661051
{
10671052
"type": "rich_text_input",
10681053
"action_id": "notes",
@@ -1212,11 +1197,7 @@ _Example_
12121197
}
12131198
```
12141199

1215-
_Example payload_
1216-
1217-
Standard string list input.
1218-
1219-
```json
1200+
```json Example payload: Standard string list input
12201201
{
12211202
"type": "string_list",
12221203
"action_id": "keywords",
@@ -1226,9 +1207,7 @@ _Example_
12261207
}
12271208
```
12281209

1229-
Multiline string list input.
1230-
1231-
```json
1210+
```json Example payload: Multiline string list input.
12321211
{
12331212
"type": "string_list",
12341213
"action_id": "multiline",
@@ -1301,9 +1280,7 @@ _Example_
13011280
}
13021281
```
13031282

1304-
_Example payload_
1305-
1306-
```json
1283+
```json Example payload
13071284
{
13081285
"type": "number_list",
13091286
"action_id": "numbers",
@@ -1369,9 +1346,7 @@ _Example_
13691346
}
13701347
```
13711348

1372-
_Example payload_
1373-
1374-
```json
1349+
```json Example payload
13751350
{
13761351
"type": "email_list",
13771352
"action_id": "emails",
@@ -1478,9 +1453,7 @@ _Example_
14781453
}
14791454
```
14801455

1481-
_Example payload_
1482-
1483-
```json
1456+
```json Example payload
14841457
{
14851458
"action_id": "static_select",
14861459
"action_type": "remote",
@@ -1594,9 +1567,7 @@ _Example_
15941567
}
15951568
```
15961569

1597-
_Example payload_
1598-
1599-
```json
1570+
```json Example payload
16001571
{
16011572
"action_id": "multi_static_select",
16021573
"action_type": "remote",
@@ -1695,9 +1666,7 @@ _Example_
16951666
}
16961667
```
16971668

1698-
_Example payload_
1699-
1700-
```json
1669+
```json Example payload
17011670
{
17021671
"action_id": "in-app",
17031672
"action_type": "remote",
@@ -1796,9 +1765,7 @@ _Example_
17961765
}
17971766
```
17981767

1799-
_Example payload_
1800-
1801-
```json
1768+
```json Example payload
18021769
{
18031770
"action_id": "toggle",
18041771
"action_type": "remote",
@@ -1891,9 +1858,7 @@ _Example_
18911858
}
18921859
```
18931860

1894-
_Example payload_
1895-
1896-
```json
1861+
```json Example payload
18971862
{
18981863
"action_id": "upload",
18991864
"action_type": "remote",
@@ -2421,9 +2386,7 @@ Inherits `type`, `action_id`, `action_type` and `timestamp` from [Base payload](
24212386
}
24222387
```
24232388

2424-
_Example payload_
2425-
2426-
```json
2389+
```json Example payload
24272390
{
24282391
"action_id": "user_form",
24292392
"action_type": "remote",
@@ -2664,9 +2627,7 @@ Inherits `type`, `action_id`, `action_type`, and `timestamp` from [Base payload]
26642627
}
26652628
```
26662629

2667-
_Example payload_
2668-
2669-
```json
2630+
```json Example payload
26702631
{
26712632
"action_id": "part_picker",
26722633
"action_type": "remote",
@@ -2749,9 +2710,7 @@ Inherits `type`, `action_id`, `action_type`, and `timestamp` from [Base payload]
27492710
}
27502711
```
27512712

2752-
_Example payload_
2753-
2754-
```json
2713+
```json Example payload
27552714
{
27562715
"action_id": "tag_picker",
27572716
"action_type": "remote",
@@ -2835,9 +2794,7 @@ Inherits `type`, `action_id`, `action_type`, and `timestamp` from [Base payload]
28352794
}
28362795
```
28372796

2838-
_Example payload_
2839-
2840-
```json
2797+
```json Example payload
28412798
{
28422799
"action_id": "user_picker",
28432800
"action_type": "remote",

0 commit comments

Comments
 (0)