@inkbar/react 0.9.0 → 0.10.0
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/README.md +64 -3
- package/dist/index.d.mts +292 -3
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +826 -32
- package/dist/index.mjs.map +1 -1
- package/package.json +5 -5
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ComponentPropsWithoutRef, ReactNode, Ref } from "react";
|
|
2
|
-
import { Annotation, AnnotationChange, AnnotationDefaults, AnnotationDocument, AnnotationInput, AnnotationPatch, CurrentStyle, DocumentSource, FieldValues, FieldsChange, FormAction, FormField, FormSetResult, ImportOptions, InkDocument, InkError, InkStatus, PageInfo, PdfAssets, PluginHistory, Readable, SignatureLibrary, SignatureStore, SignatureTemplate, StyleGroup, StyleKey, StyleProps, Writable } from "@inkbar/core";
|
|
3
|
-
import { AnnotationDecoration, AnnotationSlotProps, AnnotationSlotProps as AnnotationSlotProps$1, AnnotationState, ColorProperty, DecorateAnnotation, DecorateAnnotation as DecorateAnnotation$1, InkPlugin, InkPlugin as InkPlugin$1, LayoutMode, PageMount, PluginHost, SearchController, SearchState, ThreadPopoverSlotProps, ThreadPopoverSlotProps as ThreadPopoverSlotProps$1, Tool, ToolController, ToolId, ToolOptions, ToolStyle, ViewRotation, ViewerSearch, Viewport, ZoomValue } from "@inkbar/core/dom";
|
|
2
|
+
import { Annotation, AnnotationChange, AnnotationDefaults, AnnotationDocument, AnnotationInput, AnnotationPatch, CurrentStyle, DocumentSource, FieldValues, FieldsChange, FormAction, FormField, FormSetResult, ImportOptions, InkDocument, InkError, InkStatus, PageInfo, PdfAssets, PluginHistory, Readable, RecordBase, SignatureLibrary, SignatureStore, SignatureTemplate, StyleGroup, StyleKey, StyleProps, Writable } from "@inkbar/core";
|
|
3
|
+
import { AnnotationDecoration, AnnotationSlotProps, AnnotationSlotProps as AnnotationSlotProps$1, AnnotationState, CardSpec, CardSpec as CardSpec$1, ColorProperty, DecorateAnnotation, DecorateAnnotation as DecorateAnnotation$1, HostRecords, HostRecords as HostRecords$1, InkPlugin, InkPlugin as InkPlugin$1, LayoutMode, PageMount, PluginHost, RecordListSource, SearchController, SearchState, SidebarLayout, SidebarLayout as SidebarLayout$1, SidebarOpen, SidebarOpen as SidebarOpen$1, SidebarSide, SidebarSide as SidebarSide$1, ThreadPopoverSlotProps, ThreadPopoverSlotProps as ThreadPopoverSlotProps$1, Tool, ToolController, ToolId, ToolOptions, ToolStyle, ViewRotation, ViewerSearch, Viewport, ZoomValue } from "@inkbar/core/dom";
|
|
4
4
|
import { Select, Toolbar } from "radix-ui";
|
|
5
5
|
import { IconNode } from "@inkbar/icons";
|
|
6
6
|
//#region src/context.d.ts
|
|
@@ -163,6 +163,7 @@ export declare function useAnnotations(): {
|
|
|
163
163
|
id: string;
|
|
164
164
|
page: number;
|
|
165
165
|
locked?: boolean | undefined;
|
|
166
|
+
hasAppearance?: boolean | undefined;
|
|
166
167
|
author?: string | undefined;
|
|
167
168
|
contents?: string | undefined;
|
|
168
169
|
inReplyTo?: string | undefined;
|
|
@@ -186,6 +187,7 @@ export declare function useAnnotations(): {
|
|
|
186
187
|
page: number;
|
|
187
188
|
type: "text";
|
|
188
189
|
locked?: boolean | undefined;
|
|
190
|
+
hasAppearance?: boolean | undefined;
|
|
189
191
|
author?: string | undefined;
|
|
190
192
|
contents?: string | undefined;
|
|
191
193
|
inReplyTo?: string | undefined;
|
|
@@ -234,6 +236,7 @@ export declare function useAnnotations(): {
|
|
|
234
236
|
fontSize?: undefined;
|
|
235
237
|
align?: undefined;
|
|
236
238
|
locked?: boolean | undefined;
|
|
239
|
+
hasAppearance?: boolean | undefined;
|
|
237
240
|
dashes?: number[] | undefined;
|
|
238
241
|
cornerRadius?: number | undefined;
|
|
239
242
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -259,6 +262,7 @@ export declare function useAnnotations(): {
|
|
|
259
262
|
page: number;
|
|
260
263
|
type: "square";
|
|
261
264
|
locked?: boolean | undefined;
|
|
265
|
+
hasAppearance?: boolean | undefined;
|
|
262
266
|
dashes?: number[] | undefined;
|
|
263
267
|
interiorColor?: string | undefined;
|
|
264
268
|
cornerRadius?: number | undefined;
|
|
@@ -286,6 +290,7 @@ export declare function useAnnotations(): {
|
|
|
286
290
|
type: "circle";
|
|
287
291
|
cornerRadius?: undefined;
|
|
288
292
|
locked?: boolean | undefined;
|
|
293
|
+
hasAppearance?: boolean | undefined;
|
|
289
294
|
dashes?: number[] | undefined;
|
|
290
295
|
interiorColor?: string | undefined;
|
|
291
296
|
author?: string | undefined;
|
|
@@ -319,6 +324,7 @@ export declare function useAnnotations(): {
|
|
|
319
324
|
page: number;
|
|
320
325
|
type: "line";
|
|
321
326
|
locked?: boolean | undefined;
|
|
327
|
+
hasAppearance?: boolean | undefined;
|
|
322
328
|
dashes?: number[] | undefined;
|
|
323
329
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
324
330
|
tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -349,6 +355,7 @@ export declare function useAnnotations(): {
|
|
|
349
355
|
page: number;
|
|
350
356
|
type: "polyline";
|
|
351
357
|
locked?: boolean | undefined;
|
|
358
|
+
hasAppearance?: boolean | undefined;
|
|
352
359
|
dashes?: number[] | undefined;
|
|
353
360
|
interiorColor?: string | undefined;
|
|
354
361
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -382,6 +389,7 @@ export declare function useAnnotations(): {
|
|
|
382
389
|
head?: undefined;
|
|
383
390
|
tail?: undefined;
|
|
384
391
|
locked?: boolean | undefined;
|
|
392
|
+
hasAppearance?: boolean | undefined;
|
|
385
393
|
dashes?: number[] | undefined;
|
|
386
394
|
interiorColor?: string | undefined;
|
|
387
395
|
author?: string | undefined;
|
|
@@ -412,6 +420,7 @@ export declare function useAnnotations(): {
|
|
|
412
420
|
type: "ink";
|
|
413
421
|
pressure?: number[][] | undefined;
|
|
414
422
|
locked?: boolean | undefined;
|
|
423
|
+
hasAppearance?: boolean | undefined;
|
|
415
424
|
dashes?: number[] | undefined;
|
|
416
425
|
author?: string | undefined;
|
|
417
426
|
contents?: string | undefined;
|
|
@@ -436,6 +445,7 @@ export declare function useAnnotations(): {
|
|
|
436
445
|
page: number;
|
|
437
446
|
type: "stamp";
|
|
438
447
|
locked?: boolean | undefined;
|
|
448
|
+
hasAppearance?: boolean | undefined;
|
|
439
449
|
rotation?: 0 | 90 | 180 | 270 | undefined;
|
|
440
450
|
author?: string | undefined;
|
|
441
451
|
contents?: string | undefined;
|
|
@@ -461,6 +471,7 @@ export declare function useAnnotations(): {
|
|
|
461
471
|
page: number;
|
|
462
472
|
type: "loupe";
|
|
463
473
|
locked?: boolean | undefined;
|
|
474
|
+
hasAppearance?: boolean | undefined;
|
|
464
475
|
author?: string | undefined;
|
|
465
476
|
contents?: string | undefined;
|
|
466
477
|
inReplyTo?: string | undefined;
|
|
@@ -485,6 +496,7 @@ export declare function useAnnotations(): {
|
|
|
485
496
|
page: number;
|
|
486
497
|
type: "mask";
|
|
487
498
|
locked?: boolean | undefined;
|
|
499
|
+
hasAppearance?: boolean | undefined;
|
|
488
500
|
author?: string | undefined;
|
|
489
501
|
contents?: string | undefined;
|
|
490
502
|
inReplyTo?: string | undefined;
|
|
@@ -526,6 +538,7 @@ export declare function useAnnotations(): {
|
|
|
526
538
|
};
|
|
527
539
|
}[] | undefined;
|
|
528
540
|
locked?: boolean | undefined;
|
|
541
|
+
hasAppearance?: boolean | undefined;
|
|
529
542
|
overlayText?: string | undefined;
|
|
530
543
|
author?: string | undefined;
|
|
531
544
|
contents?: string | undefined;
|
|
@@ -568,6 +581,7 @@ export declare function useAnnotations(): {
|
|
|
568
581
|
id: string;
|
|
569
582
|
page: number;
|
|
570
583
|
locked?: boolean | undefined;
|
|
584
|
+
hasAppearance?: boolean | undefined;
|
|
571
585
|
author?: string | undefined;
|
|
572
586
|
contents?: string | undefined;
|
|
573
587
|
inReplyTo?: string | undefined;
|
|
@@ -591,6 +605,7 @@ export declare function useAnnotations(): {
|
|
|
591
605
|
page: number;
|
|
592
606
|
type: "text";
|
|
593
607
|
locked?: boolean | undefined;
|
|
608
|
+
hasAppearance?: boolean | undefined;
|
|
594
609
|
author?: string | undefined;
|
|
595
610
|
contents?: string | undefined;
|
|
596
611
|
inReplyTo?: string | undefined;
|
|
@@ -639,6 +654,7 @@ export declare function useAnnotations(): {
|
|
|
639
654
|
fontSize?: undefined;
|
|
640
655
|
align?: undefined;
|
|
641
656
|
locked?: boolean | undefined;
|
|
657
|
+
hasAppearance?: boolean | undefined;
|
|
642
658
|
dashes?: number[] | undefined;
|
|
643
659
|
cornerRadius?: number | undefined;
|
|
644
660
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -664,6 +680,7 @@ export declare function useAnnotations(): {
|
|
|
664
680
|
page: number;
|
|
665
681
|
type: "square";
|
|
666
682
|
locked?: boolean | undefined;
|
|
683
|
+
hasAppearance?: boolean | undefined;
|
|
667
684
|
dashes?: number[] | undefined;
|
|
668
685
|
interiorColor?: string | undefined;
|
|
669
686
|
cornerRadius?: number | undefined;
|
|
@@ -691,6 +708,7 @@ export declare function useAnnotations(): {
|
|
|
691
708
|
type: "circle";
|
|
692
709
|
cornerRadius?: undefined;
|
|
693
710
|
locked?: boolean | undefined;
|
|
711
|
+
hasAppearance?: boolean | undefined;
|
|
694
712
|
dashes?: number[] | undefined;
|
|
695
713
|
interiorColor?: string | undefined;
|
|
696
714
|
author?: string | undefined;
|
|
@@ -724,6 +742,7 @@ export declare function useAnnotations(): {
|
|
|
724
742
|
page: number;
|
|
725
743
|
type: "line";
|
|
726
744
|
locked?: boolean | undefined;
|
|
745
|
+
hasAppearance?: boolean | undefined;
|
|
727
746
|
dashes?: number[] | undefined;
|
|
728
747
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
729
748
|
tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -754,6 +773,7 @@ export declare function useAnnotations(): {
|
|
|
754
773
|
page: number;
|
|
755
774
|
type: "polyline";
|
|
756
775
|
locked?: boolean | undefined;
|
|
776
|
+
hasAppearance?: boolean | undefined;
|
|
757
777
|
dashes?: number[] | undefined;
|
|
758
778
|
interiorColor?: string | undefined;
|
|
759
779
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -787,6 +807,7 @@ export declare function useAnnotations(): {
|
|
|
787
807
|
head?: undefined;
|
|
788
808
|
tail?: undefined;
|
|
789
809
|
locked?: boolean | undefined;
|
|
810
|
+
hasAppearance?: boolean | undefined;
|
|
790
811
|
dashes?: number[] | undefined;
|
|
791
812
|
interiorColor?: string | undefined;
|
|
792
813
|
author?: string | undefined;
|
|
@@ -817,6 +838,7 @@ export declare function useAnnotations(): {
|
|
|
817
838
|
type: "ink";
|
|
818
839
|
pressure?: number[][] | undefined;
|
|
819
840
|
locked?: boolean | undefined;
|
|
841
|
+
hasAppearance?: boolean | undefined;
|
|
820
842
|
dashes?: number[] | undefined;
|
|
821
843
|
author?: string | undefined;
|
|
822
844
|
contents?: string | undefined;
|
|
@@ -841,6 +863,7 @@ export declare function useAnnotations(): {
|
|
|
841
863
|
page: number;
|
|
842
864
|
type: "stamp";
|
|
843
865
|
locked?: boolean | undefined;
|
|
866
|
+
hasAppearance?: boolean | undefined;
|
|
844
867
|
rotation?: 0 | 90 | 180 | 270 | undefined;
|
|
845
868
|
author?: string | undefined;
|
|
846
869
|
contents?: string | undefined;
|
|
@@ -866,6 +889,7 @@ export declare function useAnnotations(): {
|
|
|
866
889
|
page: number;
|
|
867
890
|
type: "loupe";
|
|
868
891
|
locked?: boolean | undefined;
|
|
892
|
+
hasAppearance?: boolean | undefined;
|
|
869
893
|
author?: string | undefined;
|
|
870
894
|
contents?: string | undefined;
|
|
871
895
|
inReplyTo?: string | undefined;
|
|
@@ -890,6 +914,7 @@ export declare function useAnnotations(): {
|
|
|
890
914
|
page: number;
|
|
891
915
|
type: "mask";
|
|
892
916
|
locked?: boolean | undefined;
|
|
917
|
+
hasAppearance?: boolean | undefined;
|
|
893
918
|
author?: string | undefined;
|
|
894
919
|
contents?: string | undefined;
|
|
895
920
|
inReplyTo?: string | undefined;
|
|
@@ -931,6 +956,7 @@ export declare function useAnnotations(): {
|
|
|
931
956
|
};
|
|
932
957
|
}[] | undefined;
|
|
933
958
|
locked?: boolean | undefined;
|
|
959
|
+
hasAppearance?: boolean | undefined;
|
|
934
960
|
overlayText?: string | undefined;
|
|
935
961
|
author?: string | undefined;
|
|
936
962
|
contents?: string | undefined;
|
|
@@ -975,6 +1001,7 @@ export declare function useAnnotations(): {
|
|
|
975
1001
|
id: string;
|
|
976
1002
|
page: number;
|
|
977
1003
|
locked?: boolean | undefined;
|
|
1004
|
+
hasAppearance?: boolean | undefined;
|
|
978
1005
|
author?: string | undefined;
|
|
979
1006
|
contents?: string | undefined;
|
|
980
1007
|
inReplyTo?: string | undefined;
|
|
@@ -998,6 +1025,7 @@ export declare function useAnnotations(): {
|
|
|
998
1025
|
page: number;
|
|
999
1026
|
type: "text";
|
|
1000
1027
|
locked?: boolean | undefined;
|
|
1028
|
+
hasAppearance?: boolean | undefined;
|
|
1001
1029
|
author?: string | undefined;
|
|
1002
1030
|
contents?: string | undefined;
|
|
1003
1031
|
inReplyTo?: string | undefined;
|
|
@@ -1046,6 +1074,7 @@ export declare function useAnnotations(): {
|
|
|
1046
1074
|
fontSize?: undefined;
|
|
1047
1075
|
align?: undefined;
|
|
1048
1076
|
locked?: boolean | undefined;
|
|
1077
|
+
hasAppearance?: boolean | undefined;
|
|
1049
1078
|
dashes?: number[] | undefined;
|
|
1050
1079
|
cornerRadius?: number | undefined;
|
|
1051
1080
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -1071,6 +1100,7 @@ export declare function useAnnotations(): {
|
|
|
1071
1100
|
page: number;
|
|
1072
1101
|
type: "square";
|
|
1073
1102
|
locked?: boolean | undefined;
|
|
1103
|
+
hasAppearance?: boolean | undefined;
|
|
1074
1104
|
dashes?: number[] | undefined;
|
|
1075
1105
|
interiorColor?: string | undefined;
|
|
1076
1106
|
cornerRadius?: number | undefined;
|
|
@@ -1098,6 +1128,7 @@ export declare function useAnnotations(): {
|
|
|
1098
1128
|
type: "circle";
|
|
1099
1129
|
cornerRadius?: undefined;
|
|
1100
1130
|
locked?: boolean | undefined;
|
|
1131
|
+
hasAppearance?: boolean | undefined;
|
|
1101
1132
|
dashes?: number[] | undefined;
|
|
1102
1133
|
interiorColor?: string | undefined;
|
|
1103
1134
|
author?: string | undefined;
|
|
@@ -1131,6 +1162,7 @@ export declare function useAnnotations(): {
|
|
|
1131
1162
|
page: number;
|
|
1132
1163
|
type: "line";
|
|
1133
1164
|
locked?: boolean | undefined;
|
|
1165
|
+
hasAppearance?: boolean | undefined;
|
|
1134
1166
|
dashes?: number[] | undefined;
|
|
1135
1167
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
1136
1168
|
tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -1161,6 +1193,7 @@ export declare function useAnnotations(): {
|
|
|
1161
1193
|
page: number;
|
|
1162
1194
|
type: "polyline";
|
|
1163
1195
|
locked?: boolean | undefined;
|
|
1196
|
+
hasAppearance?: boolean | undefined;
|
|
1164
1197
|
dashes?: number[] | undefined;
|
|
1165
1198
|
interiorColor?: string | undefined;
|
|
1166
1199
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -1194,6 +1227,7 @@ export declare function useAnnotations(): {
|
|
|
1194
1227
|
head?: undefined;
|
|
1195
1228
|
tail?: undefined;
|
|
1196
1229
|
locked?: boolean | undefined;
|
|
1230
|
+
hasAppearance?: boolean | undefined;
|
|
1197
1231
|
dashes?: number[] | undefined;
|
|
1198
1232
|
interiorColor?: string | undefined;
|
|
1199
1233
|
author?: string | undefined;
|
|
@@ -1224,6 +1258,7 @@ export declare function useAnnotations(): {
|
|
|
1224
1258
|
type: "ink";
|
|
1225
1259
|
pressure?: number[][] | undefined;
|
|
1226
1260
|
locked?: boolean | undefined;
|
|
1261
|
+
hasAppearance?: boolean | undefined;
|
|
1227
1262
|
dashes?: number[] | undefined;
|
|
1228
1263
|
author?: string | undefined;
|
|
1229
1264
|
contents?: string | undefined;
|
|
@@ -1248,6 +1283,7 @@ export declare function useAnnotations(): {
|
|
|
1248
1283
|
page: number;
|
|
1249
1284
|
type: "stamp";
|
|
1250
1285
|
locked?: boolean | undefined;
|
|
1286
|
+
hasAppearance?: boolean | undefined;
|
|
1251
1287
|
rotation?: 0 | 90 | 180 | 270 | undefined;
|
|
1252
1288
|
author?: string | undefined;
|
|
1253
1289
|
contents?: string | undefined;
|
|
@@ -1273,6 +1309,7 @@ export declare function useAnnotations(): {
|
|
|
1273
1309
|
page: number;
|
|
1274
1310
|
type: "loupe";
|
|
1275
1311
|
locked?: boolean | undefined;
|
|
1312
|
+
hasAppearance?: boolean | undefined;
|
|
1276
1313
|
author?: string | undefined;
|
|
1277
1314
|
contents?: string | undefined;
|
|
1278
1315
|
inReplyTo?: string | undefined;
|
|
@@ -1297,6 +1334,7 @@ export declare function useAnnotations(): {
|
|
|
1297
1334
|
page: number;
|
|
1298
1335
|
type: "mask";
|
|
1299
1336
|
locked?: boolean | undefined;
|
|
1337
|
+
hasAppearance?: boolean | undefined;
|
|
1300
1338
|
author?: string | undefined;
|
|
1301
1339
|
contents?: string | undefined;
|
|
1302
1340
|
inReplyTo?: string | undefined;
|
|
@@ -1338,6 +1376,7 @@ export declare function useAnnotations(): {
|
|
|
1338
1376
|
};
|
|
1339
1377
|
}[] | undefined;
|
|
1340
1378
|
locked?: boolean | undefined;
|
|
1379
|
+
hasAppearance?: boolean | undefined;
|
|
1341
1380
|
overlayText?: string | undefined;
|
|
1342
1381
|
author?: string | undefined;
|
|
1343
1382
|
contents?: string | undefined;
|
|
@@ -1381,6 +1420,7 @@ export declare function useAnnotations(): {
|
|
|
1381
1420
|
id: string;
|
|
1382
1421
|
page: number;
|
|
1383
1422
|
locked?: boolean | undefined;
|
|
1423
|
+
hasAppearance?: boolean | undefined;
|
|
1384
1424
|
author?: string | undefined;
|
|
1385
1425
|
contents?: string | undefined;
|
|
1386
1426
|
inReplyTo?: string | undefined;
|
|
@@ -1404,6 +1444,7 @@ export declare function useAnnotations(): {
|
|
|
1404
1444
|
page: number;
|
|
1405
1445
|
type: "text";
|
|
1406
1446
|
locked?: boolean | undefined;
|
|
1447
|
+
hasAppearance?: boolean | undefined;
|
|
1407
1448
|
author?: string | undefined;
|
|
1408
1449
|
contents?: string | undefined;
|
|
1409
1450
|
inReplyTo?: string | undefined;
|
|
@@ -1452,6 +1493,7 @@ export declare function useAnnotations(): {
|
|
|
1452
1493
|
fontSize?: undefined;
|
|
1453
1494
|
align?: undefined;
|
|
1454
1495
|
locked?: boolean | undefined;
|
|
1496
|
+
hasAppearance?: boolean | undefined;
|
|
1455
1497
|
dashes?: number[] | undefined;
|
|
1456
1498
|
cornerRadius?: number | undefined;
|
|
1457
1499
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -1477,6 +1519,7 @@ export declare function useAnnotations(): {
|
|
|
1477
1519
|
page: number;
|
|
1478
1520
|
type: "square";
|
|
1479
1521
|
locked?: boolean | undefined;
|
|
1522
|
+
hasAppearance?: boolean | undefined;
|
|
1480
1523
|
dashes?: number[] | undefined;
|
|
1481
1524
|
interiorColor?: string | undefined;
|
|
1482
1525
|
cornerRadius?: number | undefined;
|
|
@@ -1504,6 +1547,7 @@ export declare function useAnnotations(): {
|
|
|
1504
1547
|
type: "circle";
|
|
1505
1548
|
cornerRadius?: undefined;
|
|
1506
1549
|
locked?: boolean | undefined;
|
|
1550
|
+
hasAppearance?: boolean | undefined;
|
|
1507
1551
|
dashes?: number[] | undefined;
|
|
1508
1552
|
interiorColor?: string | undefined;
|
|
1509
1553
|
author?: string | undefined;
|
|
@@ -1537,6 +1581,7 @@ export declare function useAnnotations(): {
|
|
|
1537
1581
|
page: number;
|
|
1538
1582
|
type: "line";
|
|
1539
1583
|
locked?: boolean | undefined;
|
|
1584
|
+
hasAppearance?: boolean | undefined;
|
|
1540
1585
|
dashes?: number[] | undefined;
|
|
1541
1586
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
1542
1587
|
tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -1567,6 +1612,7 @@ export declare function useAnnotations(): {
|
|
|
1567
1612
|
page: number;
|
|
1568
1613
|
type: "polyline";
|
|
1569
1614
|
locked?: boolean | undefined;
|
|
1615
|
+
hasAppearance?: boolean | undefined;
|
|
1570
1616
|
dashes?: number[] | undefined;
|
|
1571
1617
|
interiorColor?: string | undefined;
|
|
1572
1618
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -1600,6 +1646,7 @@ export declare function useAnnotations(): {
|
|
|
1600
1646
|
head?: undefined;
|
|
1601
1647
|
tail?: undefined;
|
|
1602
1648
|
locked?: boolean | undefined;
|
|
1649
|
+
hasAppearance?: boolean | undefined;
|
|
1603
1650
|
dashes?: number[] | undefined;
|
|
1604
1651
|
interiorColor?: string | undefined;
|
|
1605
1652
|
author?: string | undefined;
|
|
@@ -1630,6 +1677,7 @@ export declare function useAnnotations(): {
|
|
|
1630
1677
|
type: "ink";
|
|
1631
1678
|
pressure?: number[][] | undefined;
|
|
1632
1679
|
locked?: boolean | undefined;
|
|
1680
|
+
hasAppearance?: boolean | undefined;
|
|
1633
1681
|
dashes?: number[] | undefined;
|
|
1634
1682
|
author?: string | undefined;
|
|
1635
1683
|
contents?: string | undefined;
|
|
@@ -1654,6 +1702,7 @@ export declare function useAnnotations(): {
|
|
|
1654
1702
|
page: number;
|
|
1655
1703
|
type: "stamp";
|
|
1656
1704
|
locked?: boolean | undefined;
|
|
1705
|
+
hasAppearance?: boolean | undefined;
|
|
1657
1706
|
rotation?: 0 | 90 | 180 | 270 | undefined;
|
|
1658
1707
|
author?: string | undefined;
|
|
1659
1708
|
contents?: string | undefined;
|
|
@@ -1679,6 +1728,7 @@ export declare function useAnnotations(): {
|
|
|
1679
1728
|
page: number;
|
|
1680
1729
|
type: "loupe";
|
|
1681
1730
|
locked?: boolean | undefined;
|
|
1731
|
+
hasAppearance?: boolean | undefined;
|
|
1682
1732
|
author?: string | undefined;
|
|
1683
1733
|
contents?: string | undefined;
|
|
1684
1734
|
inReplyTo?: string | undefined;
|
|
@@ -1703,6 +1753,7 @@ export declare function useAnnotations(): {
|
|
|
1703
1753
|
page: number;
|
|
1704
1754
|
type: "mask";
|
|
1705
1755
|
locked?: boolean | undefined;
|
|
1756
|
+
hasAppearance?: boolean | undefined;
|
|
1706
1757
|
author?: string | undefined;
|
|
1707
1758
|
contents?: string | undefined;
|
|
1708
1759
|
inReplyTo?: string | undefined;
|
|
@@ -1744,6 +1795,7 @@ export declare function useAnnotations(): {
|
|
|
1744
1795
|
};
|
|
1745
1796
|
}[] | undefined;
|
|
1746
1797
|
locked?: boolean | undefined;
|
|
1798
|
+
hasAppearance?: boolean | undefined;
|
|
1747
1799
|
overlayText?: string | undefined;
|
|
1748
1800
|
author?: string | undefined;
|
|
1749
1801
|
contents?: string | undefined;
|
|
@@ -1786,6 +1838,7 @@ export declare function useAnnotations(): {
|
|
|
1786
1838
|
id: string;
|
|
1787
1839
|
page: number;
|
|
1788
1840
|
locked?: boolean | undefined;
|
|
1841
|
+
hasAppearance?: boolean | undefined;
|
|
1789
1842
|
author?: string | undefined;
|
|
1790
1843
|
contents?: string | undefined;
|
|
1791
1844
|
inReplyTo?: string | undefined;
|
|
@@ -1809,6 +1862,7 @@ export declare function useAnnotations(): {
|
|
|
1809
1862
|
page: number;
|
|
1810
1863
|
type: "text";
|
|
1811
1864
|
locked?: boolean | undefined;
|
|
1865
|
+
hasAppearance?: boolean | undefined;
|
|
1812
1866
|
author?: string | undefined;
|
|
1813
1867
|
contents?: string | undefined;
|
|
1814
1868
|
inReplyTo?: string | undefined;
|
|
@@ -1857,6 +1911,7 @@ export declare function useAnnotations(): {
|
|
|
1857
1911
|
fontSize?: undefined;
|
|
1858
1912
|
align?: undefined;
|
|
1859
1913
|
locked?: boolean | undefined;
|
|
1914
|
+
hasAppearance?: boolean | undefined;
|
|
1860
1915
|
dashes?: number[] | undefined;
|
|
1861
1916
|
cornerRadius?: number | undefined;
|
|
1862
1917
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -1882,6 +1937,7 @@ export declare function useAnnotations(): {
|
|
|
1882
1937
|
page: number;
|
|
1883
1938
|
type: "square";
|
|
1884
1939
|
locked?: boolean | undefined;
|
|
1940
|
+
hasAppearance?: boolean | undefined;
|
|
1885
1941
|
dashes?: number[] | undefined;
|
|
1886
1942
|
interiorColor?: string | undefined;
|
|
1887
1943
|
cornerRadius?: number | undefined;
|
|
@@ -1909,6 +1965,7 @@ export declare function useAnnotations(): {
|
|
|
1909
1965
|
type: "circle";
|
|
1910
1966
|
cornerRadius?: undefined;
|
|
1911
1967
|
locked?: boolean | undefined;
|
|
1968
|
+
hasAppearance?: boolean | undefined;
|
|
1912
1969
|
dashes?: number[] | undefined;
|
|
1913
1970
|
interiorColor?: string | undefined;
|
|
1914
1971
|
author?: string | undefined;
|
|
@@ -1942,6 +1999,7 @@ export declare function useAnnotations(): {
|
|
|
1942
1999
|
page: number;
|
|
1943
2000
|
type: "line";
|
|
1944
2001
|
locked?: boolean | undefined;
|
|
2002
|
+
hasAppearance?: boolean | undefined;
|
|
1945
2003
|
dashes?: number[] | undefined;
|
|
1946
2004
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
1947
2005
|
tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -1972,6 +2030,7 @@ export declare function useAnnotations(): {
|
|
|
1972
2030
|
page: number;
|
|
1973
2031
|
type: "polyline";
|
|
1974
2032
|
locked?: boolean | undefined;
|
|
2033
|
+
hasAppearance?: boolean | undefined;
|
|
1975
2034
|
dashes?: number[] | undefined;
|
|
1976
2035
|
interiorColor?: string | undefined;
|
|
1977
2036
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -2005,6 +2064,7 @@ export declare function useAnnotations(): {
|
|
|
2005
2064
|
head?: undefined;
|
|
2006
2065
|
tail?: undefined;
|
|
2007
2066
|
locked?: boolean | undefined;
|
|
2067
|
+
hasAppearance?: boolean | undefined;
|
|
2008
2068
|
dashes?: number[] | undefined;
|
|
2009
2069
|
interiorColor?: string | undefined;
|
|
2010
2070
|
author?: string | undefined;
|
|
@@ -2035,6 +2095,7 @@ export declare function useAnnotations(): {
|
|
|
2035
2095
|
type: "ink";
|
|
2036
2096
|
pressure?: number[][] | undefined;
|
|
2037
2097
|
locked?: boolean | undefined;
|
|
2098
|
+
hasAppearance?: boolean | undefined;
|
|
2038
2099
|
dashes?: number[] | undefined;
|
|
2039
2100
|
author?: string | undefined;
|
|
2040
2101
|
contents?: string | undefined;
|
|
@@ -2059,6 +2120,7 @@ export declare function useAnnotations(): {
|
|
|
2059
2120
|
page: number;
|
|
2060
2121
|
type: "stamp";
|
|
2061
2122
|
locked?: boolean | undefined;
|
|
2123
|
+
hasAppearance?: boolean | undefined;
|
|
2062
2124
|
rotation?: 0 | 90 | 180 | 270 | undefined;
|
|
2063
2125
|
author?: string | undefined;
|
|
2064
2126
|
contents?: string | undefined;
|
|
@@ -2084,6 +2146,7 @@ export declare function useAnnotations(): {
|
|
|
2084
2146
|
page: number;
|
|
2085
2147
|
type: "loupe";
|
|
2086
2148
|
locked?: boolean | undefined;
|
|
2149
|
+
hasAppearance?: boolean | undefined;
|
|
2087
2150
|
author?: string | undefined;
|
|
2088
2151
|
contents?: string | undefined;
|
|
2089
2152
|
inReplyTo?: string | undefined;
|
|
@@ -2108,6 +2171,7 @@ export declare function useAnnotations(): {
|
|
|
2108
2171
|
page: number;
|
|
2109
2172
|
type: "mask";
|
|
2110
2173
|
locked?: boolean | undefined;
|
|
2174
|
+
hasAppearance?: boolean | undefined;
|
|
2111
2175
|
author?: string | undefined;
|
|
2112
2176
|
contents?: string | undefined;
|
|
2113
2177
|
inReplyTo?: string | undefined;
|
|
@@ -2149,6 +2213,7 @@ export declare function useAnnotations(): {
|
|
|
2149
2213
|
};
|
|
2150
2214
|
}[] | undefined;
|
|
2151
2215
|
locked?: boolean | undefined;
|
|
2216
|
+
hasAppearance?: boolean | undefined;
|
|
2152
2217
|
overlayText?: string | undefined;
|
|
2153
2218
|
author?: string | undefined;
|
|
2154
2219
|
contents?: string | undefined;
|
|
@@ -2192,6 +2257,7 @@ export declare function useAnnotations(): {
|
|
|
2192
2257
|
id: string;
|
|
2193
2258
|
page: number;
|
|
2194
2259
|
locked?: boolean | undefined;
|
|
2260
|
+
hasAppearance?: boolean | undefined;
|
|
2195
2261
|
author?: string | undefined;
|
|
2196
2262
|
contents?: string | undefined;
|
|
2197
2263
|
inReplyTo?: string | undefined;
|
|
@@ -2215,6 +2281,7 @@ export declare function useAnnotations(): {
|
|
|
2215
2281
|
page: number;
|
|
2216
2282
|
type: "text";
|
|
2217
2283
|
locked?: boolean | undefined;
|
|
2284
|
+
hasAppearance?: boolean | undefined;
|
|
2218
2285
|
author?: string | undefined;
|
|
2219
2286
|
contents?: string | undefined;
|
|
2220
2287
|
inReplyTo?: string | undefined;
|
|
@@ -2263,6 +2330,7 @@ export declare function useAnnotations(): {
|
|
|
2263
2330
|
fontSize?: undefined;
|
|
2264
2331
|
align?: undefined;
|
|
2265
2332
|
locked?: boolean | undefined;
|
|
2333
|
+
hasAppearance?: boolean | undefined;
|
|
2266
2334
|
dashes?: number[] | undefined;
|
|
2267
2335
|
cornerRadius?: number | undefined;
|
|
2268
2336
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -2288,6 +2356,7 @@ export declare function useAnnotations(): {
|
|
|
2288
2356
|
page: number;
|
|
2289
2357
|
type: "square";
|
|
2290
2358
|
locked?: boolean | undefined;
|
|
2359
|
+
hasAppearance?: boolean | undefined;
|
|
2291
2360
|
dashes?: number[] | undefined;
|
|
2292
2361
|
interiorColor?: string | undefined;
|
|
2293
2362
|
cornerRadius?: number | undefined;
|
|
@@ -2315,6 +2384,7 @@ export declare function useAnnotations(): {
|
|
|
2315
2384
|
type: "circle";
|
|
2316
2385
|
cornerRadius?: undefined;
|
|
2317
2386
|
locked?: boolean | undefined;
|
|
2387
|
+
hasAppearance?: boolean | undefined;
|
|
2318
2388
|
dashes?: number[] | undefined;
|
|
2319
2389
|
interiorColor?: string | undefined;
|
|
2320
2390
|
author?: string | undefined;
|
|
@@ -2348,6 +2418,7 @@ export declare function useAnnotations(): {
|
|
|
2348
2418
|
page: number;
|
|
2349
2419
|
type: "line";
|
|
2350
2420
|
locked?: boolean | undefined;
|
|
2421
|
+
hasAppearance?: boolean | undefined;
|
|
2351
2422
|
dashes?: number[] | undefined;
|
|
2352
2423
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
2353
2424
|
tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -2378,6 +2449,7 @@ export declare function useAnnotations(): {
|
|
|
2378
2449
|
page: number;
|
|
2379
2450
|
type: "polyline";
|
|
2380
2451
|
locked?: boolean | undefined;
|
|
2452
|
+
hasAppearance?: boolean | undefined;
|
|
2381
2453
|
dashes?: number[] | undefined;
|
|
2382
2454
|
interiorColor?: string | undefined;
|
|
2383
2455
|
head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
|
|
@@ -2411,6 +2483,7 @@ export declare function useAnnotations(): {
|
|
|
2411
2483
|
head?: undefined;
|
|
2412
2484
|
tail?: undefined;
|
|
2413
2485
|
locked?: boolean | undefined;
|
|
2486
|
+
hasAppearance?: boolean | undefined;
|
|
2414
2487
|
dashes?: number[] | undefined;
|
|
2415
2488
|
interiorColor?: string | undefined;
|
|
2416
2489
|
author?: string | undefined;
|
|
@@ -2441,6 +2514,7 @@ export declare function useAnnotations(): {
|
|
|
2441
2514
|
type: "ink";
|
|
2442
2515
|
pressure?: number[][] | undefined;
|
|
2443
2516
|
locked?: boolean | undefined;
|
|
2517
|
+
hasAppearance?: boolean | undefined;
|
|
2444
2518
|
dashes?: number[] | undefined;
|
|
2445
2519
|
author?: string | undefined;
|
|
2446
2520
|
contents?: string | undefined;
|
|
@@ -2465,6 +2539,7 @@ export declare function useAnnotations(): {
|
|
|
2465
2539
|
page: number;
|
|
2466
2540
|
type: "stamp";
|
|
2467
2541
|
locked?: boolean | undefined;
|
|
2542
|
+
hasAppearance?: boolean | undefined;
|
|
2468
2543
|
rotation?: 0 | 90 | 180 | 270 | undefined;
|
|
2469
2544
|
author?: string | undefined;
|
|
2470
2545
|
contents?: string | undefined;
|
|
@@ -2490,6 +2565,7 @@ export declare function useAnnotations(): {
|
|
|
2490
2565
|
page: number;
|
|
2491
2566
|
type: "loupe";
|
|
2492
2567
|
locked?: boolean | undefined;
|
|
2568
|
+
hasAppearance?: boolean | undefined;
|
|
2493
2569
|
author?: string | undefined;
|
|
2494
2570
|
contents?: string | undefined;
|
|
2495
2571
|
inReplyTo?: string | undefined;
|
|
@@ -2514,6 +2590,7 @@ export declare function useAnnotations(): {
|
|
|
2514
2590
|
page: number;
|
|
2515
2591
|
type: "mask";
|
|
2516
2592
|
locked?: boolean | undefined;
|
|
2593
|
+
hasAppearance?: boolean | undefined;
|
|
2517
2594
|
author?: string | undefined;
|
|
2518
2595
|
contents?: string | undefined;
|
|
2519
2596
|
inReplyTo?: string | undefined;
|
|
@@ -2555,6 +2632,7 @@ export declare function useAnnotations(): {
|
|
|
2555
2632
|
};
|
|
2556
2633
|
}[] | undefined;
|
|
2557
2634
|
locked?: boolean | undefined;
|
|
2635
|
+
hasAppearance?: boolean | undefined;
|
|
2558
2636
|
overlayText?: string | undefined;
|
|
2559
2637
|
author?: string | undefined;
|
|
2560
2638
|
contents?: string | undefined;
|
|
@@ -2700,6 +2778,30 @@ interface FormHandle {
|
|
|
2700
2778
|
/** The open document's form: its fields, their values, and `set` and `reset`. */
|
|
2701
2779
|
export declare function useForm(): FormHandle;
|
|
2702
2780
|
//#endregion
|
|
2781
|
+
//#region src/hooks/useRecords.d.ts
|
|
2782
|
+
/**
|
|
2783
|
+
* The records a plugin keeps under `key` (`<plugin>.<name>`), for host components: the live list
|
|
2784
|
+
* for the open document, and the handle to read and write them, each write one undo step.
|
|
2785
|
+
* Plugins are set up once InkRoot has mounted, so until then (and on the server) `handle` is
|
|
2786
|
+
* null and `records` is empty. `T` is the plugin's record type.
|
|
2787
|
+
*/
|
|
2788
|
+
export declare function useRecords<T extends RecordBase>(key: string): {
|
|
2789
|
+
records: readonly T[];
|
|
2790
|
+
handle: HostRecords$1<T> | null;
|
|
2791
|
+
};
|
|
2792
|
+
//#endregion
|
|
2793
|
+
//#region src/hooks/useRecordSelection.d.ts
|
|
2794
|
+
/**
|
|
2795
|
+
* The selected record under `key` (`<plugin>.<name>`): the one selection the marks and every
|
|
2796
|
+
* record list over those records share. `select` takes an id, or null to clear; an id that has
|
|
2797
|
+
* no mark changes nothing. Until InkRoot has mounted (and on the server) nothing is selected
|
|
2798
|
+
* and `select` does nothing.
|
|
2799
|
+
*/
|
|
2800
|
+
export declare function useRecordSelection(key: string): {
|
|
2801
|
+
selected: string | null;
|
|
2802
|
+
select: (id: string | null) => void;
|
|
2803
|
+
};
|
|
2804
|
+
//#endregion
|
|
2703
2805
|
//#region src/components/InkRoot.d.ts
|
|
2704
2806
|
interface InkRootHandle {
|
|
2705
2807
|
readonly document: InkDocument | null;
|
|
@@ -2915,6 +3017,30 @@ interface InkHistoryButtonProps extends ComponentPropsWithoutRef<'button'> {
|
|
|
2915
3017
|
//#region src/components/InkUndo.d.ts
|
|
2916
3018
|
export declare function InkUndo({ asChild, className, children, disabled, onClick, ...rest }: InkHistoryButtonProps): import("react").JSX.Element;
|
|
2917
3019
|
//#endregion
|
|
3020
|
+
//#region src/components/InkDownloadButton.d.ts
|
|
3021
|
+
interface InkDownloadButtonProps extends ComponentPropsWithoutRef<'button'> {
|
|
3022
|
+
asChild?: boolean;
|
|
3023
|
+
/** The name to save under. Default: the document's `fileName`. */
|
|
3024
|
+
filename?: string | undefined;
|
|
3025
|
+
}
|
|
3026
|
+
/**
|
|
3027
|
+
* Saves the open document's file through the browser's download, under its `fileName` or
|
|
3028
|
+
* `filename`. Disabled until the document is ready. Today that is the file as it was opened,
|
|
3029
|
+
* without this session's annotations.
|
|
3030
|
+
*/
|
|
3031
|
+
export declare function InkDownloadButton({ asChild, filename, className, children, disabled, onClick, ...rest }: InkDownloadButtonProps): import("react").JSX.Element;
|
|
3032
|
+
//#endregion
|
|
3033
|
+
//#region src/components/InkPrintButton.d.ts
|
|
3034
|
+
interface InkPrintButtonProps extends ComponentPropsWithoutRef<'button'> {
|
|
3035
|
+
asChild?: boolean;
|
|
3036
|
+
}
|
|
3037
|
+
/**
|
|
3038
|
+
* Prints the open document's file with the browser's own PDF viewer (on iOS, in a new tab).
|
|
3039
|
+
* Disabled until the document is ready. Today that is the file as it was opened, without this
|
|
3040
|
+
* session's annotations.
|
|
3041
|
+
*/
|
|
3042
|
+
export declare function InkPrintButton({ asChild, className, children, disabled, onClick, ...rest }: InkPrintButtonProps): import("react").JSX.Element;
|
|
3043
|
+
//#endregion
|
|
2918
3044
|
//#region src/components/InkRedo.d.ts
|
|
2919
3045
|
export declare function InkRedo({ asChild, className, children, disabled, onClick, ...rest }: InkHistoryButtonProps): import("react").JSX.Element;
|
|
2920
3046
|
//#endregion
|
|
@@ -3066,5 +3192,168 @@ interface InkThreadPopoverProps {
|
|
|
3066
3192
|
}
|
|
3067
3193
|
export declare function InkThreadPopover({ children }: InkThreadPopoverProps): import("react").JSX.Element;
|
|
3068
3194
|
//#endregion
|
|
3069
|
-
|
|
3195
|
+
//#region src/components/InkSidebar.d.ts
|
|
3196
|
+
interface InkSidebarProps extends Omit<ComponentPropsWithoutRef<'div'>, 'children'> {
|
|
3197
|
+
/** Which edge the rail and border sit on. Default `'left'`. */
|
|
3198
|
+
side?: SidebarSide$1 | undefined;
|
|
3199
|
+
/** `'rail'` (default), `'tabs'` or `'stack'`. */
|
|
3200
|
+
layout?: SidebarLayout$1 | undefined;
|
|
3201
|
+
/** Default true. False hides the whole sidebar and keeps its open panel, content and scroll for when it shows again. */
|
|
3202
|
+
visible?: boolean | undefined;
|
|
3203
|
+
/**
|
|
3204
|
+
* Controlled: the open panel's id (or null) for rail and tabs, the expanded ids for stack.
|
|
3205
|
+
* Leave it out for an uncontrolled sidebar.
|
|
3206
|
+
*/
|
|
3207
|
+
open?: SidebarOpen$1 | undefined;
|
|
3208
|
+
/** Uncontrolled: what starts open. Left out, the first panel does. */
|
|
3209
|
+
defaultOpen?: SidebarOpen$1 | undefined;
|
|
3210
|
+
/** Called with the new value when a trigger is activated or the open panel goes. */
|
|
3211
|
+
onOpenChange?: ((open: SidebarOpen$1) => void) | undefined;
|
|
3212
|
+
/** The `InkPanel`s. */
|
|
3213
|
+
children?: ReactNode;
|
|
3214
|
+
}
|
|
3215
|
+
/**
|
|
3216
|
+
* A sidebar of `InkPanel`s: `createSidebar`'s markup on core's sidebar controller, which holds
|
|
3217
|
+
* the open state, the ARIA, the keys and the clicks. Rail and tabs render their triggers here;
|
|
3218
|
+
* in a stack each panel renders its own header. Panels take their place in DOM order, so a
|
|
3219
|
+
* panel rendered later slots in where it stands. A closed panel stays mounted and hidden, and
|
|
3220
|
+
* the panels' content stays in place across layouts, so its state survives switching.
|
|
3221
|
+
*
|
|
3222
|
+
* `open` with `onOpenChange` controls it; `defaultOpen` starts it uncontrolled; with neither,
|
|
3223
|
+
* the first panel starts open. It needs no document, so it works outside `InkRoot`. The server
|
|
3224
|
+
* renders the root, the panels (the open one shown) and the stack headers; rail and tab
|
|
3225
|
+
* buttons follow once mounted.
|
|
3226
|
+
*/
|
|
3227
|
+
export declare function InkSidebar({ side, layout, visible, open, defaultOpen, onOpenChange, className, children, ...rest }: InkSidebarProps): import("react").JSX.Element;
|
|
3228
|
+
//#endregion
|
|
3229
|
+
//#region src/components/InkPanel.d.ts
|
|
3230
|
+
interface InkPanelProps {
|
|
3231
|
+
/** Names the panel in the sidebar's `open`. */
|
|
3232
|
+
id: string;
|
|
3233
|
+
/** Names its trigger. */
|
|
3234
|
+
label: string;
|
|
3235
|
+
/** An `@inkbar/icons` node, shown on the rail. */
|
|
3236
|
+
icon?: IconNode | undefined;
|
|
3237
|
+
/** A count or short text beside it, hidden when empty or 0. */
|
|
3238
|
+
badge?: string | number | undefined;
|
|
3239
|
+
children?: ReactNode;
|
|
3240
|
+
}
|
|
3241
|
+
/**
|
|
3242
|
+
* One panel of an `InkSidebar`, holding `children` as its content. Closed, the panel stays
|
|
3243
|
+
* mounted and hidden. In a stack it renders its own header above its content.
|
|
3244
|
+
*/
|
|
3245
|
+
export declare function InkPanel({ id, label, icon, badge, children }: InkPanelProps): import("react").JSX.Element;
|
|
3246
|
+
//#endregion
|
|
3247
|
+
//#region src/components/InkThumbnail.d.ts
|
|
3248
|
+
interface InkThumbnailProps extends Omit<ComponentPropsWithoutRef<'div'>, 'children'> {
|
|
3249
|
+
/** 0-based. */
|
|
3250
|
+
page: number;
|
|
3251
|
+
/** Width in CSS pixels; the height follows the page. Default 120 unless `height` is given. */
|
|
3252
|
+
width?: number | undefined;
|
|
3253
|
+
/** Height in CSS pixels; the width follows the page. */
|
|
3254
|
+
height?: number | undefined;
|
|
3255
|
+
/** Draw the page's annotations. Default true. */
|
|
3256
|
+
annotations?: boolean | undefined;
|
|
3257
|
+
/** Draw plugin marks. Default true. */
|
|
3258
|
+
marks?: boolean | undefined;
|
|
3259
|
+
/** The accessible name. Default "Page N". */
|
|
3260
|
+
label?: string | undefined;
|
|
3261
|
+
}
|
|
3262
|
+
/**
|
|
3263
|
+
* One page as a static image, with its live annotations and plugin marks: core's thumbnail
|
|
3264
|
+
* painter on this element, which sizes it, names it ("Page N" unless `label` says otherwise)
|
|
3265
|
+
* and draws it once it nears the visible area. It is not focusable and does nothing on click:
|
|
3266
|
+
* wrap it in the control you need. Inside `InkRoot`; it renders empty on the server.
|
|
3267
|
+
*/
|
|
3268
|
+
export declare function InkThumbnail({ page, width, height, annotations, marks, label, className, ...rest }: InkThumbnailProps): import("react").JSX.Element;
|
|
3269
|
+
//#endregion
|
|
3270
|
+
//#region src/components/InkThumbnails.d.ts
|
|
3271
|
+
interface InkThumbnailsProps extends Omit<ComponentPropsWithoutRef<'div'>, 'children'> {
|
|
3272
|
+
/** 0-based pages to list, in order. Default: every page. */
|
|
3273
|
+
pages?: readonly number[] | undefined;
|
|
3274
|
+
/** Thumbnail width in CSS pixels. Default: the list's width less a 16px gutter each side. */
|
|
3275
|
+
width?: number | undefined;
|
|
3276
|
+
/** Draw each page's annotations. Default true. */
|
|
3277
|
+
annotations?: boolean | undefined;
|
|
3278
|
+
/** Draw plugin marks. Default true. */
|
|
3279
|
+
marks?: boolean | undefined;
|
|
3280
|
+
/**
|
|
3281
|
+
* Renders inside each item, after its page number. The item's height is fixed from the
|
|
3282
|
+
* page's, so keep what you add out of the flow (position it absolutely) or small.
|
|
3283
|
+
*/
|
|
3284
|
+
renderItem?: ((item: {
|
|
3285
|
+
page: number;
|
|
3286
|
+
current: boolean;
|
|
3287
|
+
}) => ReactNode) | undefined;
|
|
3288
|
+
}
|
|
3289
|
+
/**
|
|
3290
|
+
* The pages as a list of thumbnails: `createThumbnails`' markup on core's thumbnails
|
|
3291
|
+
* controller, which holds the current page, the keys, the clicks, the Tab stop and the window.
|
|
3292
|
+
* Only the items near the visible part are mounted, each placed at its offset over a spacer of
|
|
3293
|
+
* the full height, and each holds an `InkThumbnail`. An item is a button that scrolls the
|
|
3294
|
+
* viewport to its page; the current page's has `aria-current="page"`. Inside `InkRoot`; it
|
|
3295
|
+
* renders empty on the server.
|
|
3296
|
+
*/
|
|
3297
|
+
export declare function InkThumbnails({ pages, width, annotations, marks, renderItem, className, ...rest }: InkThumbnailsProps): import("react").JSX.Element;
|
|
3298
|
+
//#endregion
|
|
3299
|
+
//#region src/components/InkRecordList.d.ts
|
|
3300
|
+
interface InkRecordListProps<T extends RecordBase & {
|
|
3301
|
+
page: number;
|
|
3302
|
+
} = RecordBase & {
|
|
3303
|
+
page: number;
|
|
3304
|
+
}> extends Omit<ComponentPropsWithoutRef<'div'>, 'children'> {
|
|
3305
|
+
/** The records to list, as `<plugin>.<name>`. */
|
|
3306
|
+
records?: string | undefined;
|
|
3307
|
+
/**
|
|
3308
|
+
* A host's own source, listed in place of `records` with the same controller and cards.
|
|
3309
|
+
* `card`, `where` and `sort` do not apply to it.
|
|
3310
|
+
*/
|
|
3311
|
+
source?: RecordListSource | undefined;
|
|
3312
|
+
/** The card each record shows. Default: its mark's card. */
|
|
3313
|
+
card?: ((record: T) => CardSpec$1) | undefined;
|
|
3314
|
+
/** Which records to list. Default: those that have a mark. */
|
|
3315
|
+
where?: ((record: T) => boolean) | undefined;
|
|
3316
|
+
/** The order. Default: reading order by the marks' rects. */
|
|
3317
|
+
sort?: ((a: T, b: T) => number) | undefined;
|
|
3318
|
+
/** Called with the number listed whenever it changes. */
|
|
3319
|
+
onCountChange?: ((count: number) => void) | undefined;
|
|
3320
|
+
/** Replaces "Nothing here yet."; null shows nothing. */
|
|
3321
|
+
empty?: ReactNode;
|
|
3322
|
+
}
|
|
3323
|
+
/**
|
|
3324
|
+
* The records a plugin keeps under `records` (`<plugin>.<name>`) as a list of cards, the same
|
|
3325
|
+
* cards their marks open, with the same actions: `createRecordList` on core's record list
|
|
3326
|
+
* controller. The list, the marks and `useRecordSelection` share one selection. `card`, `where`
|
|
3327
|
+
* and `sort` replace the marks' card, filter and reading order; a new function rebuilds the
|
|
3328
|
+
* list, so keep them stable (`useCallback`, or defined outside the component).
|
|
3329
|
+
* `onCountChange` gets the number listed whenever it changes; `empty` replaces "Nothing here
|
|
3330
|
+
* yet.". It fills its parent's height. Inside `InkRoot`; it renders empty on the server.
|
|
3331
|
+
*
|
|
3332
|
+
* In place of `records`, `source` takes a host's own `RecordListSource` and lists it with the
|
|
3333
|
+
* same controller and cards. Give one of the two: with both, `source` wins and a development
|
|
3334
|
+
* build warns.
|
|
3335
|
+
*/
|
|
3336
|
+
export declare function InkRecordList<T extends RecordBase & {
|
|
3337
|
+
page: number;
|
|
3338
|
+
} = RecordBase & {
|
|
3339
|
+
page: number;
|
|
3340
|
+
}>({ records, source, card, where, sort, onCountChange, empty, ...rest }: InkRecordListProps<T>): import("react").JSX.Element;
|
|
3341
|
+
//#endregion
|
|
3342
|
+
//#region src/components/InkSearchResults.d.ts
|
|
3343
|
+
interface InkSearchResultsProps extends Omit<ComponentPropsWithoutRef<'div'>, 'children'> {
|
|
3344
|
+
/** Show the query field. Default true; turn it off when a find bar is on the page. */
|
|
3345
|
+
field?: boolean | undefined;
|
|
3346
|
+
}
|
|
3347
|
+
/**
|
|
3348
|
+
* The search hits as a list of cards, for a sidebar panel: `createSearchResults` on core's
|
|
3349
|
+
* record list controller over the root's search. One card per hit, with its page and the text
|
|
3350
|
+
* around it. Choosing a card makes its hit current, as the find bar's next and previous do, and
|
|
3351
|
+
* the current hit is the selected card. Above the cards, a query field (`field={false}`
|
|
3352
|
+
* leaves it out when a find bar is on the page); under them, the find bar's match count.
|
|
3353
|
+
* Field and find bar share the search state, so they never disagree. It fills its parent's
|
|
3354
|
+
* height. Inside `InkRoot`; it renders empty on the server.
|
|
3355
|
+
*/
|
|
3356
|
+
export declare function InkSearchResults({ field, className, ...rest }: InkSearchResultsProps): import("react").JSX.Element;
|
|
3357
|
+
//#endregion
|
|
3358
|
+
export type { AnnotationDecoration, AnnotationSlotProps, AnnotationState, CardSpec, CommandHandle, DecorateAnnotation, FormHandle, HostRecords, InkAnnotationProps, InkColorMenuProps, InkCommandProps, InkContext, InkDownloadButtonProps, InkFindBarProps, InkHighlightMenuProps, InkHistory, InkHistoryButtonProps, InkIconProps, InkLineStyleMenuProps, InkPageButtonProps, InkPageInputProps, InkPageProps, InkPanelProps, InkPlugin, InkPrintButtonProps, InkRecordListProps, InkRootHandle, InkRootProps, InkSearchButtonProps, InkSearchResultsProps, InkShapeMenuProps, InkSidebarProps, InkSignatureDialogProps, InkSignatureMenuProps, InkStatus, InkTextStyleMenuProps, InkThreadPopoverProps, InkThumbnailProps, InkThumbnailsProps, InkToolButtonProps, InkToolbarButtonProps, InkToolbarProps, InkToolbarSeparatorProps, InkViewportProps, InkZoomButtonProps, InkZoomSelectProps, ScopedToolStyleHandle, SidebarLayout, SidebarOpen, SidebarSide, ThreadPopoverSlotProps, ToolStyleHandle };
|
|
3070
3359
|
//# sourceMappingURL=index.d.mts.map
|