@sakaniui/react 0.8.8 → 0.8.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +8 -2
- package/CHANGELOG.md +64 -0
- package/README.md +36 -9
- package/bin/sakaniui-mcp.mjs +399 -27
- package/dist/icon-index.json +1 -0
- package/dist/lib/ChartTooltip.d.ts +20 -0
- package/dist/lib/LiquidGlass.d.ts +93 -0
- package/dist/lib/SakaniLogo.d.ts +3 -0
- package/dist/lib/chartPalette.d.ts +12 -0
- package/dist/lib/getContrastColor.d.ts +23 -0
- package/dist/lib/iconStrokeWidth.d.ts +13 -0
- package/dist/lib/useChartTokens.d.ts +31 -0
- package/dist/lib/useHoverHighlight.d.ts +17 -0
- package/dist/lib/usePortalThemeClass.d.ts +31 -0
- package/dist/lib/useThemeTick.d.ts +10 -0
- package/dist/manifest.json +542 -193
- package/package.json +6 -5
package/dist/manifest.json
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
{
|
|
2
|
-
"
|
|
3
|
-
"schemaVersion": 2,
|
|
2
|
+
"schemaVersion": 4,
|
|
4
3
|
"name": "@sakaniui/react",
|
|
5
|
-
"version": "0.8.
|
|
4
|
+
"version": "0.8.10",
|
|
6
5
|
"description": "Machine-readable contract of the SakaniUI React library, generated from its TypeScript source.",
|
|
7
6
|
"docs": "https://www.sakaniui.com",
|
|
8
7
|
"guide": "https://www.sakaniui.com/llms-full.txt",
|
|
@@ -24,13 +23,175 @@
|
|
|
24
23
|
"@sakaniui/react/icons": "Tabler icons: IconName and IconNameFilled, one module each (5184 outline, 1054 filled)."
|
|
25
24
|
},
|
|
26
25
|
"conventions": {
|
|
27
|
-
"version": "This manifest describes @sakaniui/react@0.8.
|
|
26
|
+
"version": "This manifest describes @sakaniui/react@0.8.10. Each component has `since`, the first release that contained it; a prop added later has its own `since`, and a value added later is listed in the prop's `valuesSince`. If the project has an older version installed, anything newer than that does not exist there.",
|
|
28
27
|
"acceptsNativeProps": "Components forward native HTML attributes (className, style, aria-*, event handlers) to their root element unless a prop says otherwise; only the props that are specific to SakaniUI are listed here.",
|
|
29
28
|
"accessibleName": "When `contract.requiresAccessibleName` is true, a required prop (aria-label, aria-labelledby or an alt text) is the only thing that names the control or image. Do not omit it.",
|
|
30
29
|
"tokens": "Use only the token names listed under `tokens`. Colour tokens follow the theme (the `.dark` class flips them); do not hard-code colours.",
|
|
31
|
-
"icons": "Icon props take the component itself (IconSettings), not an element (<IconSettings />).",
|
|
30
|
+
"icons": "Icon props take the component itself (IconSettings), not an element (<IconSettings />). Only names in icon-index.json exist; search them (MCP: search_icons) instead of guessing.",
|
|
31
|
+
"examples": "Each component has `example`: its imports and the element with every required prop filled in, type-checked against this build. Start from it.",
|
|
32
32
|
"literals": "Prop `values` keep their real type: a number is a number (columns: 2), a string is a string (\"md\")."
|
|
33
33
|
},
|
|
34
|
+
"nativeAttributes": [
|
|
35
|
+
"about",
|
|
36
|
+
"accept",
|
|
37
|
+
"acceptCharset",
|
|
38
|
+
"accessKey",
|
|
39
|
+
"action",
|
|
40
|
+
"allowFullScreen",
|
|
41
|
+
"allowTransparency",
|
|
42
|
+
"alt",
|
|
43
|
+
"as",
|
|
44
|
+
"async",
|
|
45
|
+
"autoCapitalize",
|
|
46
|
+
"autoComplete",
|
|
47
|
+
"autoCorrect",
|
|
48
|
+
"autoFocus",
|
|
49
|
+
"autoPlay",
|
|
50
|
+
"autoSave",
|
|
51
|
+
"capture",
|
|
52
|
+
"cellPadding",
|
|
53
|
+
"cellSpacing",
|
|
54
|
+
"challenge",
|
|
55
|
+
"charSet",
|
|
56
|
+
"checked",
|
|
57
|
+
"children",
|
|
58
|
+
"cite",
|
|
59
|
+
"classID",
|
|
60
|
+
"className",
|
|
61
|
+
"colSpan",
|
|
62
|
+
"color",
|
|
63
|
+
"cols",
|
|
64
|
+
"content",
|
|
65
|
+
"contentEditable",
|
|
66
|
+
"contextMenu",
|
|
67
|
+
"controls",
|
|
68
|
+
"coords",
|
|
69
|
+
"crossOrigin",
|
|
70
|
+
"dangerouslySetInnerHTML",
|
|
71
|
+
"data",
|
|
72
|
+
"datatype",
|
|
73
|
+
"dateTime",
|
|
74
|
+
"default",
|
|
75
|
+
"defaultChecked",
|
|
76
|
+
"defaultValue",
|
|
77
|
+
"defer",
|
|
78
|
+
"dir",
|
|
79
|
+
"disabled",
|
|
80
|
+
"download",
|
|
81
|
+
"draggable",
|
|
82
|
+
"encType",
|
|
83
|
+
"enterKeyHint",
|
|
84
|
+
"exportparts",
|
|
85
|
+
"form",
|
|
86
|
+
"formAction",
|
|
87
|
+
"formEncType",
|
|
88
|
+
"formMethod",
|
|
89
|
+
"formNoValidate",
|
|
90
|
+
"formTarget",
|
|
91
|
+
"frameBorder",
|
|
92
|
+
"headers",
|
|
93
|
+
"height",
|
|
94
|
+
"hidden",
|
|
95
|
+
"high",
|
|
96
|
+
"href",
|
|
97
|
+
"hrefLang",
|
|
98
|
+
"htmlFor",
|
|
99
|
+
"httpEquiv",
|
|
100
|
+
"id",
|
|
101
|
+
"inert",
|
|
102
|
+
"inlist",
|
|
103
|
+
"inputMode",
|
|
104
|
+
"integrity",
|
|
105
|
+
"is",
|
|
106
|
+
"itemID",
|
|
107
|
+
"itemProp",
|
|
108
|
+
"itemRef",
|
|
109
|
+
"itemScope",
|
|
110
|
+
"itemType",
|
|
111
|
+
"keyParams",
|
|
112
|
+
"keyType",
|
|
113
|
+
"kind",
|
|
114
|
+
"label",
|
|
115
|
+
"lang",
|
|
116
|
+
"list",
|
|
117
|
+
"loop",
|
|
118
|
+
"low",
|
|
119
|
+
"manifest",
|
|
120
|
+
"marginHeight",
|
|
121
|
+
"marginWidth",
|
|
122
|
+
"max",
|
|
123
|
+
"maxLength",
|
|
124
|
+
"media",
|
|
125
|
+
"mediaGroup",
|
|
126
|
+
"method",
|
|
127
|
+
"min",
|
|
128
|
+
"minLength",
|
|
129
|
+
"multiple",
|
|
130
|
+
"muted",
|
|
131
|
+
"name",
|
|
132
|
+
"noValidate",
|
|
133
|
+
"nonce",
|
|
134
|
+
"open",
|
|
135
|
+
"optimum",
|
|
136
|
+
"part",
|
|
137
|
+
"pattern",
|
|
138
|
+
"placeholder",
|
|
139
|
+
"playsInline",
|
|
140
|
+
"popover",
|
|
141
|
+
"popoverTarget",
|
|
142
|
+
"popoverTargetAction",
|
|
143
|
+
"poster",
|
|
144
|
+
"prefix",
|
|
145
|
+
"preload",
|
|
146
|
+
"property",
|
|
147
|
+
"radioGroup",
|
|
148
|
+
"readOnly",
|
|
149
|
+
"rel",
|
|
150
|
+
"required",
|
|
151
|
+
"resource",
|
|
152
|
+
"results",
|
|
153
|
+
"rev",
|
|
154
|
+
"reversed",
|
|
155
|
+
"role",
|
|
156
|
+
"rowSpan",
|
|
157
|
+
"rows",
|
|
158
|
+
"sandbox",
|
|
159
|
+
"scope",
|
|
160
|
+
"scoped",
|
|
161
|
+
"scrolling",
|
|
162
|
+
"seamless",
|
|
163
|
+
"security",
|
|
164
|
+
"selected",
|
|
165
|
+
"shape",
|
|
166
|
+
"size",
|
|
167
|
+
"sizes",
|
|
168
|
+
"slot",
|
|
169
|
+
"span",
|
|
170
|
+
"spellCheck",
|
|
171
|
+
"src",
|
|
172
|
+
"srcDoc",
|
|
173
|
+
"srcLang",
|
|
174
|
+
"srcSet",
|
|
175
|
+
"start",
|
|
176
|
+
"step",
|
|
177
|
+
"style",
|
|
178
|
+
"summary",
|
|
179
|
+
"suppressContentEditableWarning",
|
|
180
|
+
"suppressHydrationWarning",
|
|
181
|
+
"tabIndex",
|
|
182
|
+
"target",
|
|
183
|
+
"title",
|
|
184
|
+
"translate",
|
|
185
|
+
"type",
|
|
186
|
+
"typeof",
|
|
187
|
+
"unselectable",
|
|
188
|
+
"useMap",
|
|
189
|
+
"value",
|
|
190
|
+
"vocab",
|
|
191
|
+
"width",
|
|
192
|
+
"wmode",
|
|
193
|
+
"wrap"
|
|
194
|
+
],
|
|
34
195
|
"tokens": {
|
|
35
196
|
"count": 231,
|
|
36
197
|
"groups": {
|
|
@@ -318,7 +479,8 @@
|
|
|
318
479
|
"requiredProps": [],
|
|
319
480
|
"requiresAccessibleName": false
|
|
320
481
|
},
|
|
321
|
-
"since": "0.1.0"
|
|
482
|
+
"since": "0.1.0",
|
|
483
|
+
"example": "import { Accordion } from '@sakaniui/react';\n\n<Accordion>Label</Accordion>"
|
|
322
484
|
},
|
|
323
485
|
{
|
|
324
486
|
"name": "AccordionItem",
|
|
@@ -357,7 +519,8 @@
|
|
|
357
519
|
],
|
|
358
520
|
"requiresAccessibleName": false
|
|
359
521
|
},
|
|
360
|
-
"since": "0.1.0"
|
|
522
|
+
"since": "0.1.0",
|
|
523
|
+
"example": "import { AccordionItem } from '@sakaniui/react';\n\n<AccordionItem title=\"Title\">Label</AccordionItem>"
|
|
361
524
|
},
|
|
362
525
|
{
|
|
363
526
|
"name": "ActivityFeed",
|
|
@@ -393,7 +556,8 @@
|
|
|
393
556
|
],
|
|
394
557
|
"requiresAccessibleName": false
|
|
395
558
|
},
|
|
396
|
-
"since": "0.1.0"
|
|
559
|
+
"since": "0.1.0",
|
|
560
|
+
"example": "import { ActivityFeed } from '@sakaniui/react';\n\n<ActivityFeed items={[{ actor: \"Actor\", description: \"Description\", timestamp: \"2 min ago\" }]} />"
|
|
397
561
|
},
|
|
398
562
|
{
|
|
399
563
|
"name": "ActivityFeedHighlight",
|
|
@@ -406,7 +570,8 @@
|
|
|
406
570
|
"requiredProps": [],
|
|
407
571
|
"requiresAccessibleName": false
|
|
408
572
|
},
|
|
409
|
-
"since": "0.1.0"
|
|
573
|
+
"since": "0.1.0",
|
|
574
|
+
"example": "import { ActivityFeedHighlight } from '@sakaniui/react';\n\n<ActivityFeedHighlight>Label</ActivityFeedHighlight>"
|
|
410
575
|
},
|
|
411
576
|
{
|
|
412
577
|
"name": "Alert",
|
|
@@ -454,7 +619,8 @@
|
|
|
454
619
|
"requiredProps": [],
|
|
455
620
|
"requiresAccessibleName": false
|
|
456
621
|
},
|
|
457
|
-
"since": "0.1.0"
|
|
622
|
+
"since": "0.1.0",
|
|
623
|
+
"example": "import { Alert } from '@sakaniui/react';\n\n<Alert />"
|
|
458
624
|
},
|
|
459
625
|
{
|
|
460
626
|
"name": "Announcement",
|
|
@@ -512,7 +678,8 @@
|
|
|
512
678
|
],
|
|
513
679
|
"requiresAccessibleName": false
|
|
514
680
|
},
|
|
515
|
-
"since": "0.1.0"
|
|
681
|
+
"since": "0.1.0",
|
|
682
|
+
"example": "import { Announcement } from '@sakaniui/react';\n\n<Announcement message=\"Message\" />"
|
|
516
683
|
},
|
|
517
684
|
{
|
|
518
685
|
"name": "AreaChart",
|
|
@@ -574,7 +741,8 @@
|
|
|
574
741
|
],
|
|
575
742
|
"requiresAccessibleName": false
|
|
576
743
|
},
|
|
577
|
-
"since": "0.1.0"
|
|
744
|
+
"since": "0.1.0",
|
|
745
|
+
"example": "import { AreaChart } from '@sakaniui/react';\n\n<AreaChart data={[{ label: \"Label\", value: 50 }]} />"
|
|
578
746
|
},
|
|
579
747
|
{
|
|
580
748
|
"name": "Avatar",
|
|
@@ -630,7 +798,8 @@
|
|
|
630
798
|
"requiredProps": [],
|
|
631
799
|
"requiresAccessibleName": false
|
|
632
800
|
},
|
|
633
|
-
"since": "0.1.0"
|
|
801
|
+
"since": "0.1.0",
|
|
802
|
+
"example": "import { Avatar } from '@sakaniui/react';\n\n<Avatar />"
|
|
634
803
|
},
|
|
635
804
|
{
|
|
636
805
|
"name": "AvatarGroup",
|
|
@@ -677,7 +846,8 @@
|
|
|
677
846
|
],
|
|
678
847
|
"requiresAccessibleName": false
|
|
679
848
|
},
|
|
680
|
-
"since": "0.1.0"
|
|
849
|
+
"since": "0.1.0",
|
|
850
|
+
"example": "import { AvatarGroup } from '@sakaniui/react';\n\n<AvatarGroup avatars={[{}]} />"
|
|
681
851
|
},
|
|
682
852
|
{
|
|
683
853
|
"name": "AvatarUpload",
|
|
@@ -748,7 +918,8 @@
|
|
|
748
918
|
"requiredProps": [],
|
|
749
919
|
"requiresAccessibleName": false
|
|
750
920
|
},
|
|
751
|
-
"since": "0.1.0"
|
|
921
|
+
"since": "0.1.0",
|
|
922
|
+
"example": "import { AvatarUpload } from '@sakaniui/react';\n\n<AvatarUpload />"
|
|
752
923
|
},
|
|
753
924
|
{
|
|
754
925
|
"name": "Badge",
|
|
@@ -803,7 +974,8 @@
|
|
|
803
974
|
"requiredProps": [],
|
|
804
975
|
"requiresAccessibleName": false
|
|
805
976
|
},
|
|
806
|
-
"since": "0.1.0"
|
|
977
|
+
"since": "0.1.0",
|
|
978
|
+
"example": "import { Badge } from '@sakaniui/react';\n\n<Badge>Label</Badge>"
|
|
807
979
|
},
|
|
808
980
|
{
|
|
809
981
|
"name": "Balance",
|
|
@@ -857,7 +1029,8 @@
|
|
|
857
1029
|
],
|
|
858
1030
|
"requiresAccessibleName": false
|
|
859
1031
|
},
|
|
860
|
-
"since": "0.1.0"
|
|
1032
|
+
"since": "0.1.0",
|
|
1033
|
+
"example": "import { Balance } from '@sakaniui/react';\n\n<Balance value=\"Value\" />"
|
|
861
1034
|
},
|
|
862
1035
|
{
|
|
863
1036
|
"name": "BarChart",
|
|
@@ -916,7 +1089,8 @@
|
|
|
916
1089
|
],
|
|
917
1090
|
"requiresAccessibleName": false
|
|
918
1091
|
},
|
|
919
|
-
"since": "0.1.0"
|
|
1092
|
+
"since": "0.1.0",
|
|
1093
|
+
"example": "import { BarChart } from '@sakaniui/react';\n\n<BarChart data={[{ label: \"Label\", value: 50 }]} />"
|
|
920
1094
|
},
|
|
921
1095
|
{
|
|
922
1096
|
"name": "BlogBlockquote",
|
|
@@ -948,7 +1122,8 @@
|
|
|
948
1122
|
],
|
|
949
1123
|
"requiresAccessibleName": false
|
|
950
1124
|
},
|
|
951
|
-
"since": "0.3.0"
|
|
1125
|
+
"since": "0.3.0",
|
|
1126
|
+
"example": "import { BlogBlockquote } from '@sakaniui/react';\n\n<BlogBlockquote quote=\"Quote\" />"
|
|
952
1127
|
},
|
|
953
1128
|
{
|
|
954
1129
|
"name": "BlogFeatureText",
|
|
@@ -984,7 +1159,8 @@
|
|
|
984
1159
|
],
|
|
985
1160
|
"requiresAccessibleName": false
|
|
986
1161
|
},
|
|
987
|
-
"since": "0.3.0"
|
|
1162
|
+
"since": "0.3.0",
|
|
1163
|
+
"example": "import { BlogFeatureText } from '@sakaniui/react';\n\n<BlogFeatureText text=\"Text\" />"
|
|
988
1164
|
},
|
|
989
1165
|
{
|
|
990
1166
|
"name": "BlogImage",
|
|
@@ -1032,7 +1208,8 @@
|
|
|
1032
1208
|
],
|
|
1033
1209
|
"requiresAccessibleName": false
|
|
1034
1210
|
},
|
|
1035
|
-
"since": "0.3.0"
|
|
1211
|
+
"since": "0.3.0",
|
|
1212
|
+
"example": "import { BlogImage } from '@sakaniui/react';\n\n<BlogImage src=\"/images/example.jpg\" />"
|
|
1036
1213
|
},
|
|
1037
1214
|
{
|
|
1038
1215
|
"name": "BlogListingCard",
|
|
@@ -1104,7 +1281,8 @@
|
|
|
1104
1281
|
],
|
|
1105
1282
|
"requiresAccessibleName": false
|
|
1106
1283
|
},
|
|
1107
|
-
"since": "0.3.0"
|
|
1284
|
+
"since": "0.3.0",
|
|
1285
|
+
"example": "import { BlogListingCard } from '@sakaniui/react';\n\n<BlogListingCard image=\"/images/example.jpg\" category=\"Category\" readTime=\"5 min read\" title=\"Title\" excerpt=\"Excerpt\" author={{ name: \"Name\", date: \"Oct 21, 2026\" }} />"
|
|
1108
1286
|
},
|
|
1109
1287
|
{
|
|
1110
1288
|
"name": "BlogListingFeaturedCard",
|
|
@@ -1180,7 +1358,8 @@
|
|
|
1180
1358
|
],
|
|
1181
1359
|
"requiresAccessibleName": false
|
|
1182
1360
|
},
|
|
1183
|
-
"since": "0.3.0"
|
|
1361
|
+
"since": "0.3.0",
|
|
1362
|
+
"example": "import { BlogListingFeaturedCard } from '@sakaniui/react';\n\n<BlogListingFeaturedCard image=\"/images/example.jpg\" title=\"Title\" excerpt=\"Excerpt\" author={{ name: \"Name\", date: \"Oct 21, 2026\" }} />"
|
|
1184
1363
|
},
|
|
1185
1364
|
{
|
|
1186
1365
|
"name": "BoardCard",
|
|
@@ -1277,7 +1456,8 @@
|
|
|
1277
1456
|
],
|
|
1278
1457
|
"requiresAccessibleName": false
|
|
1279
1458
|
},
|
|
1280
|
-
"since": "0.1.0"
|
|
1459
|
+
"since": "0.1.0",
|
|
1460
|
+
"example": "import { BoardCard } from '@sakaniui/react';\n\n<BoardCard title=\"Title\" />"
|
|
1281
1461
|
},
|
|
1282
1462
|
{
|
|
1283
1463
|
"name": "BoardColumn",
|
|
@@ -1343,7 +1523,8 @@
|
|
|
1343
1523
|
],
|
|
1344
1524
|
"requiresAccessibleName": false
|
|
1345
1525
|
},
|
|
1346
|
-
"since": "0.1.0"
|
|
1526
|
+
"since": "0.1.0",
|
|
1527
|
+
"example": "import { BoardColumn } from '@sakaniui/react';\n\n<BoardColumn title=\"Title\" />"
|
|
1347
1528
|
},
|
|
1348
1529
|
{
|
|
1349
1530
|
"name": "Breadcrumb",
|
|
@@ -1379,7 +1560,8 @@
|
|
|
1379
1560
|
],
|
|
1380
1561
|
"requiresAccessibleName": false
|
|
1381
1562
|
},
|
|
1382
|
-
"since": "0.1.0"
|
|
1563
|
+
"since": "0.1.0",
|
|
1564
|
+
"example": "import { Breadcrumb } from '@sakaniui/react';\n\n<Breadcrumb items={[{ label: \"Label\" }]} />"
|
|
1383
1565
|
},
|
|
1384
1566
|
{
|
|
1385
1567
|
"name": "Button",
|
|
@@ -1446,7 +1628,8 @@
|
|
|
1446
1628
|
],
|
|
1447
1629
|
"requiresAccessibleName": false
|
|
1448
1630
|
},
|
|
1449
|
-
"since": "0.1.0"
|
|
1631
|
+
"since": "0.1.0",
|
|
1632
|
+
"example": "import { Button } from '@sakaniui/react';\n\n<Button>Label</Button>"
|
|
1450
1633
|
},
|
|
1451
1634
|
{
|
|
1452
1635
|
"name": "Calendar",
|
|
@@ -1524,7 +1707,8 @@
|
|
|
1524
1707
|
"requiredProps": [],
|
|
1525
1708
|
"requiresAccessibleName": false
|
|
1526
1709
|
},
|
|
1527
|
-
"since": "0.1.0"
|
|
1710
|
+
"since": "0.1.0",
|
|
1711
|
+
"example": "import { Calendar } from '@sakaniui/react';\n\n<Calendar />"
|
|
1528
1712
|
},
|
|
1529
1713
|
{
|
|
1530
1714
|
"name": "Card",
|
|
@@ -1552,7 +1736,8 @@
|
|
|
1552
1736
|
{
|
|
1553
1737
|
"name": "leadingAction",
|
|
1554
1738
|
"type": "ReactNode",
|
|
1555
|
-
"required": false
|
|
1739
|
+
"required": false,
|
|
1740
|
+
"since": "0.3.16"
|
|
1556
1741
|
},
|
|
1557
1742
|
{
|
|
1558
1743
|
"name": "interactive",
|
|
@@ -1569,7 +1754,8 @@
|
|
|
1569
1754
|
"requiredProps": [],
|
|
1570
1755
|
"requiresAccessibleName": false
|
|
1571
1756
|
},
|
|
1572
|
-
"since": "0.1.0"
|
|
1757
|
+
"since": "0.1.0",
|
|
1758
|
+
"example": "import { Card } from '@sakaniui/react';\n\n<Card />"
|
|
1573
1759
|
},
|
|
1574
1760
|
{
|
|
1575
1761
|
"name": "CardMetaItem",
|
|
@@ -1596,7 +1782,8 @@
|
|
|
1596
1782
|
],
|
|
1597
1783
|
"requiresAccessibleName": false
|
|
1598
1784
|
},
|
|
1599
|
-
"since": "0.1.0"
|
|
1785
|
+
"since": "0.1.0",
|
|
1786
|
+
"example": "import { CardMetaItem } from '@sakaniui/react';\n\n<CardMetaItem icon=\"Icon\">Label</CardMetaItem>"
|
|
1600
1787
|
},
|
|
1601
1788
|
{
|
|
1602
1789
|
"name": "CartItem",
|
|
@@ -1689,7 +1876,8 @@
|
|
|
1689
1876
|
],
|
|
1690
1877
|
"requiresAccessibleName": false
|
|
1691
1878
|
},
|
|
1692
|
-
"since": "0.3.0"
|
|
1879
|
+
"since": "0.3.0",
|
|
1880
|
+
"example": "import { CartItem } from '@sakaniui/react';\n\n<CartItem image=\"/images/example.jpg\" name=\"Name\" price={49} quantity={1} />"
|
|
1693
1881
|
},
|
|
1694
1882
|
{
|
|
1695
1883
|
"name": "ChatComposer",
|
|
@@ -1757,7 +1945,8 @@
|
|
|
1757
1945
|
"requiredProps": [],
|
|
1758
1946
|
"requiresAccessibleName": false
|
|
1759
1947
|
},
|
|
1760
|
-
"since": "0.1.0"
|
|
1948
|
+
"since": "0.1.0",
|
|
1949
|
+
"example": "import { ChatComposer } from '@sakaniui/react';\n\n<ChatComposer />"
|
|
1761
1950
|
},
|
|
1762
1951
|
{
|
|
1763
1952
|
"name": "Checkbox",
|
|
@@ -1787,7 +1976,8 @@
|
|
|
1787
1976
|
"requiredProps": [],
|
|
1788
1977
|
"requiresAccessibleName": false
|
|
1789
1978
|
},
|
|
1790
|
-
"since": "0.1.0"
|
|
1979
|
+
"since": "0.1.0",
|
|
1980
|
+
"example": "import { Checkbox } from '@sakaniui/react';\n\n<Checkbox />"
|
|
1791
1981
|
},
|
|
1792
1982
|
{
|
|
1793
1983
|
"name": "CheckoutSteps",
|
|
@@ -1820,7 +2010,8 @@
|
|
|
1820
2010
|
],
|
|
1821
2011
|
"requiresAccessibleName": false
|
|
1822
2012
|
},
|
|
1823
|
-
"since": "0.3.0"
|
|
2013
|
+
"since": "0.3.0",
|
|
2014
|
+
"example": "import { CheckoutSteps } from '@sakaniui/react';\n\n<CheckoutSteps currentStep={1} />"
|
|
1824
2015
|
},
|
|
1825
2016
|
{
|
|
1826
2017
|
"name": "CodeSnippet",
|
|
@@ -1876,7 +2067,8 @@
|
|
|
1876
2067
|
],
|
|
1877
2068
|
"requiresAccessibleName": false
|
|
1878
2069
|
},
|
|
1879
|
-
"since": "0.1.0"
|
|
2070
|
+
"since": "0.1.0",
|
|
2071
|
+
"example": "import { CodeSnippet } from '@sakaniui/react';\n\n<CodeSnippet code=\"Code\" />"
|
|
1880
2072
|
},
|
|
1881
2073
|
{
|
|
1882
2074
|
"name": "ColorSwatch",
|
|
@@ -1928,7 +2120,8 @@
|
|
|
1928
2120
|
],
|
|
1929
2121
|
"requiresAccessibleName": false
|
|
1930
2122
|
},
|
|
1931
|
-
"since": "0.3.0"
|
|
2123
|
+
"since": "0.3.0",
|
|
2124
|
+
"example": "import { ColorSwatch } from '@sakaniui/react';\n\n<ColorSwatch color=\"var(--color-accent-default)\" label=\"Label\" />"
|
|
1932
2125
|
},
|
|
1933
2126
|
{
|
|
1934
2127
|
"name": "Combobox",
|
|
@@ -2017,7 +2210,8 @@
|
|
|
2017
2210
|
],
|
|
2018
2211
|
"requiresAccessibleName": false
|
|
2019
2212
|
},
|
|
2020
|
-
"since": "0.1.0"
|
|
2213
|
+
"since": "0.1.0",
|
|
2214
|
+
"example": "import { Combobox } from '@sakaniui/react';\n\n<Combobox options={[{ value: \"Value\", label: \"Label\" }]} />"
|
|
2021
2215
|
},
|
|
2022
2216
|
{
|
|
2023
2217
|
"name": "ConversationItem",
|
|
@@ -2086,7 +2280,8 @@
|
|
|
2086
2280
|
],
|
|
2087
2281
|
"requiresAccessibleName": false
|
|
2088
2282
|
},
|
|
2089
|
-
"since": "0.1.0"
|
|
2283
|
+
"since": "0.1.0",
|
|
2284
|
+
"example": "import { ConversationItem } from '@sakaniui/react';\n\n<ConversationItem avatar=\"/images/example.jpg\" name=\"Name\" />"
|
|
2090
2285
|
},
|
|
2091
2286
|
{
|
|
2092
2287
|
"name": "Divider",
|
|
@@ -2122,7 +2317,8 @@
|
|
|
2122
2317
|
"requiredProps": [],
|
|
2123
2318
|
"requiresAccessibleName": false
|
|
2124
2319
|
},
|
|
2125
|
-
"since": "0.1.0"
|
|
2320
|
+
"since": "0.1.0",
|
|
2321
|
+
"example": "import { Divider } from '@sakaniui/react';\n\n<Divider />"
|
|
2126
2322
|
},
|
|
2127
2323
|
{
|
|
2128
2324
|
"name": "DonutChart",
|
|
@@ -2176,7 +2372,8 @@
|
|
|
2176
2372
|
],
|
|
2177
2373
|
"requiresAccessibleName": false
|
|
2178
2374
|
},
|
|
2179
|
-
"since": "0.1.0"
|
|
2375
|
+
"since": "0.1.0",
|
|
2376
|
+
"example": "import { DonutChart } from '@sakaniui/react';\n\n<DonutChart data={[{ label: \"Label\", value: 50 }]} />"
|
|
2180
2377
|
},
|
|
2181
2378
|
{
|
|
2182
2379
|
"name": "EmptyState",
|
|
@@ -2233,7 +2430,8 @@
|
|
|
2233
2430
|
"requiredProps": [],
|
|
2234
2431
|
"requiresAccessibleName": false
|
|
2235
2432
|
},
|
|
2236
|
-
"since": "0.1.0"
|
|
2433
|
+
"since": "0.1.0",
|
|
2434
|
+
"example": "import { EmptyState } from '@sakaniui/react';\n\n<EmptyState />"
|
|
2237
2435
|
},
|
|
2238
2436
|
{
|
|
2239
2437
|
"name": "Expenses",
|
|
@@ -2275,7 +2473,8 @@
|
|
|
2275
2473
|
],
|
|
2276
2474
|
"requiresAccessibleName": false
|
|
2277
2475
|
},
|
|
2278
|
-
"since": "0.1.0"
|
|
2476
|
+
"since": "0.1.0",
|
|
2477
|
+
"example": "import { Expenses } from '@sakaniui/react';\n\n<Expenses categories={[{ icon: \"Icon\", label: \"Label\", amount: 49 }]} />"
|
|
2279
2478
|
},
|
|
2280
2479
|
{
|
|
2281
2480
|
"name": "FacebookIcon",
|
|
@@ -2295,7 +2494,8 @@
|
|
|
2295
2494
|
"requiredProps": [],
|
|
2296
2495
|
"requiresAccessibleName": false
|
|
2297
2496
|
},
|
|
2298
|
-
"since": "0.
|
|
2497
|
+
"since": "0.8.6",
|
|
2498
|
+
"example": "import { FacebookIcon } from '@sakaniui/react';\n\n<FacebookIcon />"
|
|
2299
2499
|
},
|
|
2300
2500
|
{
|
|
2301
2501
|
"name": "FeaturedIcon",
|
|
@@ -2344,7 +2544,8 @@
|
|
|
2344
2544
|
],
|
|
2345
2545
|
"requiresAccessibleName": false
|
|
2346
2546
|
},
|
|
2347
|
-
"since": "0.3.0"
|
|
2547
|
+
"since": "0.3.0",
|
|
2548
|
+
"example": "import { FeaturedIcon } from '@sakaniui/react';\n\n<FeaturedIcon icon=\"Icon\" />"
|
|
2348
2549
|
},
|
|
2349
2550
|
{
|
|
2350
2551
|
"name": "FileUpload",
|
|
@@ -2388,7 +2589,8 @@
|
|
|
2388
2589
|
"requiredProps": [],
|
|
2389
2590
|
"requiresAccessibleName": false
|
|
2390
2591
|
},
|
|
2391
|
-
"since": "0.1.0"
|
|
2592
|
+
"since": "0.1.0",
|
|
2593
|
+
"example": "import { FileUpload } from '@sakaniui/react';\n\n<FileUpload />"
|
|
2392
2594
|
},
|
|
2393
2595
|
{
|
|
2394
2596
|
"name": "FilterChip",
|
|
@@ -2430,7 +2632,8 @@
|
|
|
2430
2632
|
"requiredProps": [],
|
|
2431
2633
|
"requiresAccessibleName": false
|
|
2432
2634
|
},
|
|
2433
|
-
"since": "0.1.0"
|
|
2635
|
+
"since": "0.1.0",
|
|
2636
|
+
"example": "import { FilterChip } from '@sakaniui/react';\n\n<FilterChip>Label</FilterChip>"
|
|
2434
2637
|
},
|
|
2435
2638
|
{
|
|
2436
2639
|
"name": "FirstPageHeading",
|
|
@@ -2499,7 +2702,8 @@
|
|
|
2499
2702
|
],
|
|
2500
2703
|
"requiresAccessibleName": false
|
|
2501
2704
|
},
|
|
2502
|
-
"since": "0.3.0"
|
|
2705
|
+
"since": "0.3.0",
|
|
2706
|
+
"example": "import { FirstPageHeading } from '@sakaniui/react';\n\n<FirstPageHeading title=\"Title\" />"
|
|
2503
2707
|
},
|
|
2504
2708
|
{
|
|
2505
2709
|
"name": "FunnelChart",
|
|
@@ -2537,7 +2741,8 @@
|
|
|
2537
2741
|
],
|
|
2538
2742
|
"requiresAccessibleName": false
|
|
2539
2743
|
},
|
|
2540
|
-
"since": "0.1.0"
|
|
2744
|
+
"since": "0.1.0",
|
|
2745
|
+
"example": "import { FunnelChart } from '@sakaniui/react';\n\n<FunnelChart data={[{ label: \"Label\", value: 50 }]} />"
|
|
2541
2746
|
},
|
|
2542
2747
|
{
|
|
2543
2748
|
"name": "GithubIcon",
|
|
@@ -2557,7 +2762,8 @@
|
|
|
2557
2762
|
"requiredProps": [],
|
|
2558
2763
|
"requiresAccessibleName": false
|
|
2559
2764
|
},
|
|
2560
|
-
"since": "0.
|
|
2765
|
+
"since": "0.8.6",
|
|
2766
|
+
"example": "import { GithubIcon } from '@sakaniui/react';\n\n<GithubIcon />"
|
|
2561
2767
|
},
|
|
2562
2768
|
{
|
|
2563
2769
|
"name": "HeatmapChart",
|
|
@@ -2612,7 +2818,8 @@
|
|
|
2612
2818
|
],
|
|
2613
2819
|
"requiresAccessibleName": false
|
|
2614
2820
|
},
|
|
2615
|
-
"since": "0.1.0"
|
|
2821
|
+
"since": "0.1.0",
|
|
2822
|
+
"example": "import { HeatmapChart } from '@sakaniui/react';\n\n<HeatmapChart data={[[1]]} />"
|
|
2616
2823
|
},
|
|
2617
2824
|
{
|
|
2618
2825
|
"name": "HoverGroup",
|
|
@@ -2625,7 +2832,8 @@
|
|
|
2625
2832
|
"requiredProps": [],
|
|
2626
2833
|
"requiresAccessibleName": false
|
|
2627
2834
|
},
|
|
2628
|
-
"since": "0.3.21"
|
|
2835
|
+
"since": "0.3.21",
|
|
2836
|
+
"example": "import { HoverGroup } from '@sakaniui/react';\n\n<HoverGroup>Label</HoverGroup>"
|
|
2629
2837
|
},
|
|
2630
2838
|
{
|
|
2631
2839
|
"name": "IconButton",
|
|
@@ -2678,7 +2886,8 @@
|
|
|
2678
2886
|
],
|
|
2679
2887
|
"requiresAccessibleName": true
|
|
2680
2888
|
},
|
|
2681
|
-
"since": "0.1.0"
|
|
2889
|
+
"since": "0.1.0",
|
|
2890
|
+
"example": "import { IconButton } from '@sakaniui/react';\nimport { IconStar } from '@sakaniui/react/icons';\n\n<IconButton icon={IconStar} aria-label=\"Describe the action\" />"
|
|
2682
2891
|
},
|
|
2683
2892
|
{
|
|
2684
2893
|
"name": "InlineHint",
|
|
@@ -2714,7 +2923,8 @@
|
|
|
2714
2923
|
],
|
|
2715
2924
|
"requiresAccessibleName": false
|
|
2716
2925
|
},
|
|
2717
|
-
"since": "0.1.0"
|
|
2926
|
+
"since": "0.1.0",
|
|
2927
|
+
"example": "import { InlineHint } from '@sakaniui/react';\n\n<InlineHint message=\"Message\" />"
|
|
2718
2928
|
},
|
|
2719
2929
|
{
|
|
2720
2930
|
"name": "Input",
|
|
@@ -2771,7 +2981,8 @@
|
|
|
2771
2981
|
"requiredProps": [],
|
|
2772
2982
|
"requiresAccessibleName": false
|
|
2773
2983
|
},
|
|
2774
|
-
"since": "0.1.0"
|
|
2984
|
+
"since": "0.1.0",
|
|
2985
|
+
"example": "import { Input } from '@sakaniui/react';\n\n<Input />"
|
|
2775
2986
|
},
|
|
2776
2987
|
{
|
|
2777
2988
|
"name": "InstagramIcon",
|
|
@@ -2791,7 +3002,8 @@
|
|
|
2791
3002
|
"requiredProps": [],
|
|
2792
3003
|
"requiresAccessibleName": false
|
|
2793
3004
|
},
|
|
2794
|
-
"since": "0.
|
|
3005
|
+
"since": "0.8.6",
|
|
3006
|
+
"example": "import { InstagramIcon } from '@sakaniui/react';\n\n<InstagramIcon />"
|
|
2795
3007
|
},
|
|
2796
3008
|
{
|
|
2797
3009
|
"name": "JobListing",
|
|
@@ -2873,7 +3085,8 @@
|
|
|
2873
3085
|
],
|
|
2874
3086
|
"requiresAccessibleName": false
|
|
2875
3087
|
},
|
|
2876
|
-
"since": "0.3.0"
|
|
3088
|
+
"since": "0.3.0",
|
|
3089
|
+
"example": "import { JobListing } from '@sakaniui/react';\n\n<JobListing title=\"Title\" description=\"Description\" department=\"Department\" employmentType=\"Employment type\" location=\"Location\" />"
|
|
2877
3090
|
},
|
|
2878
3091
|
{
|
|
2879
3092
|
"name": "Kbd",
|
|
@@ -2892,7 +3105,8 @@
|
|
|
2892
3105
|
"requiredProps": [],
|
|
2893
3106
|
"requiresAccessibleName": false
|
|
2894
3107
|
},
|
|
2895
|
-
"since": "0.1.0"
|
|
3108
|
+
"since": "0.1.0",
|
|
3109
|
+
"example": "import { Kbd } from '@sakaniui/react';\n\n<Kbd>Label</Kbd>"
|
|
2896
3110
|
},
|
|
2897
3111
|
{
|
|
2898
3112
|
"name": "Label",
|
|
@@ -2912,7 +3126,8 @@
|
|
|
2912
3126
|
"requiredProps": [],
|
|
2913
3127
|
"requiresAccessibleName": false
|
|
2914
3128
|
},
|
|
2915
|
-
"since": "0.1.0"
|
|
3129
|
+
"since": "0.1.0",
|
|
3130
|
+
"example": "import { Label } from '@sakaniui/react';\n\n<Label>Label</Label>"
|
|
2916
3131
|
},
|
|
2917
3132
|
{
|
|
2918
3133
|
"name": "LineChart",
|
|
@@ -2999,7 +3214,8 @@
|
|
|
2999
3214
|
],
|
|
3000
3215
|
"requiresAccessibleName": false
|
|
3001
3216
|
},
|
|
3002
|
-
"since": "0.1.0"
|
|
3217
|
+
"since": "0.1.0",
|
|
3218
|
+
"example": "import { LineChart } from '@sakaniui/react';\n\n<LineChart data={[{ name: \"Name\" }]} series={[\"Sery\"]} />"
|
|
3003
3219
|
},
|
|
3004
3220
|
{
|
|
3005
3221
|
"name": "Link",
|
|
@@ -3019,7 +3235,8 @@
|
|
|
3019
3235
|
"requiredProps": [],
|
|
3020
3236
|
"requiresAccessibleName": false
|
|
3021
3237
|
},
|
|
3022
|
-
"since": "0.1.0"
|
|
3238
|
+
"since": "0.1.0",
|
|
3239
|
+
"example": "import { Link } from '@sakaniui/react';\n\n<Link>Label</Link>"
|
|
3023
3240
|
},
|
|
3024
3241
|
{
|
|
3025
3242
|
"name": "LinkedinIcon",
|
|
@@ -3039,7 +3256,8 @@
|
|
|
3039
3256
|
"requiredProps": [],
|
|
3040
3257
|
"requiresAccessibleName": false
|
|
3041
3258
|
},
|
|
3042
|
-
"since": "0.
|
|
3259
|
+
"since": "0.8.6",
|
|
3260
|
+
"example": "import { LinkedinIcon } from '@sakaniui/react';\n\n<LinkedinIcon />"
|
|
3043
3261
|
},
|
|
3044
3262
|
{
|
|
3045
3263
|
"name": "LiquidBackdrop",
|
|
@@ -3074,7 +3292,8 @@
|
|
|
3074
3292
|
],
|
|
3075
3293
|
"requiresAccessibleName": false
|
|
3076
3294
|
},
|
|
3077
|
-
"since": "0.4.
|
|
3295
|
+
"since": "0.4.3",
|
|
3296
|
+
"example": "import { LiquidBackdrop } from '@sakaniui/react';\n\n<LiquidBackdrop src=\"/images/example.jpg\" />"
|
|
3078
3297
|
},
|
|
3079
3298
|
{
|
|
3080
3299
|
"name": "LiquidGlass",
|
|
@@ -3106,7 +3325,8 @@
|
|
|
3106
3325
|
"clear"
|
|
3107
3326
|
],
|
|
3108
3327
|
"default": "auto",
|
|
3109
|
-
"description": "How much of the backdrop shows through. Default 'auto' (follows `variant`)."
|
|
3328
|
+
"description": "How much of the backdrop shows through. Default 'auto' (follows `variant`).",
|
|
3329
|
+
"since": "0.4.1"
|
|
3110
3330
|
},
|
|
3111
3331
|
{
|
|
3112
3332
|
"name": "radius",
|
|
@@ -3130,21 +3350,24 @@
|
|
|
3130
3350
|
"name": "effect",
|
|
3131
3351
|
"type": "Partial<LiquidGlassEffect>",
|
|
3132
3352
|
"required": false,
|
|
3133
|
-
"description": "Defaults come from the variant's --liquid-* tokens."
|
|
3353
|
+
"description": "Defaults come from the variant's --liquid-* tokens.",
|
|
3354
|
+
"since": "0.4.3"
|
|
3134
3355
|
},
|
|
3135
3356
|
{
|
|
3136
3357
|
"name": "source",
|
|
3137
3358
|
"type": "boolean",
|
|
3138
3359
|
"required": false,
|
|
3139
3360
|
"default": true,
|
|
3140
|
-
"description": "Inside a <LiquidBackdrop>: true (default) refracts the backdrop image; false bends whatever is painted below instead (UI under a slider knob)."
|
|
3361
|
+
"description": "Inside a <LiquidBackdrop>: true (default) refracts the backdrop image; false bends whatever is painted below instead (UI under a slider knob).",
|
|
3362
|
+
"since": "0.4.3"
|
|
3141
3363
|
},
|
|
3142
3364
|
{
|
|
3143
3365
|
"name": "bake",
|
|
3144
3366
|
"type": "boolean | \"auto\"",
|
|
3145
3367
|
"required": false,
|
|
3146
3368
|
"default": "auto",
|
|
3147
|
-
"description": "'auto' (default): inside a LiquidBackdrop, lenses over 300×300 bake their glass once (fast; for surfaces that stay put). false: always live (a big lens that moves)."
|
|
3369
|
+
"description": "'auto' (default): inside a LiquidBackdrop, lenses over 300×300 bake their glass once (fast; for surfaces that stay put). false: always live (a big lens that moves).",
|
|
3370
|
+
"since": "0.4.3"
|
|
3148
3371
|
},
|
|
3149
3372
|
{
|
|
3150
3373
|
"name": "interactive",
|
|
@@ -3157,7 +3380,8 @@
|
|
|
3157
3380
|
"requiredProps": [],
|
|
3158
3381
|
"requiresAccessibleName": false
|
|
3159
3382
|
},
|
|
3160
|
-
"since": "0.4.0"
|
|
3383
|
+
"since": "0.4.0",
|
|
3384
|
+
"example": "import { LiquidGlass } from '@sakaniui/react';\n\n<LiquidGlass />"
|
|
3161
3385
|
},
|
|
3162
3386
|
{
|
|
3163
3387
|
"name": "List",
|
|
@@ -3194,7 +3418,8 @@
|
|
|
3194
3418
|
],
|
|
3195
3419
|
"requiresAccessibleName": false
|
|
3196
3420
|
},
|
|
3197
|
-
"since": "0.3.0"
|
|
3421
|
+
"since": "0.3.0",
|
|
3422
|
+
"example": "import { List } from '@sakaniui/react';\n\n<List items={[\"Item\"]} />"
|
|
3198
3423
|
},
|
|
3199
3424
|
{
|
|
3200
3425
|
"name": "ListItem",
|
|
@@ -3250,7 +3475,8 @@
|
|
|
3250
3475
|
],
|
|
3251
3476
|
"requiresAccessibleName": false
|
|
3252
3477
|
},
|
|
3253
|
-
"since": "0.1.0"
|
|
3478
|
+
"since": "0.1.0",
|
|
3479
|
+
"example": "import { ListItem } from '@sakaniui/react';\n\n<ListItem title=\"Title\" />"
|
|
3254
3480
|
},
|
|
3255
3481
|
{
|
|
3256
3482
|
"name": "LocationDot",
|
|
@@ -3286,7 +3512,8 @@
|
|
|
3286
3512
|
],
|
|
3287
3513
|
"requiresAccessibleName": false
|
|
3288
3514
|
},
|
|
3289
|
-
"since": "0.3.0"
|
|
3515
|
+
"since": "0.3.0",
|
|
3516
|
+
"example": "import { LocationDot } from '@sakaniui/react';\n\n<LocationDot location=\"Location\" />"
|
|
3290
3517
|
},
|
|
3291
3518
|
{
|
|
3292
3519
|
"name": "Marquee",
|
|
@@ -3326,7 +3553,8 @@
|
|
|
3326
3553
|
],
|
|
3327
3554
|
"requiresAccessibleName": false
|
|
3328
3555
|
},
|
|
3329
|
-
"since": "0.3.0"
|
|
3556
|
+
"since": "0.3.0",
|
|
3557
|
+
"example": "import { Marquee } from '@sakaniui/react';\n\n<Marquee items={[\"Item\"]} gap={1} />"
|
|
3330
3558
|
},
|
|
3331
3559
|
{
|
|
3332
3560
|
"name": "Menu",
|
|
@@ -3358,7 +3586,8 @@
|
|
|
3358
3586
|
"requiredProps": [],
|
|
3359
3587
|
"requiresAccessibleName": false
|
|
3360
3588
|
},
|
|
3361
|
-
"since": "0.1.0"
|
|
3589
|
+
"since": "0.1.0",
|
|
3590
|
+
"example": "import { Menu } from '@sakaniui/react';\n\n<Menu>Label</Menu>"
|
|
3362
3591
|
},
|
|
3363
3592
|
{
|
|
3364
3593
|
"name": "MenuDivider",
|
|
@@ -3371,7 +3600,8 @@
|
|
|
3371
3600
|
"requiredProps": [],
|
|
3372
3601
|
"requiresAccessibleName": false
|
|
3373
3602
|
},
|
|
3374
|
-
"since": "0.1.0"
|
|
3603
|
+
"since": "0.1.0",
|
|
3604
|
+
"example": "import { MenuDivider } from '@sakaniui/react';\n\n<MenuDivider />"
|
|
3375
3605
|
},
|
|
3376
3606
|
{
|
|
3377
3607
|
"name": "MenuItem",
|
|
@@ -3420,7 +3650,8 @@
|
|
|
3420
3650
|
"requiredProps": [],
|
|
3421
3651
|
"requiresAccessibleName": false
|
|
3422
3652
|
},
|
|
3423
|
-
"since": "0.1.0"
|
|
3653
|
+
"since": "0.1.0",
|
|
3654
|
+
"example": "import { MenuItem } from '@sakaniui/react';\n\n<MenuItem>Label</MenuItem>"
|
|
3424
3655
|
},
|
|
3425
3656
|
{
|
|
3426
3657
|
"name": "MessageBubble",
|
|
@@ -3512,7 +3743,8 @@
|
|
|
3512
3743
|
"requiredProps": [],
|
|
3513
3744
|
"requiresAccessibleName": false
|
|
3514
3745
|
},
|
|
3515
|
-
"since": "0.1.0"
|
|
3746
|
+
"since": "0.1.0",
|
|
3747
|
+
"example": "import { MessageBubble } from '@sakaniui/react';\n\n<MessageBubble />"
|
|
3516
3748
|
},
|
|
3517
3749
|
{
|
|
3518
3750
|
"name": "Metric",
|
|
@@ -3550,7 +3782,8 @@
|
|
|
3550
3782
|
],
|
|
3551
3783
|
"requiresAccessibleName": false
|
|
3552
3784
|
},
|
|
3553
|
-
"since": "0.3.0"
|
|
3785
|
+
"since": "0.3.0",
|
|
3786
|
+
"example": "import { Metric } from '@sakaniui/react';\n\n<Metric value=\"Value\" label=\"Label\" />"
|
|
3554
3787
|
},
|
|
3555
3788
|
{
|
|
3556
3789
|
"name": "MobileNavigationMenu",
|
|
@@ -3610,7 +3843,8 @@
|
|
|
3610
3843
|
],
|
|
3611
3844
|
"requiresAccessibleName": false
|
|
3612
3845
|
},
|
|
3613
|
-
"since": "0.3.0"
|
|
3846
|
+
"since": "0.3.0",
|
|
3847
|
+
"example": "import { MobileNavigationMenu } from '@sakaniui/react';\n\n<MobileNavigationMenu label=\"Label\" links={[{ label: \"Label\" }]} />"
|
|
3614
3848
|
},
|
|
3615
3849
|
{
|
|
3616
3850
|
"name": "Modal",
|
|
@@ -3737,7 +3971,8 @@
|
|
|
3737
3971
|
],
|
|
3738
3972
|
"requiresAccessibleName": false
|
|
3739
3973
|
},
|
|
3740
|
-
"since": "0.1.0"
|
|
3974
|
+
"since": "0.1.0",
|
|
3975
|
+
"example": "import { Modal } from '@sakaniui/react';\n\n<Modal open={true} onClose={() => {}} title=\"Title\" />"
|
|
3741
3976
|
},
|
|
3742
3977
|
{
|
|
3743
3978
|
"name": "NotificationItem",
|
|
@@ -3809,7 +4044,8 @@
|
|
|
3809
4044
|
],
|
|
3810
4045
|
"requiresAccessibleName": false
|
|
3811
4046
|
},
|
|
3812
|
-
"since": "0.1.0"
|
|
4047
|
+
"since": "0.1.0",
|
|
4048
|
+
"example": "import { NotificationItem } from '@sakaniui/react';\n\n<NotificationItem title=\"Title\" />"
|
|
3813
4049
|
},
|
|
3814
4050
|
{
|
|
3815
4051
|
"name": "Pagination",
|
|
@@ -3856,7 +4092,8 @@
|
|
|
3856
4092
|
],
|
|
3857
4093
|
"requiresAccessibleName": false
|
|
3858
4094
|
},
|
|
3859
|
-
"since": "0.1.0"
|
|
4095
|
+
"since": "0.1.0",
|
|
4096
|
+
"example": "import { Pagination } from '@sakaniui/react';\n\n<Pagination total={49} page={1} onPageChange={() => {}} />"
|
|
3860
4097
|
},
|
|
3861
4098
|
{
|
|
3862
4099
|
"name": "PieChart",
|
|
@@ -3923,7 +4160,8 @@
|
|
|
3923
4160
|
],
|
|
3924
4161
|
"requiresAccessibleName": false
|
|
3925
4162
|
},
|
|
3926
|
-
"since": "0.1.0"
|
|
4163
|
+
"since": "0.1.0",
|
|
4164
|
+
"example": "import { PieChart } from '@sakaniui/react';\n\n<PieChart data={[{ label: \"Label\", value: 50 }]} />"
|
|
3927
4165
|
},
|
|
3928
4166
|
{
|
|
3929
4167
|
"name": "PlaceholderLogo",
|
|
@@ -3965,7 +4203,8 @@
|
|
|
3965
4203
|
"requiredProps": [],
|
|
3966
4204
|
"requiresAccessibleName": false
|
|
3967
4205
|
},
|
|
3968
|
-
"since": "0.3.0"
|
|
4206
|
+
"since": "0.3.0",
|
|
4207
|
+
"example": "import { PlaceholderLogo } from '@sakaniui/react';\n\n<PlaceholderLogo />"
|
|
3969
4208
|
},
|
|
3970
4209
|
{
|
|
3971
4210
|
"name": "Popover",
|
|
@@ -4020,7 +4259,8 @@
|
|
|
4020
4259
|
],
|
|
4021
4260
|
"requiresAccessibleName": false
|
|
4022
4261
|
},
|
|
4023
|
-
"since": "0.1.0"
|
|
4262
|
+
"since": "0.1.0",
|
|
4263
|
+
"example": "import { Popover } from '@sakaniui/react';\n\n<Popover trigger=\"Trigger\" />"
|
|
4024
4264
|
},
|
|
4025
4265
|
{
|
|
4026
4266
|
"name": "PriceDisplay",
|
|
@@ -4064,7 +4304,8 @@
|
|
|
4064
4304
|
],
|
|
4065
4305
|
"requiresAccessibleName": false
|
|
4066
4306
|
},
|
|
4067
|
-
"since": "0.3.0"
|
|
4307
|
+
"since": "0.3.0",
|
|
4308
|
+
"example": "import { PriceDisplay } from '@sakaniui/react';\n\n<PriceDisplay price={49} />"
|
|
4068
4309
|
},
|
|
4069
4310
|
{
|
|
4070
4311
|
"name": "ProductCard",
|
|
@@ -4172,7 +4413,8 @@
|
|
|
4172
4413
|
],
|
|
4173
4414
|
"requiresAccessibleName": false
|
|
4174
4415
|
},
|
|
4175
|
-
"since": "0.3.0"
|
|
4416
|
+
"since": "0.3.0",
|
|
4417
|
+
"example": "import { ProductCard } from '@sakaniui/react';\n\n<ProductCard image=\"/images/example.jpg\" name=\"Name\" price={49} />"
|
|
4176
4418
|
},
|
|
4177
4419
|
{
|
|
4178
4420
|
"name": "ProductGallery",
|
|
@@ -4225,7 +4467,8 @@
|
|
|
4225
4467
|
],
|
|
4226
4468
|
"requiresAccessibleName": false
|
|
4227
4469
|
},
|
|
4228
|
-
"since": "0.3.0"
|
|
4470
|
+
"since": "0.3.0",
|
|
4471
|
+
"example": "import { ProductGallery } from '@sakaniui/react';\n\n<ProductGallery images={[{ src: \"/images/example.jpg\" }]} />"
|
|
4229
4472
|
},
|
|
4230
4473
|
{
|
|
4231
4474
|
"name": "ProfileCard",
|
|
@@ -4279,7 +4522,8 @@
|
|
|
4279
4522
|
],
|
|
4280
4523
|
"requiresAccessibleName": false
|
|
4281
4524
|
},
|
|
4282
|
-
"since": "0.3.0"
|
|
4525
|
+
"since": "0.3.0",
|
|
4526
|
+
"example": "import { ProfileCard } from '@sakaniui/react';\n\n<ProfileCard name=\"Name\" role=\"Role\" />"
|
|
4283
4527
|
},
|
|
4284
4528
|
{
|
|
4285
4529
|
"name": "Progress",
|
|
@@ -4322,7 +4566,8 @@
|
|
|
4322
4566
|
"requiredProps": [],
|
|
4323
4567
|
"requiresAccessibleName": false
|
|
4324
4568
|
},
|
|
4325
|
-
"since": "0.1.0"
|
|
4569
|
+
"since": "0.1.0",
|
|
4570
|
+
"example": "import { Progress } from '@sakaniui/react';\n\n<Progress />"
|
|
4326
4571
|
},
|
|
4327
4572
|
{
|
|
4328
4573
|
"name": "ProgressItem",
|
|
@@ -4383,7 +4628,8 @@
|
|
|
4383
4628
|
],
|
|
4384
4629
|
"requiresAccessibleName": false
|
|
4385
4630
|
},
|
|
4386
|
-
"since": "0.1.0"
|
|
4631
|
+
"since": "0.1.0",
|
|
4632
|
+
"example": "import { ProgressItem } from '@sakaniui/react';\n\n<ProgressItem step={1} title=\"Title\" />"
|
|
4387
4633
|
},
|
|
4388
4634
|
{
|
|
4389
4635
|
"name": "ProgressStat",
|
|
@@ -4423,7 +4669,8 @@
|
|
|
4423
4669
|
],
|
|
4424
4670
|
"requiresAccessibleName": false
|
|
4425
4671
|
},
|
|
4426
|
-
"since": "0.1.0"
|
|
4672
|
+
"since": "0.1.0",
|
|
4673
|
+
"example": "import { ProgressStat } from '@sakaniui/react';\n\n<ProgressStat label=\"Label\" value=\"Value\" progress={50} />"
|
|
4427
4674
|
},
|
|
4428
4675
|
{
|
|
4429
4676
|
"name": "QuantitySelector",
|
|
@@ -4472,7 +4719,8 @@
|
|
|
4472
4719
|
],
|
|
4473
4720
|
"requiresAccessibleName": false
|
|
4474
4721
|
},
|
|
4475
|
-
"since": "0.3.0"
|
|
4722
|
+
"since": "0.3.0",
|
|
4723
|
+
"example": "import { QuantitySelector } from '@sakaniui/react';\n\n<QuantitySelector quantity={1} />"
|
|
4476
4724
|
},
|
|
4477
4725
|
{
|
|
4478
4726
|
"name": "RadarChart",
|
|
@@ -4536,7 +4784,8 @@
|
|
|
4536
4784
|
],
|
|
4537
4785
|
"requiresAccessibleName": false
|
|
4538
4786
|
},
|
|
4539
|
-
"since": "0.1.0"
|
|
4787
|
+
"since": "0.1.0",
|
|
4788
|
+
"example": "import { RadarChart } from '@sakaniui/react';\n\n<RadarChart data={[{ label: \"Label\", value: 50 }]} />"
|
|
4540
4789
|
},
|
|
4541
4790
|
{
|
|
4542
4791
|
"name": "RadialChart",
|
|
@@ -4600,7 +4849,8 @@
|
|
|
4600
4849
|
],
|
|
4601
4850
|
"requiresAccessibleName": false
|
|
4602
4851
|
},
|
|
4603
|
-
"since": "0.1.0"
|
|
4852
|
+
"since": "0.1.0",
|
|
4853
|
+
"example": "import { RadialChart } from '@sakaniui/react';\n\n<RadialChart data={[{ label: \"Label\", value: 50 }]} />"
|
|
4604
4854
|
},
|
|
4605
4855
|
{
|
|
4606
4856
|
"name": "Radio",
|
|
@@ -4624,7 +4874,8 @@
|
|
|
4624
4874
|
"requiredProps": [],
|
|
4625
4875
|
"requiresAccessibleName": false
|
|
4626
4876
|
},
|
|
4627
|
-
"since": "0.1.0"
|
|
4877
|
+
"since": "0.1.0",
|
|
4878
|
+
"example": "import { Radio } from '@sakaniui/react';\n\n<Radio />"
|
|
4628
4879
|
},
|
|
4629
4880
|
{
|
|
4630
4881
|
"name": "RichSeparator",
|
|
@@ -4655,7 +4906,8 @@
|
|
|
4655
4906
|
"requiredProps": [],
|
|
4656
4907
|
"requiresAccessibleName": false
|
|
4657
4908
|
},
|
|
4658
|
-
"since": "0.1.0"
|
|
4909
|
+
"since": "0.1.0",
|
|
4910
|
+
"example": "import { RichSeparator } from '@sakaniui/react';\n\n<RichSeparator />"
|
|
4659
4911
|
},
|
|
4660
4912
|
{
|
|
4661
4913
|
"name": "RichTextHeading",
|
|
@@ -4684,7 +4936,8 @@
|
|
|
4684
4936
|
"requiredProps": [],
|
|
4685
4937
|
"requiresAccessibleName": false
|
|
4686
4938
|
},
|
|
4687
|
-
"since": "0.3.0"
|
|
4939
|
+
"since": "0.3.0",
|
|
4940
|
+
"example": "import { RichTextHeading } from '@sakaniui/react';\n\n<RichTextHeading>Label</RichTextHeading>"
|
|
4688
4941
|
},
|
|
4689
4942
|
{
|
|
4690
4943
|
"name": "RichTextParagraph",
|
|
@@ -4703,7 +4956,8 @@
|
|
|
4703
4956
|
"requiredProps": [],
|
|
4704
4957
|
"requiresAccessibleName": false
|
|
4705
4958
|
},
|
|
4706
|
-
"since": "0.3.0"
|
|
4959
|
+
"since": "0.3.0",
|
|
4960
|
+
"example": "import { RichTextParagraph } from '@sakaniui/react';\n\n<RichTextParagraph>Label</RichTextParagraph>"
|
|
4707
4961
|
},
|
|
4708
4962
|
{
|
|
4709
4963
|
"name": "SectionHeading",
|
|
@@ -4763,7 +5017,8 @@
|
|
|
4763
5017
|
],
|
|
4764
5018
|
"requiresAccessibleName": false
|
|
4765
5019
|
},
|
|
4766
|
-
"since": "0.3.0"
|
|
5020
|
+
"since": "0.3.0",
|
|
5021
|
+
"example": "import { SectionHeading } from '@sakaniui/react';\n\n<SectionHeading title=\"Title\" />"
|
|
4767
5022
|
},
|
|
4768
5023
|
{
|
|
4769
5024
|
"name": "SegmentedControl",
|
|
@@ -4810,7 +5065,8 @@
|
|
|
4810
5065
|
],
|
|
4811
5066
|
"requiresAccessibleName": false
|
|
4812
5067
|
},
|
|
4813
|
-
"since": "0.1.0"
|
|
5068
|
+
"since": "0.1.0",
|
|
5069
|
+
"example": "import { SegmentedControl } from '@sakaniui/react';\n\n<SegmentedControl options={[{ value: \"Value\", label: \"Label\" }]} />"
|
|
4814
5070
|
},
|
|
4815
5071
|
{
|
|
4816
5072
|
"name": "Select",
|
|
@@ -4895,7 +5151,8 @@
|
|
|
4895
5151
|
],
|
|
4896
5152
|
"requiresAccessibleName": false
|
|
4897
5153
|
},
|
|
4898
|
-
"since": "0.1.0"
|
|
5154
|
+
"since": "0.1.0",
|
|
5155
|
+
"example": "import { Select } from '@sakaniui/react';\n\n<Select options={[{ label: \"Label\", value: \"Value\" }]} />"
|
|
4899
5156
|
},
|
|
4900
5157
|
{
|
|
4901
5158
|
"name": "Sidebar",
|
|
@@ -4920,7 +5177,8 @@
|
|
|
4920
5177
|
"requiredProps": [],
|
|
4921
5178
|
"requiresAccessibleName": false
|
|
4922
5179
|
},
|
|
4923
|
-
"since": "0.1.0"
|
|
5180
|
+
"since": "0.1.0",
|
|
5181
|
+
"example": "import { Sidebar } from '@sakaniui/react';\n\n<Sidebar>Label</Sidebar>"
|
|
4924
5182
|
},
|
|
4925
5183
|
{
|
|
4926
5184
|
"name": "SidebarDivider",
|
|
@@ -4933,7 +5191,8 @@
|
|
|
4933
5191
|
"requiredProps": [],
|
|
4934
5192
|
"requiresAccessibleName": false
|
|
4935
5193
|
},
|
|
4936
|
-
"since": "0.1.0"
|
|
5194
|
+
"since": "0.1.0",
|
|
5195
|
+
"example": "import { SidebarDivider } from '@sakaniui/react';\n\n<SidebarDivider />"
|
|
4937
5196
|
},
|
|
4938
5197
|
{
|
|
4939
5198
|
"name": "SidebarFooter",
|
|
@@ -4995,7 +5254,8 @@
|
|
|
4995
5254
|
"requiredProps": [],
|
|
4996
5255
|
"requiresAccessibleName": false
|
|
4997
5256
|
},
|
|
4998
|
-
"since": "0.1.0"
|
|
5257
|
+
"since": "0.1.0",
|
|
5258
|
+
"example": "import { SidebarFooter } from '@sakaniui/react';\n\n<SidebarFooter />"
|
|
4999
5259
|
},
|
|
5000
5260
|
{
|
|
5001
5261
|
"name": "SidebarGroupLabel",
|
|
@@ -5008,7 +5268,8 @@
|
|
|
5008
5268
|
"requiredProps": [],
|
|
5009
5269
|
"requiresAccessibleName": false
|
|
5010
5270
|
},
|
|
5011
|
-
"since": "0.1.0"
|
|
5271
|
+
"since": "0.1.0",
|
|
5272
|
+
"example": "import { SidebarGroupLabel } from '@sakaniui/react';\n\n<SidebarGroupLabel>Label</SidebarGroupLabel>"
|
|
5012
5273
|
},
|
|
5013
5274
|
{
|
|
5014
5275
|
"name": "SidebarHeader",
|
|
@@ -5067,7 +5328,8 @@
|
|
|
5067
5328
|
],
|
|
5068
5329
|
"requiresAccessibleName": false
|
|
5069
5330
|
},
|
|
5070
|
-
"since": "0.1.0"
|
|
5331
|
+
"since": "0.1.0",
|
|
5332
|
+
"example": "import { SidebarHeader } from '@sakaniui/react';\n\n<SidebarHeader title=\"Title\" />"
|
|
5071
5333
|
},
|
|
5072
5334
|
{
|
|
5073
5335
|
"name": "SidebarItem",
|
|
@@ -5122,7 +5384,8 @@
|
|
|
5122
5384
|
"name": "expanded",
|
|
5123
5385
|
"type": "boolean",
|
|
5124
5386
|
"required": false,
|
|
5125
|
-
"description": "Only matters when `hasSubmenu`. Not a navigation disclosure like `active` — the caller owns the open/closed state and toggles this alongside conditionally rendering the children."
|
|
5387
|
+
"description": "Only matters when `hasSubmenu`. Not a navigation disclosure like `active` — the caller owns the open/closed state and toggles this alongside conditionally rendering the children.",
|
|
5388
|
+
"since": "0.3.27"
|
|
5126
5389
|
},
|
|
5127
5390
|
{
|
|
5128
5391
|
"name": "onClick",
|
|
@@ -5148,7 +5411,8 @@
|
|
|
5148
5411
|
],
|
|
5149
5412
|
"requiresAccessibleName": false
|
|
5150
5413
|
},
|
|
5151
|
-
"since": "0.1.0"
|
|
5414
|
+
"since": "0.1.0",
|
|
5415
|
+
"example": "import { SidebarItem } from '@sakaniui/react';\n\n<SidebarItem label=\"Label\" />"
|
|
5152
5416
|
},
|
|
5153
5417
|
{
|
|
5154
5418
|
"name": "SidebarPromo",
|
|
@@ -5205,7 +5469,8 @@
|
|
|
5205
5469
|
],
|
|
5206
5470
|
"requiresAccessibleName": false
|
|
5207
5471
|
},
|
|
5208
|
-
"since": "0.1.0"
|
|
5472
|
+
"since": "0.1.0",
|
|
5473
|
+
"example": "import { SidebarPromo } from '@sakaniui/react';\n\n<SidebarPromo title=\"Title\" />"
|
|
5209
5474
|
},
|
|
5210
5475
|
{
|
|
5211
5476
|
"name": "SidebarSearch",
|
|
@@ -5255,7 +5520,8 @@
|
|
|
5255
5520
|
"requiredProps": [],
|
|
5256
5521
|
"requiresAccessibleName": false
|
|
5257
5522
|
},
|
|
5258
|
-
"since": "0.1.0"
|
|
5523
|
+
"since": "0.1.0",
|
|
5524
|
+
"example": "import { SidebarSearch } from '@sakaniui/react';\n\n<SidebarSearch />"
|
|
5259
5525
|
},
|
|
5260
5526
|
{
|
|
5261
5527
|
"name": "SidebarSubItem",
|
|
@@ -5296,7 +5562,8 @@
|
|
|
5296
5562
|
],
|
|
5297
5563
|
"requiresAccessibleName": false
|
|
5298
5564
|
},
|
|
5299
|
-
"since": "0.1.0"
|
|
5565
|
+
"since": "0.1.0",
|
|
5566
|
+
"example": "import { SidebarSubItem } from '@sakaniui/react';\n\n<SidebarSubItem label=\"Label\" />"
|
|
5300
5567
|
},
|
|
5301
5568
|
{
|
|
5302
5569
|
"name": "SizeSelector",
|
|
@@ -5341,7 +5608,8 @@
|
|
|
5341
5608
|
],
|
|
5342
5609
|
"requiresAccessibleName": false
|
|
5343
5610
|
},
|
|
5344
|
-
"since": "0.3.0"
|
|
5611
|
+
"since": "0.3.0",
|
|
5612
|
+
"example": "import { SizeSelector } from '@sakaniui/react';\n\n<SizeSelector size=\"Size\" />"
|
|
5345
5613
|
},
|
|
5346
5614
|
{
|
|
5347
5615
|
"name": "Skeleton",
|
|
@@ -5383,7 +5651,8 @@
|
|
|
5383
5651
|
"requiredProps": [],
|
|
5384
5652
|
"requiresAccessibleName": false
|
|
5385
5653
|
},
|
|
5386
|
-
"since": "0.1.0"
|
|
5654
|
+
"since": "0.1.0",
|
|
5655
|
+
"example": "import { Skeleton } from '@sakaniui/react';\n\n<Skeleton />"
|
|
5387
5656
|
},
|
|
5388
5657
|
{
|
|
5389
5658
|
"name": "Slider",
|
|
@@ -5420,7 +5689,8 @@
|
|
|
5420
5689
|
"requiredProps": [],
|
|
5421
5690
|
"requiresAccessibleName": false
|
|
5422
5691
|
},
|
|
5423
|
-
"since": "0.1.0"
|
|
5692
|
+
"since": "0.1.0",
|
|
5693
|
+
"example": "import { Slider } from '@sakaniui/react';\n\n<Slider />"
|
|
5424
5694
|
},
|
|
5425
5695
|
{
|
|
5426
5696
|
"name": "SpendingBalance",
|
|
@@ -5464,7 +5734,8 @@
|
|
|
5464
5734
|
],
|
|
5465
5735
|
"requiresAccessibleName": false
|
|
5466
5736
|
},
|
|
5467
|
-
"since": "0.1.0"
|
|
5737
|
+
"since": "0.1.0",
|
|
5738
|
+
"example": "import { SpendingBalance } from '@sakaniui/react';\n\n<SpendingBalance spent={1} limit={1} />"
|
|
5468
5739
|
},
|
|
5469
5740
|
{
|
|
5470
5741
|
"name": "Spinner",
|
|
@@ -5501,7 +5772,8 @@
|
|
|
5501
5772
|
"requiredProps": [],
|
|
5502
5773
|
"requiresAccessibleName": false
|
|
5503
5774
|
},
|
|
5504
|
-
"since": "0.1.0"
|
|
5775
|
+
"since": "0.1.0",
|
|
5776
|
+
"example": "import { Spinner } from '@sakaniui/react';\n\n<Spinner />"
|
|
5505
5777
|
},
|
|
5506
5778
|
{
|
|
5507
5779
|
"name": "StarRating",
|
|
@@ -5557,7 +5829,8 @@
|
|
|
5557
5829
|
],
|
|
5558
5830
|
"requiresAccessibleName": false
|
|
5559
5831
|
},
|
|
5560
|
-
"since": "0.3.0"
|
|
5832
|
+
"since": "0.3.0",
|
|
5833
|
+
"example": "import { StarRating } from '@sakaniui/react';\n\n<StarRating rating={4} />"
|
|
5561
5834
|
},
|
|
5562
5835
|
{
|
|
5563
5836
|
"name": "StatCard",
|
|
@@ -5657,7 +5930,8 @@
|
|
|
5657
5930
|
],
|
|
5658
5931
|
"requiresAccessibleName": false
|
|
5659
5932
|
},
|
|
5660
|
-
"since": "0.1.0"
|
|
5933
|
+
"since": "0.1.0",
|
|
5934
|
+
"example": "import { StatCard } from '@sakaniui/react';\n\n<StatCard title=\"Title\" value=\"Value\" />"
|
|
5661
5935
|
},
|
|
5662
5936
|
{
|
|
5663
5937
|
"name": "Stepper",
|
|
@@ -5701,7 +5975,8 @@
|
|
|
5701
5975
|
],
|
|
5702
5976
|
"requiresAccessibleName": false
|
|
5703
5977
|
},
|
|
5704
|
-
"since": "0.1.0"
|
|
5978
|
+
"since": "0.1.0",
|
|
5979
|
+
"example": "import { Stepper } from '@sakaniui/react';\n\n<Stepper steps={[{ label: \"Label\" }]} current={1} />"
|
|
5705
5980
|
},
|
|
5706
5981
|
{
|
|
5707
5982
|
"name": "StepperStep",
|
|
@@ -5750,13 +6025,15 @@
|
|
|
5750
6025
|
"type": "number",
|
|
5751
6026
|
"required": false,
|
|
5752
6027
|
"default": 0,
|
|
5753
|
-
"description": "ms to wait before this step's state change plays (the stepper uses it to sequence a multi-step move)."
|
|
6028
|
+
"description": "ms to wait before this step's state change plays (the stepper uses it to sequence a multi-step move).",
|
|
6029
|
+
"since": "0.4.4"
|
|
5754
6030
|
},
|
|
5755
6031
|
{
|
|
5756
6032
|
"name": "fresh",
|
|
5757
6033
|
"type": "boolean",
|
|
5758
6034
|
"required": false,
|
|
5759
|
-
"description": "True while this step has just changed state: plays the check-draw / arrival ripple."
|
|
6035
|
+
"description": "True while this step has just changed state: plays the check-draw / arrival ripple.",
|
|
6036
|
+
"since": "0.4.4"
|
|
5760
6037
|
}
|
|
5761
6038
|
],
|
|
5762
6039
|
"contract": {
|
|
@@ -5767,7 +6044,8 @@
|
|
|
5767
6044
|
],
|
|
5768
6045
|
"requiresAccessibleName": false
|
|
5769
6046
|
},
|
|
5770
|
-
"since": "0.1.0"
|
|
6047
|
+
"since": "0.1.0",
|
|
6048
|
+
"example": "import { StepperStep } from '@sakaniui/react';\n\n<StepperStep index={0} state=\"completed\" label=\"Label\" />"
|
|
5771
6049
|
},
|
|
5772
6050
|
{
|
|
5773
6051
|
"name": "StockMarket",
|
|
@@ -5839,7 +6117,8 @@
|
|
|
5839
6117
|
],
|
|
5840
6118
|
"requiresAccessibleName": false
|
|
5841
6119
|
},
|
|
5842
|
-
"since": "0.1.0"
|
|
6120
|
+
"since": "0.1.0",
|
|
6121
|
+
"example": "import { StockMarket } from '@sakaniui/react';\n\n<StockMarket logo=\"/images/example.jpg\" symbol=\"Symbol\" name=\"Name\" price={49} change={{ amount: 49, percent: 50 }} />"
|
|
5843
6122
|
},
|
|
5844
6123
|
{
|
|
5845
6124
|
"name": "StockStatus",
|
|
@@ -5878,7 +6157,8 @@
|
|
|
5878
6157
|
],
|
|
5879
6158
|
"requiresAccessibleName": false
|
|
5880
6159
|
},
|
|
5881
|
-
"since": "0.3.0"
|
|
6160
|
+
"since": "0.3.0",
|
|
6161
|
+
"example": "import { StockStatus } from '@sakaniui/react';\n\n<StockStatus quantity={1} />"
|
|
5882
6162
|
},
|
|
5883
6163
|
{
|
|
5884
6164
|
"name": "SubFeature",
|
|
@@ -5932,7 +6212,8 @@
|
|
|
5932
6212
|
],
|
|
5933
6213
|
"requiresAccessibleName": false
|
|
5934
6214
|
},
|
|
5935
|
-
"since": "0.3.0"
|
|
6215
|
+
"since": "0.3.0",
|
|
6216
|
+
"example": "import { SubFeature } from '@sakaniui/react';\n\n<SubFeature icon=\"Icon\" title=\"Title\" description=\"Description\" />"
|
|
5936
6217
|
},
|
|
5937
6218
|
{
|
|
5938
6219
|
"name": "Switch",
|
|
@@ -5951,7 +6232,8 @@
|
|
|
5951
6232
|
"name": "description",
|
|
5952
6233
|
"type": "ReactNode",
|
|
5953
6234
|
"required": false,
|
|
5954
|
-
"description": "Help text under the label, left-aligned with it (not with the track), e.g. the current state of a controlled switch. Same pattern as Checkbox's description."
|
|
6235
|
+
"description": "Help text under the label, left-aligned with it (not with the track), e.g. the current state of a controlled switch. Same pattern as Checkbox's description.",
|
|
6236
|
+
"since": "0.3.28"
|
|
5955
6237
|
},
|
|
5956
6238
|
{
|
|
5957
6239
|
"name": "variant",
|
|
@@ -5962,14 +6244,16 @@
|
|
|
5962
6244
|
"stretch"
|
|
5963
6245
|
],
|
|
5964
6246
|
"default": "default",
|
|
5965
|
-
"description": "`stretch` adds a liquid motion: the thumb stretches as it travels, then settles to a circle. `default` is the plain switch."
|
|
6247
|
+
"description": "`stretch` adds a liquid motion: the thumb stretches as it travels, then settles to a circle. `default` is the plain switch.",
|
|
6248
|
+
"since": "0.8.4"
|
|
5966
6249
|
}
|
|
5967
6250
|
],
|
|
5968
6251
|
"contract": {
|
|
5969
6252
|
"requiredProps": [],
|
|
5970
6253
|
"requiresAccessibleName": false
|
|
5971
6254
|
},
|
|
5972
|
-
"since": "0.1.0"
|
|
6255
|
+
"since": "0.1.0",
|
|
6256
|
+
"example": "import { Switch } from '@sakaniui/react';\n\n<Switch />"
|
|
5973
6257
|
},
|
|
5974
6258
|
{
|
|
5975
6259
|
"name": "Table",
|
|
@@ -6035,7 +6319,8 @@
|
|
|
6035
6319
|
"stacked",
|
|
6036
6320
|
"auto"
|
|
6037
6321
|
],
|
|
6038
|
-
"default": "auto"
|
|
6322
|
+
"default": "auto",
|
|
6323
|
+
"since": "0.3.4"
|
|
6039
6324
|
},
|
|
6040
6325
|
{
|
|
6041
6326
|
"name": "className",
|
|
@@ -6050,7 +6335,8 @@
|
|
|
6050
6335
|
],
|
|
6051
6336
|
"requiresAccessibleName": false
|
|
6052
6337
|
},
|
|
6053
|
-
"since": "0.1.0"
|
|
6338
|
+
"since": "0.1.0",
|
|
6339
|
+
"example": "import { Table } from '@sakaniui/react';\n\n<Table columns={[]} rows={[{}]} />"
|
|
6054
6340
|
},
|
|
6055
6341
|
{
|
|
6056
6342
|
"name": "Tabs",
|
|
@@ -6107,7 +6393,8 @@
|
|
|
6107
6393
|
],
|
|
6108
6394
|
"requiresAccessibleName": false
|
|
6109
6395
|
},
|
|
6110
|
-
"since": "0.1.0"
|
|
6396
|
+
"since": "0.1.0",
|
|
6397
|
+
"example": "import { Tabs } from '@sakaniui/react';\n\n<Tabs items={[{ value: \"Value\", label: \"Label\" }]} />"
|
|
6111
6398
|
},
|
|
6112
6399
|
{
|
|
6113
6400
|
"name": "Tags",
|
|
@@ -6139,7 +6426,8 @@
|
|
|
6139
6426
|
],
|
|
6140
6427
|
"requiresAccessibleName": false
|
|
6141
6428
|
},
|
|
6142
|
-
"since": "0.1.0"
|
|
6429
|
+
"since": "0.1.0",
|
|
6430
|
+
"example": "import { Tags } from '@sakaniui/react';\n\n<Tags tags={[\"Tag\"]} />"
|
|
6143
6431
|
},
|
|
6144
6432
|
{
|
|
6145
6433
|
"name": "TeamCard",
|
|
@@ -6210,7 +6498,8 @@
|
|
|
6210
6498
|
],
|
|
6211
6499
|
"requiresAccessibleName": false
|
|
6212
6500
|
},
|
|
6213
|
-
"since": "0.3.0"
|
|
6501
|
+
"since": "0.3.0",
|
|
6502
|
+
"example": "import { TeamCard } from '@sakaniui/react';\n\n<TeamCard image=\"/images/example.jpg\" name=\"Name\" role=\"Role\" location=\"Location\" />"
|
|
6214
6503
|
},
|
|
6215
6504
|
{
|
|
6216
6505
|
"name": "Textarea",
|
|
@@ -6239,7 +6528,8 @@
|
|
|
6239
6528
|
"requiredProps": [],
|
|
6240
6529
|
"requiresAccessibleName": false
|
|
6241
6530
|
},
|
|
6242
|
-
"since": "0.1.0"
|
|
6531
|
+
"since": "0.1.0",
|
|
6532
|
+
"example": "import { Textarea } from '@sakaniui/react';\n\n<Textarea />"
|
|
6243
6533
|
},
|
|
6244
6534
|
{
|
|
6245
6535
|
"name": "Ticker",
|
|
@@ -6277,7 +6567,8 @@
|
|
|
6277
6567
|
],
|
|
6278
6568
|
"requiresAccessibleName": false
|
|
6279
6569
|
},
|
|
6280
|
-
"since": "0.1.0"
|
|
6570
|
+
"since": "0.1.0",
|
|
6571
|
+
"example": "import { Ticker } from '@sakaniui/react';\n\n<Ticker items={[{ symbol: \"Symbol\", changePercent: 50 }]} />"
|
|
6281
6572
|
},
|
|
6282
6573
|
{
|
|
6283
6574
|
"name": "Toast",
|
|
@@ -6323,7 +6614,8 @@
|
|
|
6323
6614
|
"requiredProps": [],
|
|
6324
6615
|
"requiresAccessibleName": false
|
|
6325
6616
|
},
|
|
6326
|
-
"since": "0.1.0"
|
|
6617
|
+
"since": "0.1.0",
|
|
6618
|
+
"example": "import { Toast } from '@sakaniui/react';\n\n<Toast />"
|
|
6327
6619
|
},
|
|
6328
6620
|
{
|
|
6329
6621
|
"name": "Tooltip",
|
|
@@ -6378,7 +6670,8 @@
|
|
|
6378
6670
|
],
|
|
6379
6671
|
"requiresAccessibleName": false
|
|
6380
6672
|
},
|
|
6381
|
-
"since": "0.1.0"
|
|
6673
|
+
"since": "0.1.0",
|
|
6674
|
+
"example": "import { Tooltip } from '@sakaniui/react';\n\n<Tooltip title=\"Title\">Label</Tooltip>"
|
|
6382
6675
|
},
|
|
6383
6676
|
{
|
|
6384
6677
|
"name": "TopBar",
|
|
@@ -6507,7 +6800,8 @@
|
|
|
6507
6800
|
"requiredProps": [],
|
|
6508
6801
|
"requiresAccessibleName": false
|
|
6509
6802
|
},
|
|
6510
|
-
"since": "0.1.0"
|
|
6803
|
+
"since": "0.1.0",
|
|
6804
|
+
"example": "import { TopBar } from '@sakaniui/react';\n\n<TopBar />"
|
|
6511
6805
|
},
|
|
6512
6806
|
{
|
|
6513
6807
|
"name": "TopBarMobile",
|
|
@@ -6570,7 +6864,8 @@
|
|
|
6570
6864
|
"requiredProps": [],
|
|
6571
6865
|
"requiresAccessibleName": false
|
|
6572
6866
|
},
|
|
6573
|
-
"since": "0.1.0"
|
|
6867
|
+
"since": "0.1.0",
|
|
6868
|
+
"example": "import { TopBarMobile } from '@sakaniui/react';\n\n<TopBarMobile />"
|
|
6574
6869
|
},
|
|
6575
6870
|
{
|
|
6576
6871
|
"name": "Transactions",
|
|
@@ -6613,7 +6908,8 @@
|
|
|
6613
6908
|
],
|
|
6614
6909
|
"requiresAccessibleName": false
|
|
6615
6910
|
},
|
|
6616
|
-
"since": "0.1.0"
|
|
6911
|
+
"since": "0.1.0",
|
|
6912
|
+
"example": "import { Transactions } from '@sakaniui/react';\n\n<Transactions transactions={[{ name: \"Name\", category: \"Category\", amount: 49, icon: \"Icon\" }]} />"
|
|
6617
6913
|
},
|
|
6618
6914
|
{
|
|
6619
6915
|
"name": "WishlistButton",
|
|
@@ -6650,7 +6946,8 @@
|
|
|
6650
6946
|
"requiredProps": [],
|
|
6651
6947
|
"requiresAccessibleName": false
|
|
6652
6948
|
},
|
|
6653
|
-
"since": "0.3.0"
|
|
6949
|
+
"since": "0.3.0",
|
|
6950
|
+
"example": "import { WishlistButton } from '@sakaniui/react';\n\n<WishlistButton />"
|
|
6654
6951
|
},
|
|
6655
6952
|
{
|
|
6656
6953
|
"name": "XIcon",
|
|
@@ -6670,7 +6967,8 @@
|
|
|
6670
6967
|
"requiredProps": [],
|
|
6671
6968
|
"requiresAccessibleName": false
|
|
6672
6969
|
},
|
|
6673
|
-
"since": "0.
|
|
6970
|
+
"since": "0.8.6",
|
|
6971
|
+
"example": "import { XIcon } from '@sakaniui/react';\n\n<XIcon />"
|
|
6674
6972
|
},
|
|
6675
6973
|
{
|
|
6676
6974
|
"name": "AccountOverviewBlock",
|
|
@@ -6699,7 +6997,8 @@
|
|
|
6699
6997
|
"requiredProps": [],
|
|
6700
6998
|
"requiresAccessibleName": false
|
|
6701
6999
|
},
|
|
6702
|
-
"since": "0.1.0"
|
|
7000
|
+
"since": "0.1.0",
|
|
7001
|
+
"example": "import { AccountOverviewBlock } from '@sakaniui/react/blocks';\n\n<AccountOverviewBlock />"
|
|
6703
7002
|
},
|
|
6704
7003
|
{
|
|
6705
7004
|
"name": "ActivityLogBlock",
|
|
@@ -6728,7 +7027,8 @@
|
|
|
6728
7027
|
"requiredProps": [],
|
|
6729
7028
|
"requiresAccessibleName": false
|
|
6730
7029
|
},
|
|
6731
|
-
"since": "0.1.0"
|
|
7030
|
+
"since": "0.1.0",
|
|
7031
|
+
"example": "import { ActivityLogBlock } from '@sakaniui/react/blocks';\n\n<ActivityLogBlock />"
|
|
6732
7032
|
},
|
|
6733
7033
|
{
|
|
6734
7034
|
"name": "AddCardFormBlock",
|
|
@@ -6770,7 +7070,8 @@
|
|
|
6770
7070
|
"requiredProps": [],
|
|
6771
7071
|
"requiresAccessibleName": false
|
|
6772
7072
|
},
|
|
6773
|
-
"since": "0.3.0"
|
|
7073
|
+
"since": "0.3.0",
|
|
7074
|
+
"example": "import { AddCardFormBlock } from '@sakaniui/react/blocks';\n\n<AddCardFormBlock />"
|
|
6774
7075
|
},
|
|
6775
7076
|
{
|
|
6776
7077
|
"name": "AppHeaderBlock",
|
|
@@ -6813,7 +7114,8 @@
|
|
|
6813
7114
|
],
|
|
6814
7115
|
"requiresAccessibleName": false
|
|
6815
7116
|
},
|
|
6816
|
-
"since": "0.1.0"
|
|
7117
|
+
"since": "0.1.0",
|
|
7118
|
+
"example": "import { AppHeaderBlock } from '@sakaniui/react/blocks';\n\n<AppHeaderBlock breadcrumbs={[{ label: \"Label\" }]} title=\"Title\" />"
|
|
6817
7119
|
},
|
|
6818
7120
|
{
|
|
6819
7121
|
"name": "BillingAddressBlock",
|
|
@@ -6860,7 +7162,8 @@
|
|
|
6860
7162
|
"requiredProps": [],
|
|
6861
7163
|
"requiresAccessibleName": false
|
|
6862
7164
|
},
|
|
6863
|
-
"since": "0.3.0"
|
|
7165
|
+
"since": "0.3.0",
|
|
7166
|
+
"example": "import { BillingAddressBlock } from '@sakaniui/react/blocks';\n\n<BillingAddressBlock />"
|
|
6864
7167
|
},
|
|
6865
7168
|
{
|
|
6866
7169
|
"name": "BillingHistoryBlock",
|
|
@@ -6892,7 +7195,8 @@
|
|
|
6892
7195
|
"requiredProps": [],
|
|
6893
7196
|
"requiresAccessibleName": false
|
|
6894
7197
|
},
|
|
6895
|
-
"since": "0.3.0"
|
|
7198
|
+
"since": "0.3.0",
|
|
7199
|
+
"example": "import { BillingHistoryBlock } from '@sakaniui/react/blocks';\n\n<BillingHistoryBlock />"
|
|
6896
7200
|
},
|
|
6897
7201
|
{
|
|
6898
7202
|
"name": "BlogListingBlock",
|
|
@@ -6942,7 +7246,8 @@
|
|
|
6942
7246
|
],
|
|
6943
7247
|
"requiresAccessibleName": false
|
|
6944
7248
|
},
|
|
6945
|
-
"since": "0.3.0"
|
|
7249
|
+
"since": "0.3.0",
|
|
7250
|
+
"example": "import { BlogListingBlock } from '@sakaniui/react/blocks';\n\n<BlogListingBlock title=\"Title\" featuredPost={{ image: \"/images/example.jpg\", title: \"Title\", excerpt: \"Excerpt\", author: { name: \"Name\", date: \"Oct 21, 2026\" } }} posts={[{ image: \"/images/example.jpg\", category: \"Category\", readTime: \"5 min read\", title: \"Title\", excerpt: \"Excerpt\", author: { name: \"Name\", date: \"Oct 21, 2026\" } }]} />"
|
|
6946
7251
|
},
|
|
6947
7252
|
{
|
|
6948
7253
|
"name": "CareersBlock",
|
|
@@ -6986,7 +7291,8 @@
|
|
|
6986
7291
|
],
|
|
6987
7292
|
"requiresAccessibleName": false
|
|
6988
7293
|
},
|
|
6989
|
-
"since": "0.3.0"
|
|
7294
|
+
"since": "0.3.0",
|
|
7295
|
+
"example": "import { CareersBlock } from '@sakaniui/react/blocks';\n\n<CareersBlock title=\"Title\" jobs={[{ description: \"Description\", title: \"Title\", department: \"Department\", employmentType: \"Employment type\", location: \"Location\" }]} />"
|
|
6990
7296
|
},
|
|
6991
7297
|
{
|
|
6992
7298
|
"name": "ChatInterfaceBlock",
|
|
@@ -7016,7 +7322,8 @@
|
|
|
7016
7322
|
"requiredProps": [],
|
|
7017
7323
|
"requiresAccessibleName": false
|
|
7018
7324
|
},
|
|
7019
|
-
"since": "0.1.0"
|
|
7325
|
+
"since": "0.1.0",
|
|
7326
|
+
"example": "import { ChatInterfaceBlock } from '@sakaniui/react/blocks';\n\n<ChatInterfaceBlock />"
|
|
7020
7327
|
},
|
|
7021
7328
|
{
|
|
7022
7329
|
"name": "CheckoutFlowBlock",
|
|
@@ -7068,7 +7375,8 @@
|
|
|
7068
7375
|
],
|
|
7069
7376
|
"requiresAccessibleName": false
|
|
7070
7377
|
},
|
|
7071
|
-
"since": "0.3.0"
|
|
7378
|
+
"since": "0.3.0",
|
|
7379
|
+
"example": "import { CheckoutFlowBlock } from '@sakaniui/react/blocks';\n\n<CheckoutFlowBlock items={[{ image: \"/images/example.jpg\", name: \"Name\", price: 49, quantity: 1 }]} />"
|
|
7072
7380
|
},
|
|
7073
7381
|
{
|
|
7074
7382
|
"name": "CRMDashboardBlock",
|
|
@@ -7086,14 +7394,16 @@
|
|
|
7086
7394
|
"name": "fillPlaceholders",
|
|
7087
7395
|
"type": "boolean",
|
|
7088
7396
|
"required": false,
|
|
7089
|
-
"description": "When the block is stretched taller than its real content (e.g. embedded in a fixed-height demo frame), extends the leads table with faint placeholder row dividers down to the bottom instead of leaving blank canvas below the footer. No-op at the block's natural height."
|
|
7397
|
+
"description": "When the block is stretched taller than its real content (e.g. embedded in a fixed-height demo frame), extends the leads table with faint placeholder row dividers down to the bottom instead of leaving blank canvas below the footer. No-op at the block's natural height.",
|
|
7398
|
+
"since": "0.3.3"
|
|
7090
7399
|
}
|
|
7091
7400
|
],
|
|
7092
7401
|
"contract": {
|
|
7093
7402
|
"requiredProps": [],
|
|
7094
7403
|
"requiresAccessibleName": false
|
|
7095
7404
|
},
|
|
7096
|
-
"since": "0.1.0"
|
|
7405
|
+
"since": "0.1.0",
|
|
7406
|
+
"example": "import { CRMDashboardBlock } from '@sakaniui/react/blocks';\n\n<CRMDashboardBlock />"
|
|
7097
7407
|
},
|
|
7098
7408
|
{
|
|
7099
7409
|
"name": "CtaBannerBlock",
|
|
@@ -7153,7 +7463,8 @@
|
|
|
7153
7463
|
],
|
|
7154
7464
|
"requiresAccessibleName": false
|
|
7155
7465
|
},
|
|
7156
|
-
"since": "0.3.0"
|
|
7466
|
+
"since": "0.3.0",
|
|
7467
|
+
"example": "import { CtaBannerBlock } from '@sakaniui/react/blocks';\n\n<CtaBannerBlock title=\"Title\" description=\"Description\" primaryAction={{ label: \"Label\" }} />"
|
|
7157
7468
|
},
|
|
7158
7469
|
{
|
|
7159
7470
|
"name": "CurrentPlanBlock",
|
|
@@ -7262,7 +7573,8 @@
|
|
|
7262
7573
|
],
|
|
7263
7574
|
"requiresAccessibleName": false
|
|
7264
7575
|
},
|
|
7265
|
-
"since": "0.3.0"
|
|
7576
|
+
"since": "0.3.0",
|
|
7577
|
+
"example": "import { CurrentPlanBlock } from '@sakaniui/react/blocks';\n\n<CurrentPlanBlock planName=\"Plan name\" price=\"Price\" />"
|
|
7266
7578
|
},
|
|
7267
7579
|
{
|
|
7268
7580
|
"name": "DataTableBlock",
|
|
@@ -7294,14 +7606,16 @@
|
|
|
7294
7606
|
"name": "fillPlaceholders",
|
|
7295
7607
|
"type": "boolean",
|
|
7296
7608
|
"required": false,
|
|
7297
|
-
"description": "When the block is stretched taller than its real content (e.g. embedded in a fixed-height demo frame), extends the table with faint placeholder row dividers down to the bottom instead of leaving blank canvas below the footer. No-op at the block's natural height."
|
|
7609
|
+
"description": "When the block is stretched taller than its real content (e.g. embedded in a fixed-height demo frame), extends the table with faint placeholder row dividers down to the bottom instead of leaving blank canvas below the footer. No-op at the block's natural height.",
|
|
7610
|
+
"since": "0.3.3"
|
|
7298
7611
|
}
|
|
7299
7612
|
],
|
|
7300
7613
|
"contract": {
|
|
7301
7614
|
"requiredProps": [],
|
|
7302
7615
|
"requiresAccessibleName": false
|
|
7303
7616
|
},
|
|
7304
|
-
"since": "0.1.0"
|
|
7617
|
+
"since": "0.1.0",
|
|
7618
|
+
"example": "import { DataTableBlock } from '@sakaniui/react/blocks';\n\n<DataTableBlock />"
|
|
7305
7619
|
},
|
|
7306
7620
|
{
|
|
7307
7621
|
"name": "EmailVerificationBlock",
|
|
@@ -7351,7 +7665,8 @@
|
|
|
7351
7665
|
"requiredProps": [],
|
|
7352
7666
|
"requiresAccessibleName": false
|
|
7353
7667
|
},
|
|
7354
|
-
"since": "0.3.0"
|
|
7668
|
+
"since": "0.3.0",
|
|
7669
|
+
"example": "import { EmailVerificationBlock } from '@sakaniui/react/blocks';\n\n<EmailVerificationBlock />"
|
|
7355
7670
|
},
|
|
7356
7671
|
{
|
|
7357
7672
|
"name": "FaqBlock",
|
|
@@ -7399,7 +7714,8 @@
|
|
|
7399
7714
|
],
|
|
7400
7715
|
"requiresAccessibleName": false
|
|
7401
7716
|
},
|
|
7402
|
-
"since": "0.3.0"
|
|
7717
|
+
"since": "0.3.0",
|
|
7718
|
+
"example": "import { FaqBlock } from '@sakaniui/react/blocks';\n\n<FaqBlock title=\"Title\" items={[{ question: \"Question\", answer: \"Answer\" }]} />"
|
|
7403
7719
|
},
|
|
7404
7720
|
{
|
|
7405
7721
|
"name": "FeatureGridBlock",
|
|
@@ -7431,7 +7747,8 @@
|
|
|
7431
7747
|
],
|
|
7432
7748
|
"requiresAccessibleName": false
|
|
7433
7749
|
},
|
|
7434
|
-
"since": "0.3.0"
|
|
7750
|
+
"since": "0.3.0",
|
|
7751
|
+
"example": "import { FeatureGridBlock } from '@sakaniui/react/blocks';\n\n<FeatureGridBlock features={[{ icon: \"Icon\", title: \"Title\", description: \"Description\" }]} />"
|
|
7435
7752
|
},
|
|
7436
7753
|
{
|
|
7437
7754
|
"name": "FileUploadPanelBlock",
|
|
@@ -7461,7 +7778,8 @@
|
|
|
7461
7778
|
"requiredProps": [],
|
|
7462
7779
|
"requiresAccessibleName": false
|
|
7463
7780
|
},
|
|
7464
|
-
"since": "0.1.0"
|
|
7781
|
+
"since": "0.1.0",
|
|
7782
|
+
"example": "import { FileUploadPanelBlock } from '@sakaniui/react/blocks';\n\n<FileUploadPanelBlock />"
|
|
7465
7783
|
},
|
|
7466
7784
|
{
|
|
7467
7785
|
"name": "ForgotPasswordBlock",
|
|
@@ -7515,7 +7833,8 @@
|
|
|
7515
7833
|
"requiredProps": [],
|
|
7516
7834
|
"requiresAccessibleName": false
|
|
7517
7835
|
},
|
|
7518
|
-
"since": "0.3.0"
|
|
7836
|
+
"since": "0.3.0",
|
|
7837
|
+
"example": "import { ForgotPasswordBlock } from '@sakaniui/react/blocks';\n\n<ForgotPasswordBlock />"
|
|
7519
7838
|
},
|
|
7520
7839
|
{
|
|
7521
7840
|
"name": "FormModalBlock",
|
|
@@ -7547,7 +7866,8 @@
|
|
|
7547
7866
|
],
|
|
7548
7867
|
"requiresAccessibleName": false
|
|
7549
7868
|
},
|
|
7550
|
-
"since": "0.1.0"
|
|
7869
|
+
"since": "0.1.0",
|
|
7870
|
+
"example": "import { FormModalBlock } from '@sakaniui/react/blocks';\n\n<FormModalBlock open={true} onClose={() => {}} />"
|
|
7551
7871
|
},
|
|
7552
7872
|
{
|
|
7553
7873
|
"name": "HeroBlock",
|
|
@@ -7636,7 +7956,8 @@
|
|
|
7636
7956
|
],
|
|
7637
7957
|
"requiresAccessibleName": false
|
|
7638
7958
|
},
|
|
7639
|
-
"since": "0.3.0"
|
|
7959
|
+
"since": "0.3.0",
|
|
7960
|
+
"example": "import { HeroBlock } from '@sakaniui/react/blocks';\n\n<HeroBlock title=\"Title\" description=\"Description\" primaryAction={{ label: \"Label\" }} image=\"/images/example.jpg\" />"
|
|
7640
7961
|
},
|
|
7641
7962
|
{
|
|
7642
7963
|
"name": "InlineCtaBlock",
|
|
@@ -7694,7 +8015,8 @@
|
|
|
7694
8015
|
],
|
|
7695
8016
|
"requiresAccessibleName": false
|
|
7696
8017
|
},
|
|
7697
|
-
"since": "0.1.0"
|
|
8018
|
+
"since": "0.1.0",
|
|
8019
|
+
"example": "import { InlineCtaBlock } from '@sakaniui/react/blocks';\n\n<InlineCtaBlock title=\"Title\" description=\"Description\" actionLabel=\"Action label\" />"
|
|
7698
8020
|
},
|
|
7699
8021
|
{
|
|
7700
8022
|
"name": "KanbanBoardBlock",
|
|
@@ -7724,14 +8046,16 @@
|
|
|
7724
8046
|
"name": "fillPlaceholders",
|
|
7725
8047
|
"type": "boolean",
|
|
7726
8048
|
"required": false,
|
|
7727
|
-
"description": "When the board is stretched taller than its real content (e.g. embedded in a fixed-height demo frame), stretches every column to equal height and caps off its real cards with a dashed placeholder slot down to the bottom instead of leaving blank canvas. No-op at the board's natural height."
|
|
8049
|
+
"description": "When the board is stretched taller than its real content (e.g. embedded in a fixed-height demo frame), stretches every column to equal height and caps off its real cards with a dashed placeholder slot down to the bottom instead of leaving blank canvas. No-op at the board's natural height.",
|
|
8050
|
+
"since": "0.3.3"
|
|
7728
8051
|
}
|
|
7729
8052
|
],
|
|
7730
8053
|
"contract": {
|
|
7731
8054
|
"requiredProps": [],
|
|
7732
8055
|
"requiresAccessibleName": false
|
|
7733
8056
|
},
|
|
7734
|
-
"since": "0.1.0"
|
|
8057
|
+
"since": "0.1.0",
|
|
8058
|
+
"example": "import { KanbanBoardBlock } from '@sakaniui/react/blocks';\n\n<KanbanBoardBlock />"
|
|
7735
8059
|
},
|
|
7736
8060
|
{
|
|
7737
8061
|
"name": "LiquidDashboardBlock",
|
|
@@ -7770,7 +8094,8 @@
|
|
|
7770
8094
|
],
|
|
7771
8095
|
"requiresAccessibleName": false
|
|
7772
8096
|
},
|
|
7773
|
-
"since": "0.4.0"
|
|
8097
|
+
"since": "0.4.0",
|
|
8098
|
+
"example": "import { LiquidDashboardBlock } from '@sakaniui/react/blocks';\n\n<LiquidDashboardBlock backgroundImage=\"/images/example.jpg\" />"
|
|
7774
8099
|
},
|
|
7775
8100
|
{
|
|
7776
8101
|
"name": "LoginBlock",
|
|
@@ -7829,7 +8154,8 @@
|
|
|
7829
8154
|
"requiredProps": [],
|
|
7830
8155
|
"requiresAccessibleName": false
|
|
7831
8156
|
},
|
|
7832
|
-
"since": "0.3.0"
|
|
8157
|
+
"since": "0.3.0",
|
|
8158
|
+
"example": "import { LoginBlock } from '@sakaniui/react/blocks';\n\n<LoginBlock />"
|
|
7833
8159
|
},
|
|
7834
8160
|
{
|
|
7835
8161
|
"name": "LogoCloudBlock",
|
|
@@ -7869,7 +8195,8 @@
|
|
|
7869
8195
|
"requiredProps": [],
|
|
7870
8196
|
"requiresAccessibleName": false
|
|
7871
8197
|
},
|
|
7872
|
-
"since": "0.3.0"
|
|
8198
|
+
"since": "0.3.0",
|
|
8199
|
+
"example": "import { LogoCloudBlock } from '@sakaniui/react/blocks';\n\n<LogoCloudBlock />"
|
|
7873
8200
|
},
|
|
7874
8201
|
{
|
|
7875
8202
|
"name": "MultistepModalBlock",
|
|
@@ -7908,7 +8235,8 @@
|
|
|
7908
8235
|
],
|
|
7909
8236
|
"requiresAccessibleName": false
|
|
7910
8237
|
},
|
|
7911
|
-
"since": "0.1.0"
|
|
8238
|
+
"since": "0.1.0",
|
|
8239
|
+
"example": "import { MultistepModalBlock } from '@sakaniui/react/blocks';\n\n<MultistepModalBlock open={true} onClose={() => {}} />"
|
|
7912
8240
|
},
|
|
7913
8241
|
{
|
|
7914
8242
|
"name": "NotificationPanelBlock",
|
|
@@ -7939,7 +8267,8 @@
|
|
|
7939
8267
|
],
|
|
7940
8268
|
"requiresAccessibleName": false
|
|
7941
8269
|
},
|
|
7942
|
-
"since": "0.1.0"
|
|
8270
|
+
"since": "0.1.0",
|
|
8271
|
+
"example": "import { NotificationPanelBlock } from '@sakaniui/react/blocks';\n\n<NotificationPanelBlock items={[{ id: \"item-1\", title: \"Title\", timestamp: \"2 min ago\" }]} />"
|
|
7943
8272
|
},
|
|
7944
8273
|
{
|
|
7945
8274
|
"name": "OnboardingProgressBlock",
|
|
@@ -7981,7 +8310,8 @@
|
|
|
7981
8310
|
],
|
|
7982
8311
|
"requiresAccessibleName": false
|
|
7983
8312
|
},
|
|
7984
|
-
"since": "0.3.0"
|
|
8313
|
+
"since": "0.3.0",
|
|
8314
|
+
"example": "import { OnboardingProgressBlock } from '@sakaniui/react/blocks';\n\n<OnboardingProgressBlock items={[{ label: \"Label\", progress: 50 }]} />"
|
|
7985
8315
|
},
|
|
7986
8316
|
{
|
|
7987
8317
|
"name": "OrderConfirmationBlock",
|
|
@@ -8040,7 +8370,8 @@
|
|
|
8040
8370
|
],
|
|
8041
8371
|
"requiresAccessibleName": false
|
|
8042
8372
|
},
|
|
8043
|
-
"since": "0.3.0"
|
|
8373
|
+
"since": "0.3.0",
|
|
8374
|
+
"example": "import { OrderConfirmationBlock } from '@sakaniui/react/blocks';\n\n<OrderConfirmationBlock orderNumber=\"Order number\" items={[{ image: \"/images/example.jpg\", name: \"Name\", price: 49 }]} total={49} />"
|
|
8044
8375
|
},
|
|
8045
8376
|
{
|
|
8046
8377
|
"name": "PaymentMethodBlock",
|
|
@@ -8082,7 +8413,8 @@
|
|
|
8082
8413
|
"requiredProps": [],
|
|
8083
8414
|
"requiresAccessibleName": false
|
|
8084
8415
|
},
|
|
8085
|
-
"since": "0.3.0"
|
|
8416
|
+
"since": "0.3.0",
|
|
8417
|
+
"example": "import { PaymentMethodBlock } from '@sakaniui/react/blocks';\n\n<PaymentMethodBlock />"
|
|
8086
8418
|
},
|
|
8087
8419
|
{
|
|
8088
8420
|
"name": "PricingTableBlock",
|
|
@@ -8126,7 +8458,8 @@
|
|
|
8126
8458
|
],
|
|
8127
8459
|
"requiresAccessibleName": false
|
|
8128
8460
|
},
|
|
8129
|
-
"since": "0.3.0"
|
|
8461
|
+
"since": "0.3.0",
|
|
8462
|
+
"example": "import { PricingTableBlock } from '@sakaniui/react/blocks';\n\n<PricingTableBlock title=\"Title\" plans={[{ name: \"Name\", price: \"Price\", description: \"Description\", ctaLabel: \"Cta label\", features: [\"Feature\"] }]} />"
|
|
8130
8463
|
},
|
|
8131
8464
|
{
|
|
8132
8465
|
"name": "ProductDetailBlock",
|
|
@@ -8242,7 +8575,8 @@
|
|
|
8242
8575
|
],
|
|
8243
8576
|
"requiresAccessibleName": false
|
|
8244
8577
|
},
|
|
8245
|
-
"since": "0.3.0"
|
|
8578
|
+
"since": "0.3.0",
|
|
8579
|
+
"example": "import { ProductDetailBlock } from '@sakaniui/react/blocks';\n\n<ProductDetailBlock name=\"Name\" images={[{ src: \"/images/example.jpg\" }]} rating={4} stockQuantity={1} price={49} description=\"Description\" />"
|
|
8246
8580
|
},
|
|
8247
8581
|
{
|
|
8248
8582
|
"name": "ProductGridBlock",
|
|
@@ -8311,7 +8645,8 @@
|
|
|
8311
8645
|
],
|
|
8312
8646
|
"requiresAccessibleName": false
|
|
8313
8647
|
},
|
|
8314
|
-
"since": "0.3.0"
|
|
8648
|
+
"since": "0.3.0",
|
|
8649
|
+
"example": "import { ProductGridBlock } from '@sakaniui/react/blocks';\n\n<ProductGridBlock title=\"Title\" products={[{ image: \"/images/example.jpg\", name: \"Name\", price: 49 }]} />"
|
|
8315
8650
|
},
|
|
8316
8651
|
{
|
|
8317
8652
|
"name": "ProfileSettingsBlock",
|
|
@@ -8352,7 +8687,8 @@
|
|
|
8352
8687
|
"requiredProps": [],
|
|
8353
8688
|
"requiresAccessibleName": false
|
|
8354
8689
|
},
|
|
8355
|
-
"since": "0.1.0"
|
|
8690
|
+
"since": "0.1.0",
|
|
8691
|
+
"example": "import { ProfileSettingsBlock } from '@sakaniui/react/blocks';\n\n<ProfileSettingsBlock />"
|
|
8356
8692
|
},
|
|
8357
8693
|
{
|
|
8358
8694
|
"name": "ResetPasswordBlock",
|
|
@@ -8400,7 +8736,8 @@
|
|
|
8400
8736
|
"requiredProps": [],
|
|
8401
8737
|
"requiresAccessibleName": false
|
|
8402
8738
|
},
|
|
8403
|
-
"since": "0.3.0"
|
|
8739
|
+
"since": "0.3.0",
|
|
8740
|
+
"example": "import { ResetPasswordBlock } from '@sakaniui/react/blocks';\n\n<ResetPasswordBlock />"
|
|
8404
8741
|
},
|
|
8405
8742
|
{
|
|
8406
8743
|
"name": "SectionFooterBlock",
|
|
@@ -8440,7 +8777,8 @@
|
|
|
8440
8777
|
"requiredProps": [],
|
|
8441
8778
|
"requiresAccessibleName": false
|
|
8442
8779
|
},
|
|
8443
|
-
"since": "0.3.0"
|
|
8780
|
+
"since": "0.3.0",
|
|
8781
|
+
"example": "import { SectionFooterBlock } from '@sakaniui/react/blocks';\n\n<SectionFooterBlock />"
|
|
8444
8782
|
},
|
|
8445
8783
|
{
|
|
8446
8784
|
"name": "ShoppingCartBlock",
|
|
@@ -8487,7 +8825,8 @@
|
|
|
8487
8825
|
],
|
|
8488
8826
|
"requiresAccessibleName": false
|
|
8489
8827
|
},
|
|
8490
|
-
"since": "0.3.0"
|
|
8828
|
+
"since": "0.3.0",
|
|
8829
|
+
"example": "import { ShoppingCartBlock } from '@sakaniui/react/blocks';\n\n<ShoppingCartBlock items={[{ image: \"/images/example.jpg\", name: \"Name\", price: 49, quantity: 1 }]} />"
|
|
8491
8830
|
},
|
|
8492
8831
|
{
|
|
8493
8832
|
"name": "SignUpBlock",
|
|
@@ -8535,7 +8874,8 @@
|
|
|
8535
8874
|
"requiredProps": [],
|
|
8536
8875
|
"requiresAccessibleName": false
|
|
8537
8876
|
},
|
|
8538
|
-
"since": "0.3.0"
|
|
8877
|
+
"since": "0.3.0",
|
|
8878
|
+
"example": "import { SignUpBlock } from '@sakaniui/react/blocks';\n\n<SignUpBlock />"
|
|
8539
8879
|
},
|
|
8540
8880
|
{
|
|
8541
8881
|
"name": "TeamSectionBlock",
|
|
@@ -8579,7 +8919,8 @@
|
|
|
8579
8919
|
],
|
|
8580
8920
|
"requiresAccessibleName": false
|
|
8581
8921
|
},
|
|
8582
|
-
"since": "0.3.0"
|
|
8922
|
+
"since": "0.3.0",
|
|
8923
|
+
"example": "import { TeamSectionBlock } from '@sakaniui/react/blocks';\n\n<TeamSectionBlock title=\"Title\" members={[{ name: \"Name\", role: \"Role\", location: \"Location\", image: \"/images/example.jpg\" }]} />"
|
|
8583
8924
|
},
|
|
8584
8925
|
{
|
|
8585
8926
|
"name": "TestimonialBlock",
|
|
@@ -8605,7 +8946,8 @@
|
|
|
8605
8946
|
],
|
|
8606
8947
|
"requiresAccessibleName": false
|
|
8607
8948
|
},
|
|
8608
|
-
"since": "0.3.0"
|
|
8949
|
+
"since": "0.3.0",
|
|
8950
|
+
"example": "import { TestimonialBlock } from '@sakaniui/react/blocks';\n\n<TestimonialBlock testimonials={[{ quote: \"Quote\", authorName: \"Author name\", authorRole: \"Author role\" }]} />"
|
|
8609
8951
|
},
|
|
8610
8952
|
{
|
|
8611
8953
|
"name": "TwoFactorAuthBlock",
|
|
@@ -8649,39 +8991,46 @@
|
|
|
8649
8991
|
"requiredProps": [],
|
|
8650
8992
|
"requiresAccessibleName": false
|
|
8651
8993
|
},
|
|
8652
|
-
"since": "0.3.0"
|
|
8994
|
+
"since": "0.3.0",
|
|
8995
|
+
"example": "import { TwoFactorAuthBlock } from '@sakaniui/react/blocks';\n\n<TwoFactorAuthBlock />"
|
|
8653
8996
|
}
|
|
8654
8997
|
],
|
|
8655
8998
|
"utilities": [
|
|
8656
8999
|
{
|
|
8657
9000
|
"name": "DEFAULT_CHECKOUT_STEPS",
|
|
8658
9001
|
"kind": "constant",
|
|
8659
|
-
"import": "@sakaniui/react"
|
|
9002
|
+
"import": "@sakaniui/react",
|
|
9003
|
+
"since": "0.3.0"
|
|
8660
9004
|
},
|
|
8661
9005
|
{
|
|
8662
9006
|
"name": "getContrastColor",
|
|
8663
9007
|
"kind": "helper",
|
|
8664
|
-
"import": "@sakaniui/react"
|
|
9008
|
+
"import": "@sakaniui/react",
|
|
9009
|
+
"since": "0.3.0"
|
|
8665
9010
|
},
|
|
8666
9011
|
{
|
|
8667
9012
|
"name": "iconStrokeWidth",
|
|
8668
9013
|
"kind": "helper",
|
|
8669
|
-
"import": "@sakaniui/react"
|
|
9014
|
+
"import": "@sakaniui/react",
|
|
9015
|
+
"since": "0.3.0"
|
|
8670
9016
|
},
|
|
8671
9017
|
{
|
|
8672
9018
|
"name": "syncLiquidBackdrop",
|
|
8673
9019
|
"kind": "helper",
|
|
8674
|
-
"import": "@sakaniui/react"
|
|
9020
|
+
"import": "@sakaniui/react",
|
|
9021
|
+
"since": "0.4.3"
|
|
8675
9022
|
},
|
|
8676
9023
|
{
|
|
8677
9024
|
"name": "useHoverHighlight",
|
|
8678
9025
|
"kind": "hook",
|
|
8679
|
-
"import": "@sakaniui/react"
|
|
9026
|
+
"import": "@sakaniui/react",
|
|
9027
|
+
"since": "0.3.21"
|
|
8680
9028
|
},
|
|
8681
9029
|
{
|
|
8682
9030
|
"name": "useLiquidGlass",
|
|
8683
9031
|
"kind": "hook",
|
|
8684
|
-
"import": "@sakaniui/react"
|
|
9032
|
+
"import": "@sakaniui/react",
|
|
9033
|
+
"since": "0.4.0"
|
|
8685
9034
|
}
|
|
8686
9035
|
]
|
|
8687
9036
|
}
|