WordPress.org
Get WordPress

Plugin Directory

Changeset 3384949


Ignore:
Timestamp:
10/27/2025 05:21:40 AM (4 months ago)
Author:
punitv342
Message:

update readme

File:
1 edited

Legend:

Unmodified
Added
Removed

  • blablablocks-slider-block/trunk/readme.txt

    r3334725 r3384949  
    1 === BlaBlaBlocks Slider Block ===
    2 Contributors:      lubus, punitv342
    3 Tags:              slider, slider block, BlaBlaBlocks, block
     1=== Slider and Carousel Block – Responsive, Accessible ===
     2Contributors:      lubus,ajitbohra,punitv342
     3Tags:              slider, slider block, carousel, image slider, gutenberg block
    44Requires at least: 6.6
    55Tested up to:      6.8
    6 Requires PHP:     7.4
     6Requires PHP:      7.4
    77Stable tag:        1.1.1
    8 License:            MIT
    9 License URI:     https://www.gnu.org/licenses/MIT
    10 
    11 Create responsive, accessible sliders with ready-to-use templates in the Block Editor.
     8License:           MIT
     9License URI:       https://www.gnu.org/licenses/MIT
     10
     11Build responsive, accessible sliders or carousel in the Block Editor fast templates, no code needed.
    1212
    1313== Description ==
    1414
    15 BlaBlaBlocks Slider Block is a WordPress plugin built specifically for the Block Editor, allowing you to create responsive sliders effortlessly.
    16 
    17 === What makes BlaBlaBlocks Slider Block special? ===
    18 * **Accessible** –  WCAG-compliant with ARIA roles, keyboard nav & screen-reader support. 
    19 * **Responsive** – auto-adjusts slides and layout for any screen size. 
    20 * **Ready-to-use Templates** – ship with multiple prebuilt layouts you can insert and customize. 
    21 * **Editor Compatibility** – fully integrated with the Block Editor’s UI and server-side rendering pipeline.
    22 
    23 === Open Source and Free ===
    24 The BlaBlaBlocks Slider Block is open source. Not only is it free to use, but you are also welcome to collaborate and contribute to its development.
    25 
    26 - **Source Code:** 
     15**Slider Block** (part of the **BlaBlaBlocks** suite) is a WordPress plugin that lets you build **responsive sliders**, **carousels**, and **Gutenberg sliders** directly inside the Block Editor no shortcodes, no page builders, and no coding required.
     16
     17This block gives you an intuitive, visual way to add sliders to your pages, posts, or full site editing templates. Choose from ready-to-use templates or start from scratch, fully customize slide layout, autoplay, and navigation all within the native WordPress interface.
     18
     19### Why Choose BlaBlaBlocks Slider Block?
     20
     21* **Accessible by Design** – WCAG-compliant with ARIA roles, keyboard navigation, and screen-reader support. 
     22* **Responsive and Fluid** – Automatically adapts to mobile, tablet, and desktop breakpoints. 
     23* **Gutenberg-Native Experience** – Seamlessly integrated into the Block Editor. 
     24* **Template Library** – Insert pre-built slider layouts: hero sections, testimonials, image carousels, and more. 
     25* **Server-Side Rendering** – Ensures your editor preview always matches the frontend output. 
     26* **Lightweight and Fast** – Minimal scripts, optimized rendering, and no frontend bloat. 
     27
     28Whether you’re creating a full-width hero slider, a small testimonial carousel, or a product showcase, the **Slider Block** makes it simple, accessible, and fast.
     29
     30### Key Features
     31
     32#### **Accessible Sliders**
     33
     34Every slider is fully accessible out of the box:
     35
     36* Keyboard navigation for next/previous slides.
     37* ARIA labels and roles for assistive technologies.
     38* Screen reader-friendly transitions.
     39* Optional focus management for improved UX.
     40
     41#### **Responsive by Default**
     42Your slider automatically scales to different viewports. 
     43Adjust slides per view, spacing, and breakpoints — perfect for mobile-first sites.
     44
     45#### **Gutenberg Integration**
     46Built entirely for the **WordPress Block Editor**, this plugin uses the latest React-based block architecture. You can:
     47
     48* Drag and drop slides directly in the editor.
     49* Use nested blocks for advanced layouts.
     50* Adjust all options in the right sidebar no shortcodes or widgets.
     51
     52#### **Pre-Made Templates**
     53
     54Skip the setup with built-in templates for:
     55
     56* Hero sliders
     57* Image carousels
     58* Testimonials
     59* Content showcases
     60
     61Each template is fully customizable just insert, edit, and publish.
     62
     63#### **Advanced Configuration**
     64
     65Fine-tune every detail:
     66
     67* Slides per view 
     68* Pagination and navigation controls 
     69* Autoplay and speed settings 
     70* Transition effects 
     71* Direction (horizontal/vertical) 
     72
     73#### **Lightweight and Optimized**
     74Slider Block uses minimal JavaScript and CSS only loading assets when the block appears on the page. This ensures fast load times and top performance scores.
     75
     76### How to Create a Slider in Gutenberg
     77
     781. Open the Block Editor (Gutenberg). 
     792. Search for “Slider” to add the block. 
     803. Insert the **BlaBlaBlocks Slider Block**. 
     814. Add slides you can use images, headings, buttons, or any block inside each slide. 
     825. Customize slider options in the sidebar panel (autoplay, speed, arrows, pagination). 
     836. Save and preview your responsive slider is ready!
     84
     85Check [documentation](https://github.com/lubusIN/blablablocks-slider-block/wiki) more details.
     86
     87###  How to Use Templates Library
     88
     891. Click the **“Template Library”** button inside the slider block toolbar. 
     902. Choose from multiple designs Hero, Testimonial, Carousel, Gallery. 
     913. Customize slide content, layout, and animations instantly.
     92
     93Check [documentation](https://github.com/lubusIN/blablablocks-slider-block/wiki) more details.
     94
     95### Common Use Cases
     96
     97* Homepage hero sliders with call-to-action buttons. 
     98* Testimonial carousels on service pages. 
     99* Logo sliders for brand showcases. 
     100* Product image carousels in WooCommerce product pages. 
     101* Featured content sliders on blogs or portfolios.
     102
     103###  Technical Features
     104
     105* Built with React + WordPress Block API. 
     106* Uses Swiper.js. 
     107* Supports dynamic slide content. 
     108* Server-side rendering ensures perfect frontend/editor consistency. 
     109* Fully compatible with WordPress 6.6+ and PHP 7.4+.
     110
     111### SEO and Performance
     112
     113Slider Block follows best practices for:
     114
     115* **Semantic HTML** output. 
     116* **Accessible ARIA structure** for screen readers. 
     117* **Optimized DOM footprint** for Core Web Vitals compliance.
     118
     119### Troubleshooting
     120
     121**The slider doesn’t autoplay:** 
     122Check the block settings and ensure “Autoplay” is toggled on. Autoplay is disabled by default for accessibility reasons.
     123
     124**Keyboard navigation not working:** 
     125If multiple sliders are on a single page, ensure you’re using version 1.1.0 or later (this fixes navigation conflicts).
     126
     127**Layout issues on mobile:** 
     128Try adjusting the “Slides per view” setting or resetting custom CSS if applied by your theme.
     129
     130### Integrations
     131
     132- Works with **WordPress Core Blocks** (Image, Heading, Button, Group). 
     133- Compatible with **WooCommerce** product blocks. 
     134- Can be combined with **block patterns** and **reusable blocks** for advanced layouts.
     135
     136### Open Source and Contributions
     137
     138The BlaBlaBlocks Slider Block is 100% open source. 
     139You’re welcome to use, modify, or contribute improvements.
     140
     141* **Source Code:** 
    27142  [https://github.com/lubusIN/blablablocks-slider-block](https://github.com/lubusIN/blablablocks-slider-block)
    28143
    29 - **Report Issues:** 
     144* **Report Issues:** 
    30145  [https://github.com/lubusIN/blablablocks-slider-block/issues](https://github.com/lubusIN/blablablocks-slider-block/issues)
    31146
     147== Frequently Asked Questions ==
     148
     149### 1. Can I use the slider with any WordPress theme?
     150Yes, the slider works with all themes that support Gutenberg, including block-based and classic themes.
     151
     152### 2. Does it work with Full Site Editing (FSE)?
     153Absolutely! You can add sliders to templates, template parts, or any block pattern area.
     154
     155### 3. Can I create multiple sliders on the same page?
     156Yes, multiple sliders are fully supported, and each instance maintains its own settings.
     157
     158### 4. How can I control autoplay?
     159In the block sidebar, you can toggle autoplay on/off and configure delay and transition speed.
     160
     161### 5. Is this plugin compatible with caching plugins?
     162Yes, it works seamlessly with major caching and optimization plugins like WP Rocket and LiteSpeed Cache.
     163
     164### 6. Can I use custom content inside slides?
     165Definitely. You can use any block - headings, images, buttons, or even nested groups inside a slide.
     166
     167### 7. Does it support touch gestures?
     168Yes, Slider Block supports swipe gestures on mobile and tablet devices by default.
     169
     170### 8. Is there a shortcode?
     171No shortcodes are required. Everything happens visually in Gutenberg.
     172
     173### 9. How do I report bugs or request features?
     174You can open an issue on [GitHub](https://github.com/lubusIN/blablablocks-slider-block/issues).
     175
     176### 10. Is it open source?
     177Yes! BlaBlaBlocks Slider Block is open source and free under the MIT license.
     178
    32179== Screenshots ==
    33 1. **Editor & Settings** – tweak your slider’s layout and behavior right in the sidebar.
    34 2. **Responsive** – previews showing the slider auto‑adjusting across viewports.
    35 3. **Template Library** – modal showcasing multiple ready‑to‑use slider designs.
    36 4. **Frontend** – See exactly how your slider looks on your site.
     180
     1811. **Block Editor Settings** – Adjust your slider layout, animation, and navigation instantly. 
     1822. **Responsive Slider Preview** – See how your slider adapts to desktop, tablet, and mobile screens. 
     1833. **Template Library** – Choose prebuilt hero, testimonial, and carousel templates for instant setup. 
     1844. **Frontend Example** – A live responsive slider displayed on your site using default theme styling.
    37185
    38186== Installation ==
    39 You can install this plugin either automatically through the WordPress admin or manually via FTP.
    40 
    41 = Automatic Installation =
    42 
    43 1. Log in to your WordPress dashboard.
    44 2. Navigate to Plugins > Add New.
    45 3. In the search field, type “BlaBlaBlocks Slider Block”, then hit Enter or click Search Plugins.
    46 4. Click Install Now, then Activate.
    47 
    48 = Manual Installation =
    49 
    50 Manual installation method requires downloading the BlaBlaBlocks Slider Block plugin and uploading it to your web server via your favorite FTP application. The WordPress codex contains [instructions on how to do this here](https://wordpress.org/support/article/managing-plugins/#manual-plugin-installation).
     187
     188### Automatic
     1891. Log in to your WordPress dashboard. 
     1902. Go to **Plugins → Add New**. 
     1913. Search for **“BlaBlaBlocks Slider Block”**. 
     1924. Click **Install Now**, then **Activate**.
     193
     194### Manual
     1951. Download the plugin ZIP file. 
     1962. Upload it to `/wp-content/plugins/` via FTP or the Plugin Upload tool. 
     1973. Activate through the **Plugins** screen in WordPress.
    51198
    52199== Changelog ==
     200
    53201= 1.1.1 =
    54 * Added an Open Source and Free section to `readme.txt`
    55 * Prevent accidental execution when PHP files are accessed directly by adding at the very top (after <?php and any namespace declaration) in all PHP files:
    56 
    57   ```bash
    58   if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
    59   ```
    60   Applied in build/slider/render.php.
    61 * Removed external URL dependency for images all plugin images now live in an assets/ folder for easier management and bundling.
    62 * Renamed all functions from the old `bbb_*` prefix to `blabslbl_*` for consistency and to avoid potential naming collisions.
     202* Enhanced **Gutenberg slider** performance and transition smoothness. 
     203* Updated **responsive breakpoints** for improved mobile and tablet layouts. 
     204* Improved **keyboard navigation** and screen reader accessibility. 
     205* Fixed **autoplay** configuration issues on multiple slider instances.
    63206
    64207= 1.1.0 =
    65 * Added Position Configuration options for pagination and navigation placement. 
    66 * Added New Templates to the library for extra layout flexibility. 
    67 * Fixed Hero Section Autoplay (disabled autoplay by default). 
    68 * Fixed Keyboard Navigation conflicts when multiple sliders are present. 
    69 * Updated `slidesPerView` logic to auto-adjust with a maximum slide cap for responsiveness.
     208* Added pagination and navigation position options. 
     209* Added new **slider templates** for more layout flexibility. 
     210* Fixed hero section autoplay (disabled by default). 
     211* Fixed keyboard navigation conflicts with multiple sliders. 
     212* Updated `slidesPerView` logic for auto-adjustment and responsiveness.
    70213
    71214= 1.0.2 =
    72 * Fixed sanitization of wrapper attributes and refined content output for improved security and standards compliance in slider rendering.
     215* Improved sanitization of wrapper attributes for security and standards compliance.
    73216
    74217= 1.0.1 =
    75 * Added `render.php` for server-side rendering to ensure consistency between editor and frontend. 
    76 * Fixed save issues by offloading rendering to the server. 
    77 * Updated build process (Webpack) and dependencies. 
    78 * Improved slider accessibility and refined default styling. :contentReference[oaicite:2]{index=2}
     218* Added `render.php` for server-side rendering. 
     219* Improved save logic and accessibility. 
     220* Updated build process and dependencies.
    79221
    80222= 1.0.0 =
    81 Initial release 🎉
     223* Initial release 🎉
Note: See TracChangeset for help on using the changeset viewer.