Plugin Directory

Changeset 3051166


Ignore:
Timestamp:
03/14/2024 03:27:51 PM (2 years ago)
Author:
goodwpio
Message:

Updating readme/assets from GitHub

Location:
good-slider
Files:
4 added
1 deleted
3 edited

Legend:

Unmodified
Added
Removed
  • good-slider/trunk/readme.txt

    r2987548 r3051166  
    33Tags:              block, slider, swiper
    44Requires at least: 6.2
    5 Tested up to:      6.4
    6 Stable tag:        2.0.0
    7 License:           GPL-2.0-or-later
    8 License URI:       https://www.gnu.org/licenses/gpl-2.0.html
     5Requires PHP:      8.1
     6Tested up to:      6.5
     7Stable tag:        3.0.0
     8License:           GPL-3.0-or-later
     9License URI:       https://www.gnu.org/licenses/gpl-3.0.html
    910
    1011A simple and extendable slider block based on Swiper.
     
    1213== Description ==
    1314
    14 This plugin provides a very simple slider block which is based on [Swiper](https://swiperjs.com/).
    15 As of now, the plugin does not provide any slider configuration in the editor UI but provides many **PHP filter hooks** to change its behaviour.
     15This plugin provides a very simple slider block which is based on [Swiper v8](https://swiperjs.com/).
     16The plugin provides a UI for the most common swiper options (navigation, pagination, slides per view). But it is specifically made to be extended via PHP.
     17Therefore, it provides many **PHP filter hooks** to change its behaviour.
    1618
    1719The plugin is used in some custom themes and through it's PHP configuration it's perfect for a locked-in design (eg agency, clients).
     
    2224= Minimal Requirements =
    2325
    24 - PHP 7.4 or newer
    25 - WordPress 6.0 or newer
     26- PHP 8.1 or newer
     27- WordPress 6.2 or newer
    2628
    2729= Automatic Installation =
     
    38401. Insert the Good Slider block into your content.
    39412. Add slides to your slider and insert any block you like into a slide.
    40 3. The slide block also allows setting a background color and text color, so you don't need a group/cover block inside.
     423. The slide block also allows setting a background and text color, background image, spacing, typography etc. so you don't need a group/cover block inside.
    4143
    4244== Frequently Asked Questions ==
     
    4446= How can I change the swiper arguments (like slides shown etc) =
    4547
    46 As of now, there are no configuration UIs in the editor.
     48The UI currently allows for enabling/disabling navigation and pagination and the desktops default number of slides per view.
     49
    4750You can use the `good-slider/swiper-options` filter hook to set the swiper configuration for a specific block instance.
    48 All the available arguments are documented in the [Swiper documentation](https://swiperjs.com/swiper-api).
     51All the available arguments are documented in the [Swiper v8 documentation](https://v8.swiperjs.com/swiper-api).
    4952
    5053= Can I use my own enqueued Swiper script? =
     
    5558
    5659By default, a stripped-down version of Swiper is enqueued, which only includes the most commonly used modules (A11y, Keyboard, Lazy, Navigation, Pagination).
    57 You can use the `good-slider/swiper-script-handle` filter and set it to `good-slider-swiper-full` to enqueue the full Swiper bundle with all modules or you can use or own (see above).
     60You can use the `good-slider/swiper-script-handle` filter and set it to `good-slider-swiper-full` to enqueue the full Swiper bundle with all modules, or you can use or own (see above).
    5861
    59 = Will there be a UI for the block in the editor? =
     62= Will there be a UI for more settings the block in the editor? =
    6063
    61 Yes, we are working on exposing the most common configuration options (slides shown, spacing, colors,...) via the block's settings.
     64Thanks to recent additions to core, our slider and slide block now allow for setting most of the common styling settings:
     65- spacing
     66- colors (text, background, link)
     67- typography
     68- background image
     69- content positioning (justify-content + align-items)
     70
     71Also, v3.0.0 introduced a UI for enabling/disabling some of the most common settings of Swiper (navigation, pagination, slides shown).
     72
     73We are working on adding more UI controls but also providing the possibility for developers to disable them.
    6274
    6375== Changelog ==
     76
     77= 3.0.0 (2024-03-14) =
     78!! This version includes breaking changes !!
     79
     80- New: A new `good-slider/slide` block is introduced. This block has better naming and more block supports.
     81- Breaking: The `good-slider/item` block is now deprecated. Upon opening the editor all instance will be converted to `good-slider/slide` blocks.
     82- Breaking: Remove the editor filters `good-slider.item.innerBlocks-settings` and `good-slider.slider.innerBlocks-settings`. Instead, use the new `templateLock` property of the slider and slide block and the `allowedBlocks` attribute for the slide block introduced in WordPress 6.5
     83- Breaking: Removed tag name selector from slider block. Instead, wrap it in a group.
     84- Tweak: Add more block supports to slide
     85- Tweak: Editing experience is now horizontal and works with scrolling.
     86- New: Adds UI controls for Swiper navigation, pagination and slides per view (+ sensible defaults for tablet/mobile)
     87- Dev: Add formatting for PHP, JS and CSS
     88- Dev: Better directory structure of blocks
     89- Dev: Add WordPress Playground blueprint for easy demo of plugin
     90- Dev: Migrate to WordPress code style
     91- Compatibility: Test up to WordPres 6.5
     92- License: Update to GPL v3
    6493
    6594= 2.0.0 (2023-11-01) =
Note: See TracChangeset for help on using the changeset viewer.