@aznabee/freehand-ui 0.1.1 → 0.1.3

package/dist/index.d.ts

@@ -23,17 +23,33 @@ export type DecorationType =
 
 export interface NoteOptions {
   text: string;
-  /** Preferred side. Flips automatically if it would run off screen. */
+  /**
+   * Which side of the element the note sits on. Always honoured — a note that
+   * would run off screen slides horizontally to stay in view rather than
+   * moving to another side.
+   */
   position?: DoodlePosition;
   /** Underline sized to the measured text. Default `true`. */
   underline?: boolean;
+  /**
+   * Nudge the note from where `position` put it, in px. The note is still kept
+   * in view from the offset spot, so a large `x` slides back rather than
+   * running off screen.
+   */
+  offset?: { x?: number; y?: number };
 }
 
 export interface ArrowOptions {
-  from?: DoodlePosition;
+  /**
+   * Where the arrow leaves. With a `note` this names a side of *the note* —
+   * the arrow always departs from the handwriting and travels to the element,
+   * however far an `offset` has moved it. `"note"` (the default) picks the side
+   * facing the element. Without a note it names a side of the element instead.
+   */
+  from?: DoodlePosition | "note";
   /** `"edge"` lands just outside the frame; `"center"` points into it. */
   to?: DoodlePosition | "edge";
-  style?: "curved" | "straight" | "dotted";
+  style?: "curved" | "straight" | "dotted" | "looped";
 }
 
 export interface DecorationOptions {
@@ -59,6 +75,7 @@ export interface DoodleOptions {
   color?: string;
   strokeWidth?: number;
   roughness?: number;
+  /** Gap between the element's edge and the frame. Default `0`. */
   padding?: number;
   /** Auto-detected from CSS when omitted. */
   radius?: number | null;
@@ -70,6 +87,18 @@ export interface DoodleOptions {
   decorations?: boolean | DecorationOptions;
   /** Lift the pen at random points around the outline. */
   addBreaks?: boolean | number | BreakOptions;
+  /**
+   * Font stack for handwritten notes. Point this at your own family — a
+   * `next/font` CSS variable, for instance — to take over from the built-in one.
+   */
+  fontFamily?: string | null;
+  /**
+   * Fetch the Caveat webfont when the page has not already provided it.
+   * Default `true`. Set `false` if a strict CSP blocks Google Fonts, or if you
+   * self-host the family; the notes then use `fontFamily` or the system
+   * handwriting fallbacks.
+   */
+  autoLoadFont?: boolean;
 }
 
 export interface DoodleInstance {