react-loadsvg
TypeScript icon, indicating that this package has built-in type declarations

1.0.5 • Public • Published

LoadSVG

The LoadSVG component is a simple and customizable SVG-based loading spinner. It can be easily integrated into any React application and customized according to the needs of the user.

Installation

To use react-loadsvg in your project, you need to install it first using npm or yarn.

npm install react-loadsvg

or

yarn add react-loadsvg

Usage

Once you have installed the react-loadsvg package, you can use the LoadSVG component in your React application. Here's an example of how to use it:

import LoadSVG from 'react-loadsvg';

function App() {
  return (
    <div>
      <LoadSVG size={50} color="blue" />
    </div>
  );
}

In the example above, the LoadSVG component is imported from the react-loadsvg package and rendered inside a div element. The size and color props are passed to the component to customize its appearance.

Props

The LoadSVG component accepts the following props:

Prop Type Default Description
size number 20 Specifies the size of the spinner in pixels.
stroke number 8 Specifies the width of the spinner stroke in pixels.
backStroke number 0 Specifies the width of the background stroke in pixels. Set to 0 to disable.
duration number 2000 Specifies the duration of the spinner animation in milliseconds.
lineCap string "round" Specifies the line cap style of the spinner stroke. Accepts "butt", "round", or "square".
color string "dodgerblue" Specifies the color of the spinner stroke.
backColor string "transparent" Specifies the color of the background stroke.

Examples

Here are some examples of how to use the LoadSVG component with different props:

Example 1: Changing the size and color

<LoadSVG size={30} color="red" />

Example 2: Disabling the background stroke

<LoadSVG backStroke={0} />

Example 3: Changing the line cap style

<LoadSVG lineCap="square" />

Example 4: Customizing the animation duration

<LoadSVG duration={4000} />

Styling

The LoadSVG component can be styled using CSS, just like any other React component. The class name of the SVG element is loadSVG.

.loadSVG {
  /* CSS styles here */
}

Contributing

Contributions to the react-loadsvg package are welcome and encouraged! If you find a bug or want to suggest an improvement, feel free to open an issue or submit a pull request on the GitHub repository.

License

The react-loadsvg package is licensed under the MIT License.

Package Sidebar

Install

npm i react-loadsvg

Weekly Downloads

4

Version

1.0.5

License

MIT

Unpacked Size

9.89 kB

Total Files

7

Last publish

Collaborators

  • shivamdewangan