@inkbar/react 0.5.0 → 0.7.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.
Files changed (6) hide show
  1. package/README.md +27 -3
  2. package/dist/index.d.mts +178 -85
  3. package/dist/index.d.mts.map +1 -1
  4. package/dist/index.mjs +412 -18
  5. package/dist/index.mjs.map +1 -1
  6. package/package.json +6 -5
package/dist/index.d.mts CHANGED
@@ -1,11 +1,14 @@
1
1
  import { ComponentPropsWithoutRef, ReactNode, Ref } from "react";
2
- import { Annotation, AnnotationChange, AnnotationDefaults, AnnotationDocument, AnnotationInput, AnnotationPatch, CurrentStyle, DocumentSource, ImportOptions, InkDocument, InkError, InkStatus, PageInfo, PdfAssets, Readable, SignatureLibrary, SignatureStore, SignatureTemplate, StyleGroup, StyleKey, StyleProps } from "@inkbar/core";
3
- import { AnnotationDecoration, AnnotationSlotProps, AnnotationSlotProps as AnnotationSlotProps$1, AnnotationState, ColorProperty, DecorateAnnotation, DecorateAnnotation as DecorateAnnotation$1, LayoutMode, PageMount, ThreadPopoverSlotProps, ThreadPopoverSlotProps as ThreadPopoverSlotProps$1, Tool, ToolController, ToolId, ToolOptions, ToolStyle, ViewRotation, Viewport, ZoomValue } from "@inkbar/core/dom";
4
- import { Select } from "radix-ui";
2
+ import { Annotation, AnnotationChange, AnnotationDefaults, AnnotationDocument, AnnotationInput, AnnotationPatch, CurrentStyle, DocumentSource, 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";
4
+ import { Select, Toolbar } from "radix-ui";
5
5
  import { IconNode } from "@inkbar/icons";
6
6
  //#region src/context.d.ts
7
- /** Undo and redo for the current document, whichever mode its annotations are in. */
8
- interface InkHistory {
7
+ /**
8
+ * Undo and redo for the current document, whichever mode its annotations are in. `track` and
9
+ * `react` (from `PluginHistory`) reach the same history, so plugin stores undo with the edits.
10
+ */
11
+ interface InkHistory extends PluginHistory {
9
12
  canUndo: boolean;
10
13
  canRedo: boolean;
11
14
  undo: () => void;
@@ -26,6 +29,20 @@ interface InkContext {
26
29
  status: InkStatus;
27
30
  annotations: readonly Annotation[];
28
31
  selection: readonly string[];
32
+ /**
33
+ * The plugins from InkRoot's `plugins` prop, set up once the root has mounted and kept for
34
+ * its life; `null` before that, and on the server. InkViewport hands it to the engine;
35
+ * InkCommand places its commands.
36
+ */
37
+ pluginHost: PluginHost | null;
38
+ /**
39
+ * The search controller from the same set-up as `pluginHost`: shared by the find bar, the
40
+ * search button, the engine's highlights and the plugins. `null` before the root has
41
+ * mounted, and on the server.
42
+ */
43
+ search: SearchController | null;
44
+ /** InkViewport's scroll element while it is mounted: the plugins' `root`. */
45
+ viewportEl: Writable<HTMLElement | null>;
29
46
  /** Set by InkViewport once it has built its viewport and tool controller. */
30
47
  viewport: Viewport | null;
31
48
  tools: ToolController | null;
@@ -137,7 +154,7 @@ export declare function useAnnotations(): {
137
154
  contents?: string | undefined;
138
155
  inReplyTo?: string | undefined;
139
156
  subject?: string | undefined;
140
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
157
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
141
158
  custom?: Record<string, unknown> | undefined;
142
159
  } | {
143
160
  rect: {
@@ -160,7 +177,7 @@ export declare function useAnnotations(): {
160
177
  contents?: string | undefined;
161
178
  inReplyTo?: string | undefined;
162
179
  subject?: string | undefined;
163
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
180
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
164
181
  custom?: Record<string, unknown> | undefined;
165
182
  } | {
166
183
  defaultStyle: {
@@ -210,7 +227,7 @@ export declare function useAnnotations(): {
210
227
  author?: string | undefined;
211
228
  inReplyTo?: string | undefined;
212
229
  subject?: string | undefined;
213
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
230
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
214
231
  custom?: Record<string, unknown> | undefined;
215
232
  } | {
216
233
  rect: {
@@ -236,7 +253,7 @@ export declare function useAnnotations(): {
236
253
  contents?: string | undefined;
237
254
  inReplyTo?: string | undefined;
238
255
  subject?: string | undefined;
239
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
256
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
240
257
  custom?: Record<string, unknown> | undefined;
241
258
  } | {
242
259
  rect: {
@@ -262,7 +279,7 @@ export declare function useAnnotations(): {
262
279
  contents?: string | undefined;
263
280
  inReplyTo?: string | undefined;
264
281
  subject?: string | undefined;
265
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
282
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
266
283
  custom?: Record<string, unknown> | undefined;
267
284
  } | {
268
285
  start: {
@@ -296,7 +313,7 @@ export declare function useAnnotations(): {
296
313
  contents?: string | undefined;
297
314
  inReplyTo?: string | undefined;
298
315
  subject?: string | undefined;
299
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
316
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
300
317
  custom?: Record<string, unknown> | undefined;
301
318
  } | {
302
319
  vertices: {
@@ -327,7 +344,7 @@ export declare function useAnnotations(): {
327
344
  contents?: string | undefined;
328
345
  inReplyTo?: string | undefined;
329
346
  subject?: string | undefined;
330
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
347
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
331
348
  custom?: Record<string, unknown> | undefined;
332
349
  } | {
333
350
  vertices: {
@@ -358,7 +375,7 @@ export declare function useAnnotations(): {
358
375
  contents?: string | undefined;
359
376
  inReplyTo?: string | undefined;
360
377
  subject?: string | undefined;
361
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
378
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
362
379
  custom?: Record<string, unknown> | undefined;
363
380
  } | {
364
381
  inklist: {
@@ -387,7 +404,7 @@ export declare function useAnnotations(): {
387
404
  contents?: string | undefined;
388
405
  inReplyTo?: string | undefined;
389
406
  subject?: string | undefined;
390
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
407
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
391
408
  custom?: Record<string, unknown> | undefined;
392
409
  } | {
393
410
  rect: {
@@ -411,7 +428,7 @@ export declare function useAnnotations(): {
411
428
  contents?: string | undefined;
412
429
  inReplyTo?: string | undefined;
413
430
  subject?: string | undefined;
414
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
431
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
415
432
  custom?: Record<string, unknown> | undefined;
416
433
  } | {
417
434
  rect: {
@@ -435,7 +452,7 @@ export declare function useAnnotations(): {
435
452
  contents?: string | undefined;
436
453
  inReplyTo?: string | undefined;
437
454
  subject?: string | undefined;
438
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
455
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
439
456
  custom?: Record<string, unknown> | undefined;
440
457
  } | {
441
458
  rect: {
@@ -459,7 +476,7 @@ export declare function useAnnotations(): {
459
476
  contents?: string | undefined;
460
477
  inReplyTo?: string | undefined;
461
478
  subject?: string | undefined;
462
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
479
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
463
480
  custom?: Record<string, unknown> | undefined;
464
481
  } | {
465
482
  interiorColor: string;
@@ -501,7 +518,7 @@ export declare function useAnnotations(): {
501
518
  contents?: string | undefined;
502
519
  inReplyTo?: string | undefined;
503
520
  subject?: string | undefined;
504
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
521
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
505
522
  custom?: Record<string, unknown> | undefined;
506
523
  } | undefined;
507
524
  update: (id: string, patch: AnnotationPatch) => {
@@ -542,7 +559,7 @@ export declare function useAnnotations(): {
542
559
  contents?: string | undefined;
543
560
  inReplyTo?: string | undefined;
544
561
  subject?: string | undefined;
545
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
562
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
546
563
  custom?: Record<string, unknown> | undefined;
547
564
  } | {
548
565
  rect: {
@@ -565,7 +582,7 @@ export declare function useAnnotations(): {
565
582
  contents?: string | undefined;
566
583
  inReplyTo?: string | undefined;
567
584
  subject?: string | undefined;
568
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
585
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
569
586
  custom?: Record<string, unknown> | undefined;
570
587
  } | {
571
588
  defaultStyle: {
@@ -615,7 +632,7 @@ export declare function useAnnotations(): {
615
632
  author?: string | undefined;
616
633
  inReplyTo?: string | undefined;
617
634
  subject?: string | undefined;
618
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
635
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
619
636
  custom?: Record<string, unknown> | undefined;
620
637
  } | {
621
638
  rect: {
@@ -641,7 +658,7 @@ export declare function useAnnotations(): {
641
658
  contents?: string | undefined;
642
659
  inReplyTo?: string | undefined;
643
660
  subject?: string | undefined;
644
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
661
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
645
662
  custom?: Record<string, unknown> | undefined;
646
663
  } | {
647
664
  rect: {
@@ -667,7 +684,7 @@ export declare function useAnnotations(): {
667
684
  contents?: string | undefined;
668
685
  inReplyTo?: string | undefined;
669
686
  subject?: string | undefined;
670
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
687
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
671
688
  custom?: Record<string, unknown> | undefined;
672
689
  } | {
673
690
  start: {
@@ -701,7 +718,7 @@ export declare function useAnnotations(): {
701
718
  contents?: string | undefined;
702
719
  inReplyTo?: string | undefined;
703
720
  subject?: string | undefined;
704
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
721
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
705
722
  custom?: Record<string, unknown> | undefined;
706
723
  } | {
707
724
  vertices: {
@@ -732,7 +749,7 @@ export declare function useAnnotations(): {
732
749
  contents?: string | undefined;
733
750
  inReplyTo?: string | undefined;
734
751
  subject?: string | undefined;
735
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
752
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
736
753
  custom?: Record<string, unknown> | undefined;
737
754
  } | {
738
755
  vertices: {
@@ -763,7 +780,7 @@ export declare function useAnnotations(): {
763
780
  contents?: string | undefined;
764
781
  inReplyTo?: string | undefined;
765
782
  subject?: string | undefined;
766
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
783
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
767
784
  custom?: Record<string, unknown> | undefined;
768
785
  } | {
769
786
  inklist: {
@@ -792,7 +809,7 @@ export declare function useAnnotations(): {
792
809
  contents?: string | undefined;
793
810
  inReplyTo?: string | undefined;
794
811
  subject?: string | undefined;
795
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
812
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
796
813
  custom?: Record<string, unknown> | undefined;
797
814
  } | {
798
815
  rect: {
@@ -816,7 +833,7 @@ export declare function useAnnotations(): {
816
833
  contents?: string | undefined;
817
834
  inReplyTo?: string | undefined;
818
835
  subject?: string | undefined;
819
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
836
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
820
837
  custom?: Record<string, unknown> | undefined;
821
838
  } | {
822
839
  rect: {
@@ -840,7 +857,7 @@ export declare function useAnnotations(): {
840
857
  contents?: string | undefined;
841
858
  inReplyTo?: string | undefined;
842
859
  subject?: string | undefined;
843
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
860
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
844
861
  custom?: Record<string, unknown> | undefined;
845
862
  } | {
846
863
  rect: {
@@ -864,7 +881,7 @@ export declare function useAnnotations(): {
864
881
  contents?: string | undefined;
865
882
  inReplyTo?: string | undefined;
866
883
  subject?: string | undefined;
867
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
884
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
868
885
  custom?: Record<string, unknown> | undefined;
869
886
  } | {
870
887
  interiorColor: string;
@@ -906,7 +923,7 @@ export declare function useAnnotations(): {
906
923
  contents?: string | undefined;
907
924
  inReplyTo?: string | undefined;
908
925
  subject?: string | undefined;
909
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
926
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
910
927
  custom?: Record<string, unknown> | undefined;
911
928
  } | undefined;
912
929
  remove: (id: string) => boolean;
@@ -949,7 +966,7 @@ export declare function useAnnotations(): {
949
966
  contents?: string | undefined;
950
967
  inReplyTo?: string | undefined;
951
968
  subject?: string | undefined;
952
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
969
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
953
970
  custom?: Record<string, unknown> | undefined;
954
971
  } | {
955
972
  rect: {
@@ -972,7 +989,7 @@ export declare function useAnnotations(): {
972
989
  contents?: string | undefined;
973
990
  inReplyTo?: string | undefined;
974
991
  subject?: string | undefined;
975
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
992
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
976
993
  custom?: Record<string, unknown> | undefined;
977
994
  } | {
978
995
  defaultStyle: {
@@ -1022,7 +1039,7 @@ export declare function useAnnotations(): {
1022
1039
  author?: string | undefined;
1023
1040
  inReplyTo?: string | undefined;
1024
1041
  subject?: string | undefined;
1025
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1042
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1026
1043
  custom?: Record<string, unknown> | undefined;
1027
1044
  } | {
1028
1045
  rect: {
@@ -1048,7 +1065,7 @@ export declare function useAnnotations(): {
1048
1065
  contents?: string | undefined;
1049
1066
  inReplyTo?: string | undefined;
1050
1067
  subject?: string | undefined;
1051
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1068
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1052
1069
  custom?: Record<string, unknown> | undefined;
1053
1070
  } | {
1054
1071
  rect: {
@@ -1074,7 +1091,7 @@ export declare function useAnnotations(): {
1074
1091
  contents?: string | undefined;
1075
1092
  inReplyTo?: string | undefined;
1076
1093
  subject?: string | undefined;
1077
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1094
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1078
1095
  custom?: Record<string, unknown> | undefined;
1079
1096
  } | {
1080
1097
  start: {
@@ -1108,7 +1125,7 @@ export declare function useAnnotations(): {
1108
1125
  contents?: string | undefined;
1109
1126
  inReplyTo?: string | undefined;
1110
1127
  subject?: string | undefined;
1111
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1128
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1112
1129
  custom?: Record<string, unknown> | undefined;
1113
1130
  } | {
1114
1131
  vertices: {
@@ -1139,7 +1156,7 @@ export declare function useAnnotations(): {
1139
1156
  contents?: string | undefined;
1140
1157
  inReplyTo?: string | undefined;
1141
1158
  subject?: string | undefined;
1142
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1159
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1143
1160
  custom?: Record<string, unknown> | undefined;
1144
1161
  } | {
1145
1162
  vertices: {
@@ -1170,7 +1187,7 @@ export declare function useAnnotations(): {
1170
1187
  contents?: string | undefined;
1171
1188
  inReplyTo?: string | undefined;
1172
1189
  subject?: string | undefined;
1173
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1190
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1174
1191
  custom?: Record<string, unknown> | undefined;
1175
1192
  } | {
1176
1193
  inklist: {
@@ -1199,7 +1216,7 @@ export declare function useAnnotations(): {
1199
1216
  contents?: string | undefined;
1200
1217
  inReplyTo?: string | undefined;
1201
1218
  subject?: string | undefined;
1202
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1219
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1203
1220
  custom?: Record<string, unknown> | undefined;
1204
1221
  } | {
1205
1222
  rect: {
@@ -1223,7 +1240,7 @@ export declare function useAnnotations(): {
1223
1240
  contents?: string | undefined;
1224
1241
  inReplyTo?: string | undefined;
1225
1242
  subject?: string | undefined;
1226
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1243
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1227
1244
  custom?: Record<string, unknown> | undefined;
1228
1245
  } | {
1229
1246
  rect: {
@@ -1247,7 +1264,7 @@ export declare function useAnnotations(): {
1247
1264
  contents?: string | undefined;
1248
1265
  inReplyTo?: string | undefined;
1249
1266
  subject?: string | undefined;
1250
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1267
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1251
1268
  custom?: Record<string, unknown> | undefined;
1252
1269
  } | {
1253
1270
  rect: {
@@ -1271,7 +1288,7 @@ export declare function useAnnotations(): {
1271
1288
  contents?: string | undefined;
1272
1289
  inReplyTo?: string | undefined;
1273
1290
  subject?: string | undefined;
1274
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1291
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1275
1292
  custom?: Record<string, unknown> | undefined;
1276
1293
  } | {
1277
1294
  interiorColor: string;
@@ -1313,7 +1330,7 @@ export declare function useAnnotations(): {
1313
1330
  contents?: string | undefined;
1314
1331
  inReplyTo?: string | undefined;
1315
1332
  subject?: string | undefined;
1316
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1333
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1317
1334
  custom?: Record<string, unknown> | undefined;
1318
1335
  })[];
1319
1336
  selection: readonly string[];
@@ -1355,7 +1372,7 @@ export declare function useAnnotations(): {
1355
1372
  contents?: string | undefined;
1356
1373
  inReplyTo?: string | undefined;
1357
1374
  subject?: string | undefined;
1358
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1375
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1359
1376
  custom?: Record<string, unknown> | undefined;
1360
1377
  } | {
1361
1378
  rect: {
@@ -1378,7 +1395,7 @@ export declare function useAnnotations(): {
1378
1395
  contents?: string | undefined;
1379
1396
  inReplyTo?: string | undefined;
1380
1397
  subject?: string | undefined;
1381
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1398
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1382
1399
  custom?: Record<string, unknown> | undefined;
1383
1400
  } | {
1384
1401
  defaultStyle: {
@@ -1428,7 +1445,7 @@ export declare function useAnnotations(): {
1428
1445
  author?: string | undefined;
1429
1446
  inReplyTo?: string | undefined;
1430
1447
  subject?: string | undefined;
1431
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1448
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1432
1449
  custom?: Record<string, unknown> | undefined;
1433
1450
  } | {
1434
1451
  rect: {
@@ -1454,7 +1471,7 @@ export declare function useAnnotations(): {
1454
1471
  contents?: string | undefined;
1455
1472
  inReplyTo?: string | undefined;
1456
1473
  subject?: string | undefined;
1457
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1474
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1458
1475
  custom?: Record<string, unknown> | undefined;
1459
1476
  } | {
1460
1477
  rect: {
@@ -1480,7 +1497,7 @@ export declare function useAnnotations(): {
1480
1497
  contents?: string | undefined;
1481
1498
  inReplyTo?: string | undefined;
1482
1499
  subject?: string | undefined;
1483
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1500
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1484
1501
  custom?: Record<string, unknown> | undefined;
1485
1502
  } | {
1486
1503
  start: {
@@ -1514,7 +1531,7 @@ export declare function useAnnotations(): {
1514
1531
  contents?: string | undefined;
1515
1532
  inReplyTo?: string | undefined;
1516
1533
  subject?: string | undefined;
1517
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1534
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1518
1535
  custom?: Record<string, unknown> | undefined;
1519
1536
  } | {
1520
1537
  vertices: {
@@ -1545,7 +1562,7 @@ export declare function useAnnotations(): {
1545
1562
  contents?: string | undefined;
1546
1563
  inReplyTo?: string | undefined;
1547
1564
  subject?: string | undefined;
1548
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1565
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1549
1566
  custom?: Record<string, unknown> | undefined;
1550
1567
  } | {
1551
1568
  vertices: {
@@ -1576,7 +1593,7 @@ export declare function useAnnotations(): {
1576
1593
  contents?: string | undefined;
1577
1594
  inReplyTo?: string | undefined;
1578
1595
  subject?: string | undefined;
1579
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1596
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1580
1597
  custom?: Record<string, unknown> | undefined;
1581
1598
  } | {
1582
1599
  inklist: {
@@ -1605,7 +1622,7 @@ export declare function useAnnotations(): {
1605
1622
  contents?: string | undefined;
1606
1623
  inReplyTo?: string | undefined;
1607
1624
  subject?: string | undefined;
1608
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1625
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1609
1626
  custom?: Record<string, unknown> | undefined;
1610
1627
  } | {
1611
1628
  rect: {
@@ -1629,7 +1646,7 @@ export declare function useAnnotations(): {
1629
1646
  contents?: string | undefined;
1630
1647
  inReplyTo?: string | undefined;
1631
1648
  subject?: string | undefined;
1632
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1649
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1633
1650
  custom?: Record<string, unknown> | undefined;
1634
1651
  } | {
1635
1652
  rect: {
@@ -1653,7 +1670,7 @@ export declare function useAnnotations(): {
1653
1670
  contents?: string | undefined;
1654
1671
  inReplyTo?: string | undefined;
1655
1672
  subject?: string | undefined;
1656
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1673
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1657
1674
  custom?: Record<string, unknown> | undefined;
1658
1675
  } | {
1659
1676
  rect: {
@@ -1677,7 +1694,7 @@ export declare function useAnnotations(): {
1677
1694
  contents?: string | undefined;
1678
1695
  inReplyTo?: string | undefined;
1679
1696
  subject?: string | undefined;
1680
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1697
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1681
1698
  custom?: Record<string, unknown> | undefined;
1682
1699
  } | {
1683
1700
  interiorColor: string;
@@ -1719,7 +1736,7 @@ export declare function useAnnotations(): {
1719
1736
  contents?: string | undefined;
1720
1737
  inReplyTo?: string | undefined;
1721
1738
  subject?: string | undefined;
1722
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1739
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1723
1740
  custom?: Record<string, unknown> | undefined;
1724
1741
  })[];
1725
1742
  byPage: (page: number) => ({
@@ -1760,7 +1777,7 @@ export declare function useAnnotations(): {
1760
1777
  contents?: string | undefined;
1761
1778
  inReplyTo?: string | undefined;
1762
1779
  subject?: string | undefined;
1763
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1780
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1764
1781
  custom?: Record<string, unknown> | undefined;
1765
1782
  } | {
1766
1783
  rect: {
@@ -1783,7 +1800,7 @@ export declare function useAnnotations(): {
1783
1800
  contents?: string | undefined;
1784
1801
  inReplyTo?: string | undefined;
1785
1802
  subject?: string | undefined;
1786
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1803
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1787
1804
  custom?: Record<string, unknown> | undefined;
1788
1805
  } | {
1789
1806
  defaultStyle: {
@@ -1833,7 +1850,7 @@ export declare function useAnnotations(): {
1833
1850
  author?: string | undefined;
1834
1851
  inReplyTo?: string | undefined;
1835
1852
  subject?: string | undefined;
1836
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1853
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1837
1854
  custom?: Record<string, unknown> | undefined;
1838
1855
  } | {
1839
1856
  rect: {
@@ -1859,7 +1876,7 @@ export declare function useAnnotations(): {
1859
1876
  contents?: string | undefined;
1860
1877
  inReplyTo?: string | undefined;
1861
1878
  subject?: string | undefined;
1862
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1879
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1863
1880
  custom?: Record<string, unknown> | undefined;
1864
1881
  } | {
1865
1882
  rect: {
@@ -1885,7 +1902,7 @@ export declare function useAnnotations(): {
1885
1902
  contents?: string | undefined;
1886
1903
  inReplyTo?: string | undefined;
1887
1904
  subject?: string | undefined;
1888
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1905
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1889
1906
  custom?: Record<string, unknown> | undefined;
1890
1907
  } | {
1891
1908
  start: {
@@ -1919,7 +1936,7 @@ export declare function useAnnotations(): {
1919
1936
  contents?: string | undefined;
1920
1937
  inReplyTo?: string | undefined;
1921
1938
  subject?: string | undefined;
1922
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1939
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1923
1940
  custom?: Record<string, unknown> | undefined;
1924
1941
  } | {
1925
1942
  vertices: {
@@ -1950,7 +1967,7 @@ export declare function useAnnotations(): {
1950
1967
  contents?: string | undefined;
1951
1968
  inReplyTo?: string | undefined;
1952
1969
  subject?: string | undefined;
1953
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1970
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1954
1971
  custom?: Record<string, unknown> | undefined;
1955
1972
  } | {
1956
1973
  vertices: {
@@ -1981,7 +1998,7 @@ export declare function useAnnotations(): {
1981
1998
  contents?: string | undefined;
1982
1999
  inReplyTo?: string | undefined;
1983
2000
  subject?: string | undefined;
1984
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2001
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1985
2002
  custom?: Record<string, unknown> | undefined;
1986
2003
  } | {
1987
2004
  inklist: {
@@ -2010,7 +2027,7 @@ export declare function useAnnotations(): {
2010
2027
  contents?: string | undefined;
2011
2028
  inReplyTo?: string | undefined;
2012
2029
  subject?: string | undefined;
2013
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2030
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2014
2031
  custom?: Record<string, unknown> | undefined;
2015
2032
  } | {
2016
2033
  rect: {
@@ -2034,7 +2051,7 @@ export declare function useAnnotations(): {
2034
2051
  contents?: string | undefined;
2035
2052
  inReplyTo?: string | undefined;
2036
2053
  subject?: string | undefined;
2037
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2054
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2038
2055
  custom?: Record<string, unknown> | undefined;
2039
2056
  } | {
2040
2057
  rect: {
@@ -2058,7 +2075,7 @@ export declare function useAnnotations(): {
2058
2075
  contents?: string | undefined;
2059
2076
  inReplyTo?: string | undefined;
2060
2077
  subject?: string | undefined;
2061
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2078
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2062
2079
  custom?: Record<string, unknown> | undefined;
2063
2080
  } | {
2064
2081
  rect: {
@@ -2082,7 +2099,7 @@ export declare function useAnnotations(): {
2082
2099
  contents?: string | undefined;
2083
2100
  inReplyTo?: string | undefined;
2084
2101
  subject?: string | undefined;
2085
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2102
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2086
2103
  custom?: Record<string, unknown> | undefined;
2087
2104
  } | {
2088
2105
  interiorColor: string;
@@ -2124,7 +2141,7 @@ export declare function useAnnotations(): {
2124
2141
  contents?: string | undefined;
2125
2142
  inReplyTo?: string | undefined;
2126
2143
  subject?: string | undefined;
2127
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2144
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2128
2145
  custom?: Record<string, unknown> | undefined;
2129
2146
  })[];
2130
2147
  /** Replies in creation order for a note id. */
@@ -2166,7 +2183,7 @@ export declare function useAnnotations(): {
2166
2183
  contents?: string | undefined;
2167
2184
  inReplyTo?: string | undefined;
2168
2185
  subject?: string | undefined;
2169
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2186
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2170
2187
  custom?: Record<string, unknown> | undefined;
2171
2188
  } | {
2172
2189
  rect: {
@@ -2189,7 +2206,7 @@ export declare function useAnnotations(): {
2189
2206
  contents?: string | undefined;
2190
2207
  inReplyTo?: string | undefined;
2191
2208
  subject?: string | undefined;
2192
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2209
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2193
2210
  custom?: Record<string, unknown> | undefined;
2194
2211
  } | {
2195
2212
  defaultStyle: {
@@ -2239,7 +2256,7 @@ export declare function useAnnotations(): {
2239
2256
  author?: string | undefined;
2240
2257
  inReplyTo?: string | undefined;
2241
2258
  subject?: string | undefined;
2242
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2259
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2243
2260
  custom?: Record<string, unknown> | undefined;
2244
2261
  } | {
2245
2262
  rect: {
@@ -2265,7 +2282,7 @@ export declare function useAnnotations(): {
2265
2282
  contents?: string | undefined;
2266
2283
  inReplyTo?: string | undefined;
2267
2284
  subject?: string | undefined;
2268
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2285
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2269
2286
  custom?: Record<string, unknown> | undefined;
2270
2287
  } | {
2271
2288
  rect: {
@@ -2291,7 +2308,7 @@ export declare function useAnnotations(): {
2291
2308
  contents?: string | undefined;
2292
2309
  inReplyTo?: string | undefined;
2293
2310
  subject?: string | undefined;
2294
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2311
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2295
2312
  custom?: Record<string, unknown> | undefined;
2296
2313
  } | {
2297
2314
  start: {
@@ -2325,7 +2342,7 @@ export declare function useAnnotations(): {
2325
2342
  contents?: string | undefined;
2326
2343
  inReplyTo?: string | undefined;
2327
2344
  subject?: string | undefined;
2328
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2345
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2329
2346
  custom?: Record<string, unknown> | undefined;
2330
2347
  } | {
2331
2348
  vertices: {
@@ -2356,7 +2373,7 @@ export declare function useAnnotations(): {
2356
2373
  contents?: string | undefined;
2357
2374
  inReplyTo?: string | undefined;
2358
2375
  subject?: string | undefined;
2359
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2376
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2360
2377
  custom?: Record<string, unknown> | undefined;
2361
2378
  } | {
2362
2379
  vertices: {
@@ -2387,7 +2404,7 @@ export declare function useAnnotations(): {
2387
2404
  contents?: string | undefined;
2388
2405
  inReplyTo?: string | undefined;
2389
2406
  subject?: string | undefined;
2390
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2407
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2391
2408
  custom?: Record<string, unknown> | undefined;
2392
2409
  } | {
2393
2410
  inklist: {
@@ -2416,7 +2433,7 @@ export declare function useAnnotations(): {
2416
2433
  contents?: string | undefined;
2417
2434
  inReplyTo?: string | undefined;
2418
2435
  subject?: string | undefined;
2419
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2436
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2420
2437
  custom?: Record<string, unknown> | undefined;
2421
2438
  } | {
2422
2439
  rect: {
@@ -2440,7 +2457,7 @@ export declare function useAnnotations(): {
2440
2457
  contents?: string | undefined;
2441
2458
  inReplyTo?: string | undefined;
2442
2459
  subject?: string | undefined;
2443
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2460
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2444
2461
  custom?: Record<string, unknown> | undefined;
2445
2462
  } | {
2446
2463
  rect: {
@@ -2464,7 +2481,7 @@ export declare function useAnnotations(): {
2464
2481
  contents?: string | undefined;
2465
2482
  inReplyTo?: string | undefined;
2466
2483
  subject?: string | undefined;
2467
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2484
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2468
2485
  custom?: Record<string, unknown> | undefined;
2469
2486
  } | {
2470
2487
  rect: {
@@ -2488,7 +2505,7 @@ export declare function useAnnotations(): {
2488
2505
  contents?: string | undefined;
2489
2506
  inReplyTo?: string | undefined;
2490
2507
  subject?: string | undefined;
2491
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2508
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2492
2509
  custom?: Record<string, unknown> | undefined;
2493
2510
  } | {
2494
2511
  interiorColor: string;
@@ -2530,7 +2547,7 @@ export declare function useAnnotations(): {
2530
2547
  contents?: string | undefined;
2531
2548
  inReplyTo?: string | undefined;
2532
2549
  subject?: string | undefined;
2533
- intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2550
+ intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2534
2551
  custom?: Record<string, unknown> | undefined;
2535
2552
  })[];
2536
2553
  };
@@ -2594,6 +2611,17 @@ export declare function useZoom(): {
2594
2611
  zoomOut: () => void | undefined;
2595
2612
  };
2596
2613
  //#endregion
2614
+ //#region src/hooks/useSearch.d.ts
2615
+ /**
2616
+ * The document search for hosts building their own control: the state, and the actions the
2617
+ * find bar uses. Search is set up once InkRoot has mounted, so until then (and on the server)
2618
+ * the state is closed and the actions do nothing. `open()` runs the search and draws the
2619
+ * highlights even when no find bar is mounted.
2620
+ */
2621
+ export declare function useSearch(): {
2622
+ state: SearchState;
2623
+ } & Omit<ViewerSearch, 'state'>;
2624
+ //#endregion
2597
2625
  //#region src/hooks/usePage.d.ts
2598
2626
  export declare function usePage(): {
2599
2627
  /** 0-based. */
@@ -2620,6 +2648,28 @@ export declare function useEmbedded(): {
2620
2648
  hasAny: boolean;
2621
2649
  };
2622
2650
  //#endregion
2651
+ //#region src/hooks/useCommand.d.ts
2652
+ interface CommandHandle {
2653
+ /** Runs the command; does nothing while it is busy or disabled. Never rejects. */
2654
+ run: () => Promise<void>;
2655
+ /** A ready document (or the plugin's own condition), and not busy. */
2656
+ enabled: boolean;
2657
+ busy: boolean;
2658
+ /** The command's progress or result message, `''` without one. */
2659
+ status: string;
2660
+ /** `''` until the plugins are set up. */
2661
+ label: string;
2662
+ icon: IconNode | undefined;
2663
+ }
2664
+ /**
2665
+ * A plugin command by its namespaced id (`sandbox.suggest`), for hosts building their own
2666
+ * control. Plugins are set up once InkRoot has mounted, so until then (and on the server) the
2667
+ * command is disabled with no label; it fills in then. Once they are set up, an id no plugin
2668
+ * passed to InkRoot registered stays that way, and logs `InkError('UnknownCommand')` to the
2669
+ * console once.
2670
+ */
2671
+ export declare function useCommand(id: string): CommandHandle;
2672
+ //#endregion
2623
2673
  //#region src/components/InkRoot.d.ts
2624
2674
  interface InkRootHandle {
2625
2675
  readonly document: InkDocument | null;
@@ -2649,6 +2699,12 @@ interface InkRootProps extends Omit<ComponentPropsWithoutRef<'div'>, 'children'
2649
2699
  * document opens.
2650
2700
  */
2651
2701
  tools?: Tool[] | undefined;
2702
+ /**
2703
+ * Plugins, set up once when the root mounts; a later change to this prop is not applied.
2704
+ * Their tools join `tools`, their decoration and page layers apply to every document, and
2705
+ * their commands are placed with `InkCommand` or `useCommand`.
2706
+ */
2707
+ plugins?: InkPlugin$1[] | undefined;
2652
2708
  /**
2653
2709
  * Adds `data-*` attributes, classes and a screen-reader description to each annotation's
2654
2710
  * element (see `DecorateAnnotation`). Decorations re-apply whenever the annotations change
@@ -2685,7 +2741,7 @@ interface InkRootProps extends Omit<ComponentPropsWithoutRef<'div'>, 'children'
2685
2741
  }) => ReactNode);
2686
2742
  ref?: Ref<InkRootHandle>;
2687
2743
  }
2688
- export declare function InkRoot({ src, assets, password, defaults, annotations, onAnnotationsChange, onChange, tool, onToolChange, tools: hostTools, decorateAnnotation, fonts: fontsProp, signatures: signatureStore, signatureFonts: signatureFontsProp, page, onPageChange, zoom, onZoomChange, history, asChild, onReady, onError, onActivate, children, ref, ...rest }: InkRootProps): import("react").JSX.Element;
2744
+ export declare function InkRoot({ src, assets, password, defaults, annotations, onAnnotationsChange, onChange, tool, onToolChange, tools: hostTools, plugins: pluginsProp, decorateAnnotation, fonts: fontsProp, signatures: signatureStore, signatureFonts: signatureFontsProp, page, onPageChange, zoom, onZoomChange, history, asChild, onReady, onError, onActivate, children, ref, ...rest }: InkRootProps): import("react").JSX.Element;
2689
2745
  //#endregion
2690
2746
  //#region src/components/InkViewport.d.ts
2691
2747
  interface InkViewportProps extends ComponentPropsWithoutRef<'div'> {
@@ -2764,6 +2820,18 @@ interface InkToolButtonProps extends Omit<ComponentPropsWithoutRef<'button'>, 'c
2764
2820
  }
2765
2821
  export declare function InkToolButton({ tool, label, asChild, className, children, onClick, ...rest }: InkToolButtonProps): import("react").JSX.Element;
2766
2822
  //#endregion
2823
+ //#region src/components/InkCommand.d.ts
2824
+ interface InkCommandProps extends Omit<ComponentPropsWithoutRef<'button'>, 'id' | 'children'> {
2825
+ /** The command's namespaced id, such as `sandbox.suggest`. */
2826
+ id: string;
2827
+ asChild?: boolean;
2828
+ children?: ReactNode | ((props: {
2829
+ label: string;
2830
+ busy: boolean;
2831
+ }) => ReactNode);
2832
+ }
2833
+ export declare function InkCommand({ id, asChild, children, disabled, onClick, ...rest }: InkCommandProps): import("react").JSX.Element;
2834
+ //#endregion
2767
2835
  //#region src/components/InkToolbarSeparator.d.ts
2768
2836
  type InkToolbarSeparatorProps = ComponentPropsWithoutRef<'div'>;
2769
2837
  /**
@@ -2784,6 +2852,31 @@ export declare function InkUndo({ asChild, className, children, disabled, onClic
2784
2852
  //#region src/components/InkRedo.d.ts
2785
2853
  export declare function InkRedo({ asChild, className, children, disabled, onClick, ...rest }: InkHistoryButtonProps): import("react").JSX.Element;
2786
2854
  //#endregion
2855
+ //#region src/components/InkSearchButton.d.ts
2856
+ type InkSearchButtonProps = ComponentPropsWithoutRef<typeof Toolbar.Button>;
2857
+ /**
2858
+ * Opens the find bar; pressed while it is open. Pressing it again focuses the field. Place it
2859
+ * in a toolbar next to `InkFindBar`, which it needs for the field to focus. Disabled until a
2860
+ * document is open.
2861
+ */
2862
+ export declare function InkSearchButton({ asChild, className, children, disabled, onClick, ...rest }: InkSearchButtonProps): import("react").JSX.Element;
2863
+ //#endregion
2864
+ //#region src/components/InkFindBar.d.ts
2865
+ type InkFindBarProps = Omit<ComponentPropsWithoutRef<'div'>, 'children'>;
2866
+ /**
2867
+ * The find bar: a field, the match count, previous and next, a match-case toggle and close,
2868
+ * a view of the root's search state. Place it anywhere inside `InkRoot`: it portals itself
2869
+ * into `[data-ink-viewport-root]`, the positioned ancestor the theme floats it from over the
2870
+ * top-right of the pages (as `InkThreadPopover` anchors to the root's overlay rather than
2871
+ * where it is written). It renders nothing until `InkViewport` has mounted, and is hidden
2872
+ * while the search is closed. While it is mounted it registers with the search controller,
2873
+ * which is what lets Ctrl/Cmd+F open it.
2874
+ *
2875
+ * Enter in the field steps to the next match, Shift+Enter to the previous, Escape closes.
2876
+ * Closing returns focus to where it was before the bar opened, else to the document.
2877
+ */
2878
+ export declare function InkFindBar({ className, ...rest }: InkFindBarProps): import("react").ReactPortal | null;
2879
+ //#endregion
2787
2880
  //#region src/components/zoom-button.d.ts
2788
2881
  /** Props of `InkZoomIn` and `InkZoomOut`: a toolbar button that may render as its child. */
2789
2882
  interface InkZoomButtonProps extends ComponentPropsWithoutRef<'button'> {
@@ -2898,5 +2991,5 @@ interface InkThreadPopoverProps {
2898
2991
  }
2899
2992
  export declare function InkThreadPopover({ children }: InkThreadPopoverProps): import("react").JSX.Element;
2900
2993
  //#endregion
2901
- export type { AnnotationDecoration, AnnotationSlotProps, AnnotationState, DecorateAnnotation, InkAnnotationProps, InkColorMenuProps, InkContext, InkHighlightMenuProps, InkHistory, InkHistoryButtonProps, InkIconProps, InkLineStyleMenuProps, InkPageButtonProps, InkPageInputProps, InkPageProps, InkRootHandle, InkRootProps, InkShapeMenuProps, InkSignatureDialogProps, InkSignatureMenuProps, InkStatus, InkTextStyleMenuProps, InkThreadPopoverProps, InkToolButtonProps, InkToolbarProps, InkToolbarSeparatorProps, InkViewportProps, InkZoomButtonProps, InkZoomSelectProps, ScopedToolStyleHandle, ThreadPopoverSlotProps, ToolStyleHandle };
2994
+ export type { AnnotationDecoration, AnnotationSlotProps, AnnotationState, CommandHandle, DecorateAnnotation, InkAnnotationProps, InkColorMenuProps, InkCommandProps, InkContext, InkFindBarProps, InkHighlightMenuProps, InkHistory, InkHistoryButtonProps, InkIconProps, InkLineStyleMenuProps, InkPageButtonProps, InkPageInputProps, InkPageProps, InkPlugin, InkRootHandle, InkRootProps, InkSearchButtonProps, InkShapeMenuProps, InkSignatureDialogProps, InkSignatureMenuProps, InkStatus, InkTextStyleMenuProps, InkThreadPopoverProps, InkToolButtonProps, InkToolbarProps, InkToolbarSeparatorProps, InkViewportProps, InkZoomButtonProps, InkZoomSelectProps, ScopedToolStyleHandle, ThreadPopoverSlotProps, ToolStyleHandle };
2902
2995
  //# sourceMappingURL=index.d.mts.map