UNPKG

@mui/internal-docs-infra

Version:

MUI Infra - internal documentation creation tools.

github.com/mui/mui-public/tree/master/packages/docs-infra

mui/mui-public

58 lines • 1.65 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
import type { UseSearchOptions, UseSearchResult } from "./types.mjs"; /** * 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 types: '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 types: 2; 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 {};