feat: add user customisable default archive display behaviour (#1505)

* fix typo

* implementation

* bug fix and refactoring

* Use nuqs for searchParam management

* remove the todo about the tests

* fix tests

---------

Co-authored-by: Mohamed Bassem <me@mbassem.com>

1 files changed, 24 insertions, 0 deletions

diff --git a/apps/web/components/utils/useShowArchived.tsx b/apps/web/components/utils/useShowArchived.tsx
new file mode 100644
index 00000000..3fc66e91
--- /dev/null
+++ b/apps/web/components/utils/useShowArchived.tsx
@@ -0,0 +1,24 @@
+import { useCallback } from "react";
+import { useUserSettings } from "@/lib/userSettings";
+import { parseAsBoolean, useQueryState } from "nuqs";
+
+export function useShowArchived() {
+  const userSettings = useUserSettings();
+  const [showArchived, setShowArchived] = useQueryState(
+    "includeArchived",
+    parseAsBoolean
+      .withOptions({
+        shallow: false,
+      })
+      .withDefault(userSettings.archiveDisplayBehaviour === "show"),
+  );
+
+  const onClickShowArchived = useCallback(() => {
+    setShowArchived((prev) => !prev);
+  }, [setShowArchived]);
+
+  return {
+    showArchived,
+    onClickShowArchived,
+  };
+}