1.3.0 • Published 29 days ago

react-zider-ui v1.3.0

Weekly downloads
-
License
ISC
Repository
-
Last release
29 days ago

react-zider-ui

reusable pro react components package

Installation

NPM

$ npm install react-zider-ui

YARN

$ yarn add react-zider-ui

using the component:

import React from 'react';
import InfiniteTypewriter from 'infinite-typewriter';

const App = () => {
  return (
    <div>
      <InfiniteTypewriter
        text="Hello, World!"
        headerLevel="h1"
        gradientType="linear"
        gradient={true}
        gradientColor1="#ff0000"
        gradientColor2="#00ff00"
        gradientColor3="#0000ff"
        gradientDirection="to right"
        cursor="|"
        typingDelay={100}
        eraseDelay={2000}
        loopDelay={1000}
        fontSize="2rem"
        fontStyle="italic"
        onComplete={() => console.log('Typing complete!')}
      />
    </div>
  );
};

export default App;

PROPS

PropNameTypeDefaultDescription
textstringrequiredThe text to be displayed in the typewriter effect.
headerLevelstring'p'The HTML header level for the text (e.g., 'h1', 'h2', 'h3', etc.).
gradientTypestring'linear'The type of gradient to apply ('linear' or 'radial').
gradientbooleanfalseWhether to apply a gradient effect to the text.
gradientColor1string'#ff0000'The first color in the gradient effect (in hexadecimal format).
gradientColor2string'#00ff00'The second color in the gradient effect (in hexadecimal format).
gradientColor3string'#0000ff'The third color in the gradient effect (in hexadecimal format).
gradientDirectionstring'to right'The direction of the linear gradient effect.
cursorstring''The cursor style to be shown during typing.
typingDelaynumber100The delay (in milliseconds) between each character being typed.
eraseDelaynumber2000The delay (in milliseconds) before the text starts erasing after it's fully typed.
loopDelaynumber1000The delay (in milliseconds) before the typewriter effect loops after erasing text.
fontSizestring'1rem'The font size of the text.
fontStylestring'normal'The font style of the text.
onCompletefunctionundefinedA callback function to be called when the typewriter effect completes a loop.

UPDATE

To update the component to the latest version, run:

NPM

$ npm update react-zider-ui

YARN

$ yarn add react-zider-ui