Enable autoPlay as opt-in. Documentation. (#48)

* Enable `autoPlay` as opt-in. Documentation. * Changelog * Fix cypress * Fix test * What about now * Fix again
kitconcept · Mar 7, 2024 · acdd040 · acdd040
1 parent ab4f206
commit acdd040
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 7 deletions.
diff --git a/.github/workflows/acceptance.yml b/.github/workflows/acceptance.yml
@@ -4,7 +4,7 @@ on: [push]
 env:
   ADDON_NAME: "@kitconcept/volto-slider-block"
   ADDON_PATH: "volto-slider-block"
-  VOLTO_VERSION: "17.6.0"
+  VOLTO_VERSION: "17.15.3"
 
 jobs:
 

diff --git a/Makefile b/Makefile
@@ -22,7 +22,7 @@ RESET=`tput sgr0`
 YELLOW=`tput setaf 3`
 
 PLONE_VERSION=6
-VOLTO_VERSION=17.7.0
+VOLTO_VERSION=17.15.3
 
 ADDON_NAME='@kitconcept/volto-slider-block'
 ADDON_PATH='volto-slider-block'

diff --git a/README.md b/README.md
@@ -63,6 +63,16 @@ yarn start
 
 Go to http://localhost:3000, login, create a new page. The slider block will show up in the Volto blocks chooser.
 
+## Configuration options
+
+### `enableAutoPlay`
+
+This enables the autoplay controls in the block's settings.
+
+```js
+config.blocks.blocksConfig.slider.enableAutoPlay = true;
+```
+
 ## Upgrade Guide
 
 ### `volto-slider-block` 6.0.0

diff --git a/acceptance/cypress/tests/block.cy.js b/acceptance/cypress/tests/block.cy.js
@@ -47,6 +47,7 @@ context('Block Acceptance Tests', () => {
     cy.get(
       '.objectbrowser-field[aria-labelledby="fieldset-default-field-label-href-0-slides-1"] button[aria-label="Open object browser"]',
     ).click();
+    cy.wait(1000);
     cy.get('aside .breadcrumbs svg.home-icon').click();
     cy.findByLabelText('Select My Page').dblclick();
 
@@ -87,6 +88,7 @@ context('Block Acceptance Tests', () => {
     cy.get(
       '.objectbrowser-field[aria-labelledby="fieldset-default-field-label-href-0-slides-1"] button[aria-label="Open object browser"]',
     ).click();
+    cy.wait(1000);
     cy.get('aside .breadcrumbs svg.home-icon').click();
     cy.findByLabelText('Select My Page').dblclick();
 

diff --git a/news/48.feature b/news/48.feature
@@ -0,0 +1 @@
+Enable autoPlay as opt-in. Documentation @sneridagh
diff --git a/src/components/schema.js b/src/components/schema.js
@@ -126,11 +126,15 @@ export const SliderSchema = (props) =>
           title: 'Default',
           fields: ['slides'],
         },
-        {
-          id: 'autoplay',
-          title: props.intl.formatMessage(messages.Autoplay),
-          fields: ['autoplayEnabled', 'autoplayDelay', 'autoplayJump'],
-        },
+        ...(config.blocks.blocksConfig.slider.enableAutoPlay
+          ? [
+              {
+                id: 'autoplay',
+                title: props.intl.formatMessage(messages.Autoplay),
+                fields: ['autoplayEnabled', 'autoplayDelay', 'autoplayJump'],
+              },
+            ]
+          : []),
       ],
       properties: {
         slides: {

diff --git a/src/index.js b/src/index.js
@@ -17,6 +17,7 @@ const applyConfig = (config) => {
     mostUsed: true,
     sidebarTab: 1,
     dataAdapter: SliderBlockDataAdapter,
+    enableAutoPlay: false,
   };
   return config;
 };