@visx/text/lib/types.d.ts

visx text

import { CSSProperties, Ref, SVGAttributes } from 'react';
declare type SVGTSpanProps = SVGAttributes<SVGTSpanElement>;
declare type SVGTextProps = SVGAttributes<SVGTextElement>;
declare type OwnProps = {
    /** className to apply to the SVGText element. */
    className?: string;
    /** Whether to scale the fontSize to accommodate the specified width.  */
    scaleToFit?: boolean | 'shrink-only';
    /** Rotational angle of the text. */
    angle?: number;
    /** Horizontal text anchor. */
    textAnchor?: 'start' | 'middle' | 'end' | 'inherit';
    /** Vertical text anchor. */
    verticalAnchor?: 'start' | 'middle' | 'end';
    /** Styles to be applied to the text (and used in computation of its size). */
    style?: CSSProperties;
    /** Ref passed to the Text SVG element. */
    innerRef?: Ref<SVGSVGElement>;
    /** Ref passed to the Text text element */
    innerTextRef?: Ref<SVGTextElement>;
    /** x position of the text. */
    x?: string | number;
    /** y position of the text. */
    y?: string | number;
    /** dx offset of the text. */
    dx?: string | number;
    /** dy offset of the text. */
    dy?: string | number;
    /** Desired "line height" of the text, implemented as y offsets. */
    lineHeight?: SVGTSpanProps['dy'];
    /** Cap height of the text. */
    capHeight?: SVGTSpanProps['capHeight'];
    /** Font size of text. */
    fontSize?: string | number;
    /** Font family of text. */
    fontFamily?: string;
    /** Fill color of text. */
    fill?: string;
    /** Maximum width to occupy (approximate as words are not split). */
    width?: number;
    /** String (or number coercible to one) to be styled and positioned. */
    children?: string | number;
};
export declare type TextProps = OwnProps & Omit<SVGTextProps, keyof OwnProps>;
export declare type compareFunction<T> = (prev: T | undefined, next: T) => boolean;
export interface WordsWithWidth {
    words: string[];
    width?: number;
}
export {};
//# sourceMappingURL=types.d.ts.map