change all instances for builtInButtons to align with Shepherd docs f…

…or config
RobbieTheWagner · Sep 10, 2018 · cfba88c · cfba88c
1 parent 5539757
commit cfba88c
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -143,7 +143,7 @@ this.get('tour').set('steps', [
           });
         });
       },
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary',
           text: 'Exit',
@@ -218,15 +218,15 @@ A function that returns a promise. When the promise resolves, the rest of the `s
 > **default value:** `null`
 
 
-##### builtInButtons
+##### buttons
 
 These are the standard button types supported by Shepherd. Just set type to `next`, `back`, or `cancel`, then set the text and classes as normal.
 
 Custom actions can also be used by using an action method instead of a type. For example:
 
 ``` javascript
 ...
-builtInButtons: [
+buttons: [
   {
     classes: 'shepherd-button-secondary',
     text: 'Exit',

diff --git a/addon/services/tour.js b/addon/services/tour.js
@@ -311,7 +311,6 @@ export default Service.extend(Evented, {
   stepsChange: observer('steps', function() {
     this.initialize();
     const steps = get(this, 'steps');
-
     const tour = get(this, 'tourObject');
 
     // Return nothing if there are no steps
@@ -336,8 +335,8 @@ export default Service.extend(Evented, {
     steps.forEach((step, index) => {
       const { id, options } = step;
 
-      assert('You must either pass an array of builtInButtons or `false`, undefined is not supported', options.builtInButtons !== undefined);
-      options.buttons = (options.builtInButtons !== false) ? options.builtInButtons.map(this.makeButton, this) : false;
+      assert('You must either pass an array of buttons or `false`, undefined is not supported', options.buttons !== undefined);
+      options.buttons = (options.buttons !== false) ? options.buttons.map(this.makeButton, this) : false;
       options.attachTo = this.normalizeAttachTo(options.attachTo);
       tour.addStep(id, options);
 

diff --git a/tests/acceptance/ember-shepherd-test.js b/tests/acceptance/ember-shepherd-test.js
@@ -42,7 +42,7 @@ module('Acceptance | Tour functionality tests', function(hooks) {
       id: 'test-highlight',
       options: {
         attachTo: '.first-element bottom',
-        builtInButtons: [
+        buttons: [
           {
             classes: 'shepherd-button-secondary cancel-button',
             text: 'Exit',
@@ -90,7 +90,7 @@ module('Acceptance | Tour functionality tests', function(hooks) {
       id: 'intro',
       options: {
         attachTo: '.first-element bottom',
-        builtInButtons: [
+        buttons: [
           {
             classes: 'shepherd-button-secondary cancel-button',
             text: 'Exit',
@@ -150,7 +150,7 @@ module('Acceptance | Tour functionality tests', function(hooks) {
     assert.notOk(document.querySelector('#shepherdOverlay'), '#shepherdOverlay should not exist, since non-modal');
   });
 
-  test('Tour next, back, and cancel builtInButtons work', async function(assert) {
+  test('Tour next, back, and cancel buttons work', async function(assert) {
     assert.expect(3);
 
     await visit('/');
@@ -173,7 +173,7 @@ module('Acceptance | Tour functionality tests', function(hooks) {
       id: 'test-highlight',
       options: {
         attachTo: '.first-element bottom',
-        builtInButtons: [
+        buttons: [
           {
             classes: 'shepherd-button-secondary cancel-button',
             text: 'Exit',
@@ -214,7 +214,7 @@ module('Acceptance | Tour functionality tests', function(hooks) {
       id: 'test-highlight',
       options: {
         attachTo: '.first-element bottom',
-        builtInButtons: [
+        buttons: [
           {
             classes: 'shepherd-button-secondary cancel-button',
             text: 'Exit',
@@ -260,7 +260,7 @@ module('Acceptance | Tour functionality tests', function(hooks) {
       id: 'test-defaults-classes',
       options: {
         attachTo: '.first-element bottom',
-        builtInButtons: [
+        buttons: [
           {
             classes: 'shepherd-button-secondary cancel-button',
             text: 'Exit',
@@ -300,7 +300,7 @@ module('Acceptance | Tour functionality tests', function(hooks) {
           element: '.first-element',
           on: 'bottom'
         },
-        builtInButtons: [
+        buttons: [
           {
             classes: 'shepherd-button-secondary cancel-button',
             text: 'Exit',
@@ -342,7 +342,7 @@ module('Acceptance | Tour functionality tests', function(hooks) {
           element: find('.first-element'),
           on: 'bottom'
         },
-        builtInButtons: [
+        buttons: [
           {
             classes: 'shepherd-button-secondary cancel-button',
             text: 'Exit',
@@ -381,7 +381,7 @@ module('Acceptance | Tour functionality tests', function(hooks) {
           element: '.first-element',
           on: 'bottom'
         },
-        builtInButtons: [
+        buttons: [
           {
             classes: 'shepherd-button-secondary button-one',
             text: 'button one'
@@ -473,7 +473,7 @@ module('Acceptance | Tour functionality tests', function(hooks) {
       id: 'intro',
       options: {
         attachTo: '.first-element bottom',
-        builtInButtons: [
+        buttons: [
           {
             classes: 'shepherd-button-secondary cancel-button',
             text: 'Exit',
@@ -545,7 +545,7 @@ module('Acceptance | Tour functionality tests', function(hooks) {
       id: 'intro',
       options: {
         attachTo: '.first-element bottom',
-        builtInButtons: [
+        buttons: [
           {
             classes: 'shepherd-button-secondary cancel-button',
             text: 'Exit',

diff --git a/tests/data.js b/tests/data.js
@@ -3,7 +3,7 @@ export default [
     id: 'intro',
     options: {
       attachTo: '.first-element bottom',
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',
@@ -32,7 +32,7 @@ export default [
     id: 'installation',
     options: {
       attachTo: '.install-element bottom',
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',
@@ -58,7 +58,7 @@ export default [
     id: 'usage',
     options: {
       attachTo: '.usage-element bottom',
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',
@@ -87,7 +87,7 @@ export default [
         element: '.modal-element',
         on: 'top'
       },
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',
@@ -119,7 +119,7 @@ export default [
         element: '.style-copy-element',
         on: 'top'
       },
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',
@@ -146,10 +146,10 @@ export default [
     }
   },
   {
-    id: 'builtInButtons',
+    id: 'buttons',
     options: {
       attachTo: '.built-in-buttons-element top',
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',
@@ -171,15 +171,15 @@ export default [
       text: [
         `For the common button types ("next", "back", "cancel", etc.), we implemented Ember actions
           that perform these actions on your tour automatically. To use them, simply include
-          in the builtInButtons array in each step.`
+          in the buttons array in each step.`
       ]
     }
   },
   {
     id: 'disableScroll',
     options: {
       attachTo: '.disable-scroll-element top',
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',
@@ -208,7 +208,7 @@ export default [
   {
     id: 'noAttachTo',
     options: {
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',

diff --git a/tests/dummy/app/data.js b/tests/dummy/app/data.js
@@ -3,7 +3,7 @@ export default [
     id: 'intro',
     options: {
       attachTo: '.first-element bottom',
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',
@@ -32,7 +32,7 @@ export default [
     id: 'installation',
     options: {
       attachTo: '.install-element bottom',
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',
@@ -58,7 +58,7 @@ export default [
     id: 'usage',
     options: {
       attachTo: '.usage-element bottom',
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',
@@ -87,7 +87,7 @@ export default [
         element: '.modal-element',
         on: 'top'
       },
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',
@@ -119,7 +119,7 @@ export default [
         element: '.style-copy-element',
         on: 'top'
       },
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',
@@ -146,10 +146,10 @@ export default [
     }
   },
   {
-    id: 'builtInButtons',
+    id: 'buttons',
     options: {
       attachTo: '.built-in-buttons-element top',
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',
@@ -171,15 +171,15 @@ export default [
       text: [
         `For the common button types ("next", "back", "cancel", etc.), we implemented Ember actions
           that perform these actions on your tour automatically. To use them, simply include
-          in the builtInButtons array in each step.`
+          in the buttons array in each step.`
       ]
     }
   },
   {
     id: 'disableScroll',
     options: {
       attachTo: '.disable-scroll-element top',
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',
@@ -208,7 +208,7 @@ export default [
   {
     id: 'noAttachTo',
     options: {
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary cancel-button',
           text: 'Exit',

diff --git a/tests/unit/services/tour-test.js b/tests/unit/services/tour-test.js
@@ -9,7 +9,7 @@ const steps = [
     id: 'intro',
     options: {
       attachTo: '.test-element bottom',
-      builtInButtons: [
+      buttons: [
         {
           classes: 'shepherd-button-secondary',
           text: 'Exit',