senangwebs-loading v1.1.7

SenangWebs Loading (SWL)

SenangWebs Loading (SWL) is a lightweight JavaScript library that provides customizable loading screens for web applications. With minimal setup, you can add elegant loading animations to your web pages, enhancing the user experience during page load.

Features

• Easy to integrate with existing projects
• Multiple loader types: spinner, pulsing, and custom image
• Customizable colors for loaders and overlay
• Backdrop blur effect option
• Minimum duration setting to ensure visibility of the loading screen
• Automatically hides when the page is fully loaded
• No dependencies, pure vanilla JavaScript
• Compatible with Tailwind CSS
• Responsive and works on all modern browsers

Examples

https://unpkg.com/senangwebs-loading@latest/examples/index.html

Installation

Using npm

npm install senangwebs-loading

Using a CDN

You can include SenangWebs Loading directly in your HTML file using unpkg:

<script src="https://unpkg.com/senangwebs-loading@latest/dist/swl.js"></script>

Usage

1. Include the SWL JavaScript file in your HTML, just before the closing </body> tag:

<!-- If installed via npm -->
<script src="path/to/swl.js"></script>

<!-- Or if using unpkg -->
<script src="https://unpkg.com/senangwebs-loading@latest/dist/swl.js"></script>

2. Add a div element with the data-swl attribute and any customization options:

<div 
  data-swl 
  data-swl-type="spinner" 
  data-swl-color="#007bff" 
  data-swl-duration="2000"
  data-swl-bg-color="#ffffff"
  data-swl-bg-opacity="0.8"
  data-swl-bg-blur="5"
  data-swl-z-index="9999"
>
  <!-- Optional: Custom loader content -->
</div>

Configuration Options

You can customize the loader using the following data attributes on the SWL div element:

• data-swl-type: Set the loader type ("spinner", "pulse", or "image")
• data-swl-color="#RRGGBB": Set the color of the loader (for spinner and pulse types)
• data-swl-image="URL": Set the URL for a custom image loader (when type is "image")
• data-swl-duration="2000": Set the minimum duration (in milliseconds) to display the loader
• data-swl-bg-color="#RRGGBB": Set the background color of the overlay
• data-swl-bg-opacity="0.8": Set the opacity of the overlay background (0 to 1)
• data-swl-bg-blur="5": Set the blur effect for the background (in pixels)
• data-swl-z-index="9999": Set the z-index of the loader overlay

Examples

Default Spinner

<div data-swl data-swl-color="#007bff" data-swl-duration="2000"></div>

Pulsing Loader with Custom Color

<div data-swl data-swl-type="pulse" data-swl-color="#ff0000" data-swl-duration="3000"></div>

Custom Image Loader

<div data-swl data-swl-type="image" data-swl-image="/path/to/your/loader.gif" data-swl-duration="2500"></div>

Customized Overlay

<div 
  data-swl
  data-swl-type="spinner"
  data-swl-color="#00ff00" 
  data-swl-duration="3000" 
  data-swl-bg-color="#000000"
  data-swl-bg-opacity="0.5"
  data-swl-bg-blur="5"
  data-swl-z-index="10000">
</div>

Custom Loader Content

<div data-swl data-swl-duration="2000">
  <div class="custom-loader">Loading...</div>
</div>

Supported Loaders

• Spinner: A rotating circular loader
• Pulse: A pulsing circular loader
• Image: A custom image loader

Browser Support

SenangWebs Loading works on all modern browsers, including:

• Chrome
• Firefox
• Safari
• Edge
• Opera

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

• Inspired by various loading screen libraries in the web development community
• Thanks to all contributors who have helped to improve this library

Support

If you encounter any issues or have questions, please file an issue on the GitHub repository.