@mui/internal-docs-infra 0.2.3-canary.9 → 0.3.1-canary.0

package/esm/useSearch/types.js

@@ -0,0 +1 @@
+export {};

package/esm/useSearch/useSearch.d.ts

@@ -0,0 +1,56 @@
+import type { UseSearchOptions, UseSearchResult } from "./types.js";
+/**
+ * Orama schema definition for our search document
+ */
+declare const searchSchema: {
+  readonly type: "string";
+  readonly group: "string";
+  readonly title: "string";
+  readonly description: "string";
+  readonly slug: "string";
+  readonly sectionTitle: "string";
+  readonly prefix: "string";
+  readonly path: "string";
+  readonly keywords: "string";
+  readonly page: "string";
+  readonly pageKeywords: "string";
+  readonly sections: "string";
+  readonly subsections: "string";
+  readonly part: "string";
+  readonly export: "string";
+  readonly props: "string";
+  readonly dataAttributes: "string";
+  readonly cssVariables: "string";
+  readonly section: "string";
+  readonly subsection: "string";
+};
+type SearchSchema = typeof searchSchema;
+export declare const defaultSearchBoost: {
+  readonly type: 100;
+  readonly group: 100;
+  readonly slug: 2;
+  readonly path: 2;
+  readonly title: 2;
+  readonly page: 10;
+  readonly pageKeywords: 15;
+  readonly description: 1.5;
+  readonly part: 1.5;
+  readonly export: 1.3;
+  readonly sectionTitle: 50;
+  readonly section: 3;
+  readonly subsection: 2.5;
+  readonly props: 1.5;
+  readonly dataAttributes: 1.5;
+  readonly cssVariables: 1.5;
+  readonly sections: 0.7;
+  readonly subsections: 0.3;
+  readonly keywords: 1.5;
+};
+/**
+ * Hook for managing search functionality with Orama
+ *
+ * @param options Configuration options for search behavior
+ * @returns Search state and functions
+ */
+export declare function useSearch(options: UseSearchOptions): UseSearchResult<SearchSchema>;
+export {};