diff --git a/src/storage/use_storage.rs b/src/storage/use_storage.rs index 31fa82d..b1dbd24 100644 --- a/src/storage/use_storage.rs +++ b/src/storage/use_storage.rs @@ -27,7 +27,7 @@ pub struct UseStorageOptions> { codec: C, on_error: Rc)>, listen_to_storage_changes: bool, - default_value: MaybeRwSignal, + initial_value: MaybeRwSignal, filter: FilterOptions, } @@ -186,11 +186,11 @@ where codec, on_error, listen_to_storage_changes, - default_value, + initial_value, filter, } = options; - let (data, set_data) = default_value.into_signal(); + let (data, set_data) = initial_value.into_signal(); let default = data.get_untracked(); cfg_if! { if #[cfg(feature = "ssr")] { @@ -384,7 +384,7 @@ impl + Default> Default for UseStorageOptions { codec: C::default(), on_error: Rc::new(|_err| ()), listen_to_storage_changes: true, - default_value: MaybeRwSignal::default(), + initial_value: MaybeRwSignal::default(), filter: FilterOptions::default(), } } @@ -415,10 +415,10 @@ impl> UseStorageOptions { } } - /// Default value to use when the storage key is not set. Accepts a signal. - pub fn default_value(self, values: impl Into>) -> Self { + /// Initial value to use when the storage key is not set. Note that this value is read once on creation of the storage hook and not updated again. Accepts a signal and defaults to `T::default()`. + pub fn initial_value(self, initial: impl Into>) -> Self { Self { - default_value: values.into(), + initial_value: initial.into(), ..self } } diff --git a/src/use_color_mode.rs b/src/use_color_mode.rs index ff7031f..5f2b781 100644 --- a/src/use_color_mode.rs +++ b/src/use_color_mode.rs @@ -266,7 +266,7 @@ fn get_store_signal( storage_key, UseStorageOptions::default() .listen_to_storage_changes(listen_to_storage_changes) - .default_value(initial_value), + .initial_value(initial_value), ); (store, set_store) } else {