@gfazioli/mantine-text-animate
Version:
The TextAnimate component allows you to animate text with various effects.
58 lines (57 loc) • 2.25 kB
TypeScript
import { type BoxProps, type PolymorphicFactory, type StylesApiProps } from '@mantine/core';
import React from 'react';
import { type TextTickerBaseProps } from './use-text-ticker';
export type TextTickerStylesNames = 'root';
export type TextTickerCssVariables = {
root: '--text-ticker-animation-duration' | '--text-ticker-animation-delay';
};
export interface TextTickerProps extends BoxProps, TextTickerBaseProps, StylesApiProps<TextTickerFactory> {
}
export type TextTickerFactory = PolymorphicFactory<{
props: TextTickerProps;
defaultComponent: 'p';
defaultRef: HTMLParagraphElement;
stylesNames: TextTickerStylesNames;
vars: TextTickerCssVariables;
}>;
/**
* TextTicker Component
*
* A component that animates text from random characters to a target string.
* This implementation uses the useTextTicker hook internally.
*/
export declare const TextTicker: (<C = "p">(props: import("@mantine/core").PolymorphicComponentProps<C, TextTickerProps>) => React.ReactElement) & Omit<React.FunctionComponent<(TextTickerProps & {
component?: any;
} & Omit<any, "component" | keyof TextTickerProps> & {
ref?: any;
renderRoot?: (props: any) => any;
}) | (TextTickerProps & {
component: React.ElementType;
renderRoot?: (props: Record<string, any>) => any;
})>, never> & import("@mantine/core").ThemeExtend<{
props: TextTickerProps;
defaultComponent: "p";
defaultRef: HTMLParagraphElement;
stylesNames: TextTickerStylesNames;
vars: TextTickerCssVariables;
}> & import("@mantine/core").ComponentClasses<{
props: TextTickerProps;
defaultComponent: "p";
defaultRef: HTMLParagraphElement;
stylesNames: TextTickerStylesNames;
vars: TextTickerCssVariables;
}> & {
varsResolver: import("@mantine/core").VarsResolver<{
props: TextTickerProps;
defaultComponent: "p";
defaultRef: HTMLParagraphElement;
stylesNames: TextTickerStylesNames;
vars: TextTickerCssVariables;
}>;
} & import("@mantine/core").PolymorphicComponentWithProps<{
props: TextTickerProps;
defaultComponent: "p";
defaultRef: HTMLParagraphElement;
stylesNames: TextTickerStylesNames;
vars: TextTickerCssVariables;
}> & Record<string, never>;