react-pdf-builder
Version:
Build beautiful PDF documents in React.
21 lines (20 loc) • 1.08 kB
TypeScript
import { TextProps } from '@react-pdf/renderer';
import React from 'react';
import { SwatchColor } from '../../themes/ColorScheme';
import { BoxProps } from '../layout/Box';
export interface SignatureProps extends BoxProps {
/** Optional. Width of the line in points. */
lineSize?: number;
/** Optional. When `true`, an `X` is shown above the line indicating where to sign. */
x?: boolean;
/** Optional. Props for the `X` shown above the line. */
xProps?: TextProps;
/** Optional. String value of the `X` shown above the line. Defaults to `"X"`. */
xValue?: string;
/** Optional. One of the [swatch color names](https://justinmahar.github.io/react-pdf-builder/?path=/docs/documentation-themes--docs#swatch-colors) from the theme, as a string. */
swatch?: SwatchColor;
}
/**
* Read the [full documentation for Signature](https://justinmahar.github.io/react-pdf-builder/?path=/docs/documentation-components-signature--docs)
*/
export declare const Signature: ({ children, className, style, ...props }: SignatureProps) => React.JSX.Element;