Plugin Directory

Changeset 3388917


Ignore:
Timestamp:
11/03/2025 02:00:23 PM (5 months ago)
Author:
pistonui
Message:

Read-me-update

File:
1 edited

Legend:

Unmodified
Added
Removed
  • pistonui/trunk/readme.txt

    r3388019 r3388917  
    1212
    1313== Description ==
    14 PistonUI provides a growing set of high-quality widgets designed for speed and flexibility.
     14PistonUI provides a growing set of high-quality widgets designed for speed and flexibility. Perfect for creating stunning landing pages, product showcases, and engaging content sections without any coding knowledge.
    1515
    16 Current widgets include:
    17 - Sliding Hero (Owl Carousel powered)
    18 - WooCommerce Category Grid (custom icons and titles)
    19 - Products Grid and Product Slider
    20 - TikTok Videos
     16**Core Widgets:**
     17* **Sliding Hero** - Beautiful full-width hero slider with multiple headings, descriptions, CTA buttons, and customizable overlay effects
     18* **Promo Banner** - Eye-catching promotional banners with flexible image positioning and customization options
     19* **Accordion** - Interactive FAQ/accordion widget with custom icons and smooth animations
     20* **TikTok Videos** - Display your TikTok videos in a responsive carousel with customizable items per screen size
    2121
    22 Toggle vendor assets (Owl Carousel, Bootstrap Grid) from the admin dashboard.
     22**WooCommerce Widgets:**
     23* **Category Showcase** - Display WooCommerce product categories with custom images, titles, and product counts
     24* **Category Icons Grid** - Grid layout for category icons with hover effects
     25* **Products Grid** - Showcase products in a responsive grid with sorting and filtering options
     26* **Product Slider** - Dynamic product carousel with configurable columns and responsive breakpoints
     27
     28All widgets include comprehensive style customization options, responsive design controls, and work seamlessly with Elementor's native features.
    2329
    2430== Installation ==
     
    28344. Open Elementor and find widgets under the "🔥 PistonUI Widgets" category.
    2935
     36== PistonUI Dashboard ==
     37
     38Access the PistonUI Dashboard from your WordPress admin menu to configure and customize the plugin settings.
     39
     40**General Settings:**
     41* **Owl Carousel Assets** - Enable or disable Owl Carousel CSS and JavaScript site-wide. Toggle this off if you're already loading Owl Carousel elsewhere to avoid conflicts.
     42* **Bootstrap Grid** - Enable Bootstrap Grid v4 CSS for layout control. Disable if you don't need grid utilities or if you're using a different grid system.
     43
     44**Widget Management:**
     45* **Enable/Disable Widgets** - Control which widgets appear in Elementor. Disable widgets you don't need to keep your Elementor panel clean and focused.
     46* **Core Widgets Control** - Toggle individual core widgets (Sliding Hero, Promo Banner, Accordion, TikTok Videos)
     47* **WooCommerce Widgets** - Manage WooCommerce-specific widgets. Only shown when WooCommerce is active.
     48
     49**Support Tab:**
     50* Access documentation links
     51* View system information for troubleshooting
     52* Contact support team
     53* Report bugs on GitHub
     54
     55The dashboard provides full control over which widgets are available, helping you optimize performance by loading only what you need.
     56
     57== Features ==
     58
     59**Performance Optimized:**
     60* Lightweight and fast-loading widgets
     61* On-demand asset loading
     62* Optional vendor library management
     63* Clean, minimal code without bloat
     64
     65**Developer Friendly:**
     66* Well-structured, documented code
     67* Hooks and filters for customization
     68* Namespaced PHP classes
     69* WordPress coding standards compliant
     70
     71**User Friendly:**
     72* Intuitive Elementor interface
     73* Real-time preview in editor
     74* Extensive customization options
     75* Responsive by default
     76
     77**Flexible & Customizable:**
     78* Enable/disable widgets individually
     79* Control vendor assets
     80* Full style and typography controls
     81* Responsive breakpoint configuration
     82
    3083== Frequently Asked Questions ==
     84
    3185= Do I need Elementor Pro? =
    32 No, PistonUI works with Elementor Free. Some features may benefit from Pro but are not required.
    33 
    34 = How do I load vendor assets locally? =
    35 The plugin enqueues Owl Carousel and Bootstrap Grid from local files when available. Place vendor files under `wp-content/plugins/pistonui/assets/vendor/`.
     86No, PistonUI works perfectly with Elementor Free. Some advanced styling features may benefit from Pro but are not required.
    3687
    3788= Does it work without WooCommerce? =
    38 Woo-specific widgets only appear if WooCommerce is active.
     89Yes! Core widgets (Sliding Hero, Promo Banner, Accordion, TikTok Videos) work without WooCommerce. WooCommerce-specific widgets only appear if WooCommerce is installed and activated.
     90
     91= How do I control which widgets are loaded? =
     92Use the PistonUI Dashboard (WordPress Admin > PistonUI > Widgets tab) to enable or disable specific widgets. This helps optimize performance and keeps your Elementor panel organized.
     93
     94= Can I customize the widgets? =
     95Yes! All widgets include comprehensive style controls including typography, colors, spacing, borders, backgrounds, and more. Every widget is fully responsive with device-specific options.
     96
     97= Can I request a new widget? =
     98Yes! We're always looking to add useful widgets based on community feedback. You can open a support request or contact the plugin developer with your suggestions.
     99
     100= Will this slow down my site? =
     101No, PistonUI is designed for performance. Widgets load only when used, vendor assets can be controlled, and the code is optimized for speed.
    39102
    40103== Screenshots ==
Note: See TracChangeset for help on using the changeset viewer.