narraleaf-react 0.33.1 → 0.34.0

package/dist/game/player/elements/say/Sentence.d.ts

@@ -36,6 +36,22 @@ export type TextAppearanceProps = {
      * @default true
      */
     tateChuYoko?: TateChuYoko;
+    /**
+     * Set the line down until the whole of it fits the box it is placed in.
+     *
+     * `fontSize` becomes a ceiling rather than a fixed size: the line is set at it whenever the
+     * finished line fits, and smaller when it does not, down to {@link autoFitMinFontSize}. Sizes
+     * carried by the sentence or by a single word scale with it, so their relative weights hold.
+     *
+     * The box is the container's parent, which needs a size of its own for anything to be fitted to.
+     * @default false
+     */
+    autoFit?: boolean;
+    /**
+     * The smallest size auto fit sets, in px. A line that still overflows at it is left overflowing.
+     * @default 12
+     */
+    autoFitMinFontSize?: number;
 };
 export type BaseTextsProps = TextAppearanceProps & {
     className?: string;

package/dist/game/player/elements/say/autoFit.d.ts

@@ -0,0 +1,43 @@
+import React from "react";
+/** Smallest size auto fit sets when the line does not say otherwise. */
+export declare const DEFAULT_AUTO_FIT_MIN_FONT_SIZE = 12;
+/** Set on the measuring copy so every explicit word size scales with one write. */
+export declare const AUTO_FIT_SCALE_VAR = "--nl-auto-fit-scale";
+/**
+ * The same length, scaled, whatever unit it was written in.
+ *
+ * The multiplier is a number for the line on screen and the scale custom property for the copy
+ * being measured, where one write has to resize every word at once.
+ */
+export declare function scaledFontSize(value: React.CSSProperties["fontSize"], scale: number | string): React.CSSProperties["fontSize"];
+/** The multiplier the measuring copy scales by, readable from every word inside it. */
+export declare const AUTO_FIT_SCALE_MULTIPLIER = "var(--nl-auto-fit-scale, 1)";
+/** What the line is set at when it inherits its size: a share of the size it inherits. */
+export declare function inheritedScaledFontSize(scale: number): React.CSSProperties["fontSize"] | undefined;
+export type AutoFitOptions = {
+    enabled: boolean;
+    /** The floor, in px. A line that overflows at this size is left overflowing rather than set smaller. */
+    minFontSize: number;
+    /** Vertical writing swaps the axes: the columns advance across the box, not down it. */
+    vertical: boolean;
+    /** Everything that changes the laid-out result without changing the box. */
+    signature: string;
+};
+export type AutoFitState = {
+    containerRef: React.MutableRefObject<HTMLDivElement | null>;
+    mirrorRef: React.MutableRefObject<HTMLDivElement | null>;
+    /** The share of the authored size the line is set at. */
+    scale: number;
+};
+/**
+ * Finds the largest size at which a whole line still fits the box it is placed in.
+ *
+ * The line being typed is not what has to fit - the finished line is - so the search runs against a
+ * hidden copy holding every word, laid out under the same box, the same typeface and the same
+ * wrapping rules. The copy is what the bisection resizes; the visible line is set once, when the
+ * answer is known, and stays there for the rest of the line.
+ *
+ * The box is the container's parent: a dialog box has a size of its own, and the line is what has
+ * to live inside it. A parent with no height of its own leaves the scale at 1.
+ */
+export declare function useAutoFitScale({ enabled, minFontSize, vertical, signature }: AutoFitOptions): AutoFitState;