Merge branch 'patch/v1.8.2'

troberts-28 · May 18, 2024 · 8536205 · 8536205
2 parents 0a50aa5 + b6aaf58
commit 8536205
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 7 deletions.
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,3 @@
+src/
+tests/
+node_modules/
diff --git a/README.md b/README.md
@@ -84,6 +84,9 @@ This is currently only supported on Expo with the [expo-av](https://www.npmjs.co
 
 **To enable audio feedback, you need to supply the imported `Audio` class as a prop to either TimerPickerModal or TimerPicker.**
 
+Please note that the default click sound uses a hosted mp3 file. To make the click sound work offline, you need to supply your own
+sound asset through the `clickSoundAsset` prop. You can download the default click sound [here](https://drive.google.com/uc?export=download&id=10e1YkbNsRh-vGx1jmS1Nntz8xzkBp4_I).
+
 <br>
 
 ## Installation 🚀
@@ -246,6 +249,7 @@ return (
             closeOnOverlayPress
             use12HourPicker
             Audio={Audio}
+            // supply your own custom click sound asset
             clickSoundAsset={require("./assets/custom_click.mp3")}
             LinearGradient={LinearGradient}
             Haptics={Haptics}
@@ -396,7 +400,7 @@ return (
 |          LinearGradient          | Linear Gradient Component                                                       | [expo-linear-gradient](https://www.npmjs.com/package/expo-linear-gradient).LinearGradient or [react-native-linear-gradient](https://www.npmjs.com/package/react-native-linear-gradient).default |    -    |  false   |
 |          Haptics          | Haptics Namespace (required for Haptic feedback)                                                     | [expo-haptics](https://www.npmjs.com/package/expo-haptics) |    -    |  false   |
 |          Audio          | Audio Class (required for audio feedback i.e. click sound)                                                     | [expo-av](https://www.npmjs.com/package/expo-av).Audio |    -    |  false   |
-|          clickSoundAsset          | Custom sound asset for click sound                                              | require(.../somefolderpath) or {uri: www.someurl}    |    -    |  false   |
+|          clickSoundAsset          | Custom sound asset for click sound (required for offline click sound - download default [here](https://drive.google.com/uc?export=download&id=10e1YkbNsRh-vGx1jmS1Nntz8xzkBp4_I))                                              | require(.../somefolderpath) or {uri: www.someurl}    |    -    |  false   |
 |       pickerContainerProps       | Props for the picker container                                                  |                                                                               `React.ComponentProps<typeof View>`                                                                               |    -    |  false   |
 |    pickerGradientOverlayProps    | Props for both gradient overlays                                                |                                                                                 `Partial<LinearGradientProps>`                                                                                  |    -    |  false   |
 |  topPickerGradientOverlayProps   | Props for the top gradient overlay                                              |                                                                                 `Partial<LinearGradientProps>`                                                                                  |    -    |  false   |

diff --git a/example/App.tsx b/example/App.tsx
@@ -22,9 +22,7 @@ import {
     View,
     useWindowDimensions,
 } from "react-native";
-import type {
-    NativeScrollEvent,
-    NativeSyntheticEvent} from "react-native";
+import type { NativeScrollEvent, NativeSyntheticEvent } from "react-native";
 
 import { TimerPicker, TimerPickerModal } from "../src";
 
@@ -205,6 +203,7 @@ export default function App() {
                     secondLabel=""
                     styles={{
                         theme: "dark",
+                        backgroundColor: "#202020",
                         pickerItem: {
                             fontSize: 34,
                         },

diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
         "url": "https://github.com/troberts-28"
     },
     "license": "MIT",
-    "version": "1.8.1",
+    "version": "1.8.2",
     "main": "dist/commonjs/index.js",
     "types": "dist/typescript/src/index.d.ts",
     "scripts": {

diff --git a/src/assets/select_click.mp3 b/src/assets/select_click.mp3
diff --git a/src/components/DurationScroll/index.tsx b/src/components/DurationScroll/index.tsx
@@ -98,8 +98,11 @@ const DurationScroll = forwardRef<DurationScrollRef, DurationScrollProps>(
             const loadSound = async () => {
                 if (Audio) {
                     const { sound } = await Audio.Sound.createAsync(
-                        clickSoundAsset ??
-                            require("../../assets/select_click.mp3"),
+                        clickSoundAsset ?? {
+                            // use a hosted sound as a fallback (do not use local asset due to loader issues
+                            // in some environments when including mp3 in library)
+                            uri: "https://drive.google.com/uc?export=download&id=10e1YkbNsRh-vGx1jmS1Nntz8xzkBp4_I",
+                        },
                         { shouldPlay: false }
                     );
                     setClickSound(sound);