@types/react-curved-text
TypeScript icon, indicating that this package has built-in type declarations

2.0.3 • Public • Published

Installation

npm install --save @types/react-curved-text

Summary

This package contains type definitions for react-curved-text (https://obss.github.io/react-curved-text).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-curved-text.

index.d.ts

import * as React from "react";

export default class ReactCurvedText extends React.Component<
    ReactCurvedTextProps,
    any
> {}

export interface ReactCurvedTextProps {
    /**
     * Text to be displayed
     */
    text: string;

    /**
     * Width of the SVG
     */
    width: number;

    /**
     * Height of the SVG
     */
    height: number;

    /**
     * Center x of the ellipse
     */
    cx: number;

    /**
     * Center y of the ellipse
     */
    cy: number;

    /**
     * Radius x of the ellipse
     */
    rx: number;

    /**
     * Radius y of the ellipse
     */
    ry: number;

    /**
     * Start offset of the text
     */
    startOffset?: number;

    /**
     * Reverse the text path
     */
    reversed?: boolean;

    /**
     * Props to be passed to the text element
     */
    textProps?: React.SVGTextElementAttributes<SVGTextElement>;

    /**
     * Props to be passed to the textPath element
     */
    textPathProps?: React.SVGProps<SVGTextPathElement>;

    /**
     * Props to be passed to the tspan element
     */
    tspanProps?: React.SVGProps<SVGTSpanElement>;

    /**
     * Props to be passed to the ellipse element
     */
    ellipseProps?: React.SVGProps<SVGEllipseElement>;

    /**
     * Props to be passed to the svg element
     */
    svgProps?: React.SVGProps<SVGSVGElement>;
}

Additional Details

  • Last updated: Tue, 07 Nov 2023 09:09:39 GMT
  • Dependencies: @types/react

Credits

These definitions were written by Sam Gaus.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/react-curved-text

Weekly Downloads

282

Version

2.0.3

License

MIT

Unpacked Size

5.38 kB

Total Files

5

Last publish

Collaborators

  • types