@scalar/api-client 3.2.1 → 3.3.0

package/dist/v2/features/app/hooks/use-document-filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-document-filter.js","names":[],"sources":["../../../../../src/v2/features/app/hooks/use-document-filter.ts"],"sourcesContent":["import Fuse from 'fuse.js'\nimport { type MaybeRefOrGetter, computed, ref, toValue } from 'vue'\n\n/**\n * Minimum shape a filterable item needs. Anything we run through this hook\n * must have at least a `title`, which is the only field the fuzzy index\n * looks at. Extra fields on `T` are preserved verbatim in the filtered list.\n */\ntype FilterableItem = {\n  title: string\n}\n\n/**\n * Reactive filter state for a list of sidebar documents.\n *\n * Extracts the \"jump to document by name\" affordance used by the top-level\n * sidebar view into a stand-alone, testable primitive. Callers provide a\n * reactive source of items (ref, computed, or getter) and receive:\n *\n *  - `isVisible`: whether the filter input is currently revealed\n *  - `query`: v-model target for the search input\n *  - `filteredItems`: the input list narrowed down by the current query\n *  - `toggle()`: flips `isVisible`; clears the query when hiding so the list\n *    is not left in a filtered state after the input disappears\n *  - `reset()`: force-hides the filter and clears the query, e.g. when the\n *    user drills into a document and the top-level filter no longer applies\n *\n * The Fuse index is rebuilt whenever the input list changes so newly added\n * or removed entries are reflected immediately. We deliberately index only\n * the `title` because this is a lightweight UI-level filter, not a content\n * search.\n */\nexport const useDocumentFilter = <T extends FilterableItem>(items: MaybeRefOrGetter<T[]>) => {\n  const isVisible = ref(false)\n  const query = ref('')\n\n  const fuse = computed(\n    () =>\n      new Fuse(toValue(items), {\n        keys: ['title'],\n        threshold: 0.3,\n        ignoreLocation: true,\n      }),\n  )\n\n  const filteredItems = computed<T[]>(() => {\n    const trimmed = query.value.trim()\n    if (!trimmed) {\n      return toValue(items)\n    }\n\n    return fuse.value.search(trimmed).map((result) => result.item)\n  })\n\n  /**\n   * Flip the filter input's visibility. Hiding the input also clears the\n   * current query so the list does not stay filtered after the input\n   * disappears (which would otherwise leave documents invisible with no way\n   * for the user to see why).\n   */\n  const toggle = () => {\n    isVisible.value = !isVisible.value\n    if (!isVisible.value) {\n      query.value = ''\n    }\n  }\n\n  /** Hide the input and clear the query. */\n  const reset = () => {\n    isVisible.value = false\n    query.value = ''\n  }\n\n  return { isVisible, query, filteredItems, toggle, reset }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAgCA,IAAa,qBAA+C,UAAiC;CAC3F,MAAM,YAAY,IAAI,MAAM;CAC5B,MAAM,QAAQ,IAAI,GAAG;CAErB,MAAM,OAAO,eAET,IAAI,KAAK,QAAQ,MAAM,EAAE;EACvB,MAAM,CAAC,QAAQ;EACf,WAAW;EACX,gBAAgB;EACjB,CAAC,CACL;CAED,MAAM,gBAAgB,eAAoB;EACxC,MAAM,UAAU,MAAM,MAAM,MAAM;AAClC,MAAI,CAAC,QACH,QAAO,QAAQ,MAAM;AAGvB,SAAO,KAAK,MAAM,OAAO,QAAQ,CAAC,KAAK,WAAW,OAAO,KAAK;GAC9D;;;;;;;CAQF,MAAM,eAAe;AACnB,YAAU,QAAQ,CAAC,UAAU;AAC7B,MAAI,CAAC,UAAU,MACb,OAAM,QAAQ;;;CAKlB,MAAM,cAAc;AAClB,YAAU,QAAQ;AAClB,QAAM,QAAQ;;AAGhB,QAAO;EAAE;EAAW;EAAO;EAAe;EAAQ;EAAO"}