chore(*): Update version number

feat(#3): Add fireworks and sound to selection reveal

package.json

@@ -1,6 +1,6 @@
 {
   "name": "SelectionWheel",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "A fun and simple selection wheel.",
   "main": "index.js",
   "scripts": {
@@ -38,8 +38,10 @@
     "workbox-cli": "^6.5.4"
   },
   "dependencies": {
+    "@fireworks-js/web": "^2.5.1",
     "@types/d3": "^7.4.0",
     "d3": "^7.6.1",
+    "fireworks-js": "^2.5.1",
     "html-webpack-plugin": "^5.5.0",
     "react-dev-utils": "^12.0.1",
     "webpack-manifest-plugin": "^5.0.0",

src/audioControls.ts

@@ -0,0 +1,17 @@
+export default {
+  pauseAudio(audio: HTMLAudioElement) {
+    audio.pause();
+  },
+  playAudio(audio: HTMLAudioElement) {
+    audio.play();
+  },
+  stopAudio(audio: HTMLAudioElement) {
+    audio.pause();
+    // eslint-disable-next-line no-param-reassign
+    audio.currentTime = 0;
+  },
+  toggleMute(audio: HTMLAudioElement) {
+    // eslint-disable-next-line no-param-reassign
+    audio.muted = !audio.muted;
+  },
+};

src/index.ts

@@ -1,11 +1,39 @@
 import * as d3 from 'd3';
+import { Fireworks } from 'fireworks-js';
 import loadServiceWorker from './loadServiceWorker';
+import audioControls from './audioControls';
+import spinnerMp3 from './assets/spinner-sound.mp3';
+import tadaMp3 from './assets/tada-fanfare.mp3';
 
 require('./assets/favicon.ico');
 require('./assets/android-chrome-192x192.png');
 require('./assets/android-chrome-512x512.png');
+require('./assets/apple-touch-icon.png');
+require('./assets/favicon-16x16.png');
+require('./assets/favicon-32x32.png');
 require('./styles/main.scss');
 
+const wheelSpinningSound = new Audio(spinnerMp3);
+const tadaSound = new Audio(tadaMp3);
+if (window.localStorage.audioMuteSetting) {
+  wheelSpinningSound.muted = window.localStorage.audioMuteSetting;
+  tadaSound.muted = window.localStorage.audioMuteSetting;
+}
+
+const fireworksContainer = document.getElementById('fireworks-container');
+function fireworksContainerOnClick() {
+  fireworksContainer.style.display = 'none';
+  document.getElementById('chart').click();
+  document.getElementsByClassName('chartholder')[0].dispatchEvent(new Event('click'));
+}
+fireworksContainer.onclick = fireworksContainerOnClick;
+
+const fireworks = new Fireworks(fireworksContainer, {
+  // sound: {
+  //   enabled: !wheelSpinningSound.muted,
+  // },
+});
+
 const padding = {
   top: 20,
   right: 40,
@@ -26,6 +54,8 @@ const color = d3.scaleOrdinal(d3.schemeCategory10);
 let data = [];
 const testData = ['Person 1', 'Person 2', 'Person 3', 'Person 4'];
 
+let imageUrlForSpinner = '';
+
 // eslint-disable-next-line no-unused-vars
 function rotTween(to) {
   const i = d3.interpolate(oldrotation % 360, rotation);
@@ -57,6 +87,31 @@ function makeArrowAndCircle(
     .attr('d', `M-${r * 0.15},0L0,${r * 0.05}L0,-${r * 0.05}Z`)
     .style('fill', 'black');
   // draw spin circle
+  if (imageUrlForSpinner.length > 0) {
+    const defs = svg.append('svg:defs');
+
+    defs.append('svg:pattern')
+      .attr('id', 'image')
+      .attr('width', 1)
+      .attr('height', 1)
+      .attr('patternContentUnits', 'objectBoundingBox')
+      .append('svg:image')
+      .attr('xlink:href', imageUrlForSpinner)
+      .attr('width', 1)
+      .attr('height', 1)
+      .attr('x', 0)
+      .attr('y', 0)
+      .attr('preserveAspectRatio', 'xMaxYMax slice');
+
+    container
+      .append('circle')
+      .attr('cx', 0)
+      .attr('cy', 0)
+      .attr('r', 60)
+      .style('fill', 'white')
+      .style('fill', 'url(#image)')
+      .style('cursor', 'pointer');
+  } else {
     container
       .append('circle')
       .attr('cx', 0)
@@ -64,15 +119,7 @@ function makeArrowAndCircle(
       .attr('r', 60)
       .style('fill', 'white')
       .style('cursor', 'pointer');
-  // spin text
-  container
-    .append('text')
-    .attr('x', 0)
-    .attr('y', 10)
-    .attr('text-anchor', 'middle')
-    .text('SPIN')
-    .style('font-weight', 'bold')
-    .style('font-size', '30px');
+  }
 }
 
 function drawWheel() {
@@ -134,9 +181,16 @@ function drawWheel() {
     // all slices have been seen, all done
     // console.log(`OldPick: ${oldpick.length}`, `Data length: ${data.length}`);
     if (oldpick.length === data.length) {
+      fireworksContainer.style.display = 'none';
+      fireworks.clear();
       stopSpinning();
       return;
     }
+
+    audioControls.stopAudio(tadaSound);
+    audioControls.playAudio(wheelSpinningSound);
+    fireworksContainer.style.display = 'none';
+    fireworks.stop();
     const ps = 360 / data.length;
     const rng = Math.floor(Math.random() * 1440 + 360);
 
@@ -158,10 +212,21 @@ function drawWheel() {
       .on('end', () => {
         // mark question as seen
         d3.select(`.slice:nth-child(${picked + 1}) path`).attr('fill', '#111');
+        d3.select(`.slice:nth-child(${picked + 1}) text`).attr('fill', '#ffffff');
         // populate question
         d3.select('#question h1').text(data[picked].label.trim());
         oldrotation = rotation;
 
+        audioControls.stopAudio(wheelSpinningSound);
+        audioControls.playAudio(tadaSound);
+        fireworksContainer.style.display = 'block';
+        const sizes = {
+          width: window.innerWidth,
+          height: window.innerHeight,
+        };
+        fireworks.updateSize(sizes);
+        fireworks.start();
+
         /* Get the result value from object "data" */
         // console.log(data[picked].value);
 
@@ -177,12 +242,21 @@ function drawWheel() {
 
 function startOver() {
   stopSpinning();
+  audioControls.stopAudio(wheelSpinningSound);
+}
+
+function toggleMute() {
+  audioControls.toggleMute(wheelSpinningSound);
+  audioControls.toggleMute(tadaSound);
+  this.textContent = wheelSpinningSound.muted ? 'Unmute' : 'Mute';
+  window.localStorage.audioMuteSetting = wheelSpinningSound.muted;
+  // TODO - toggle muting the fireworks from here
 }
 
 function startSpinning() {
   const textArea = <HTMLInputElement>document.getElementById('input-lines');
   const inputData = textArea.value.trim()
-    ? textArea.value.split('\n')
+    ? textArea.value.split('\n').filter((elm) => elm)
     : testData;
   const tempData = [];
   for (let index = 0; index < inputData.length; index += 1) {
@@ -208,7 +282,14 @@ function startSpinning() {
   startOverElement.setAttribute('role', 'button');
   startOverElement.onclick = startOver;
   startOverElement.textContent = 'Start over';
+  const muteElement = document.createElement('button');
+  muteElement.setAttribute('id', 'mute');
+  muteElement.setAttribute('class', 'button button-black');
+  muteElement.setAttribute('role', 'button');
+  muteElement.onclick = toggleMute;
+  muteElement.textContent = wheelSpinningSound.muted ? 'Unmute' : 'Mute';
   chartElement.appendChild(startOverElement);
+  chartElement.appendChild(muteElement);
   document.getElementById('spinner-container').appendChild(chartElement);
   const questionElement = document.createElement('div');
   questionElement.setAttribute('id', 'question');
@@ -237,6 +318,11 @@ textArea.addEventListener('keyup', () => {
   window.localStorage.TextEditorData = textArea.value;
 });
 
+const urlParams = new URLSearchParams(window.location.search);
+if (urlParams.has('imgUrl')) {
+  imageUrlForSpinner = urlParams.get('imgUrl');
+}
+
 if (process.env.NODE_ENV === 'production') {
   loadServiceWorker();
 }

src/serviceWorker.js

@@ -7,9 +7,6 @@ import { registerRoute, NavigationRoute, Route } from 'workbox-routing';
 // eslint-disable-next-line no-underscore-dangle, no-restricted-globals
 precacheAndRoute(self.__WB_MANIFEST);
 
-// Enable navigation preload - this should reduce navigation latency
-navigationPreload.enable();
-
 const navigationRoute = new NavigationRoute(new NetworkFirst({
   cacheName: 'navigations',
 }));

src/styles/main.scss

@@ -91,6 +91,12 @@ body {
   left: auto;
 }
 
+#mute {
+  position: absolute;
+  top: 140px;
+  left: auto;
+}
+
 #spinner-container {
   display: flex;
   flex-direction: row;
@@ -176,6 +182,19 @@ text{
   margin-bottom: 50px;
 }
 
+#fireworks-container {
+  display: none;
+  position: fixed;
+  left: 0;
+  top: 0;
+  width: 100%;
+  height: 100%;
+}
+
+#image{
+  width: 100%;
+}
+
 /* Buttons */
 
 .button {

src/template.html

@@ -40,7 +40,13 @@
 
         <div id="input-container">
             <textarea id="input-lines" class="input-items" rows="15" cols="60" name="text"
-            placeholder="Enter names to be shuffled, one per line. Leave this area empty in order to use a default set of generated names."></textarea>
+            placeholder="Enter names to be shuffled, one per line. Leave this area empty in order to use a default set of generated names.
+
+Click or tap on the wheel to spin it.
+
+You can also customise the centre of the spinner with an image. Just put ?imgUrl= at the end of the web address and the URL of the image you want to use.
+
+For example, https://wheel.jcreek.co.uk/?imgUrl=https://www.mammal.org.uk/wp-content/uploads/2021/09/red-fox-300x300.jpg"></textarea>
             <button id="startSpinning" class="input-items button button-green" role="button">Start spinning</button>
         </div>
 
@@ -50,5 +56,7 @@
             <span> | </span>
             <span class="footer-items"><a href="/privacy-policy.html">Privacy Policy</a></span>
         </footer>
+
+        <div id="fireworks-container"></div>
     </body>
 </html>