Search for Components (Beta)

1
interface SearchComponentsOptions {
2
  /** Fuzzy search query matching Component panel search behavior */
3
  q?: string;
4
}
5
interface ComponentLibrary {
6
  name: string;
7
  id: string;
8
}
9
interface ComponentSearchResult {
10
  id: string;
11
  name: string;
12
  group: string;
13
  description: string;
14
  instances: number;
15
  canEdit: boolean;
16
  library: ComponentLibrary | null;
17
}
18
19
webflow.searchComponents(options: SearchComponentsOptions?): Promise<Array<ComponentSearchResult>>

1
// Get all Components
2
const allComponents = await webflow.searchComponents();
3
/*
4
[
5
  {
6
    id: 'xxxx',
7
    name: 'Hero section',
8
    group: 'Sections',
9
    description: 'Lorem ipsum',
10
    instances: 3,
11
    canEdit: true,
12
    library: null,
13
  },
14
  {
15
    id: 'yyyy',
16
    name: 'Nav Bar',
17
    group: 'Navigation',
18
    description: '',
19
    instances: 5,
20
    canEdit: false,
21
    library: { name: 'Core Library', id: 'lib_123' },
22
  },
23
]
24
*/
25
26
// Search for Components by query
27
const heroes = await webflow.searchComponents({ q: 'Hero' });
28
/*
29
[
30
  {
31
    id: 'xxxx',
32
    name: 'Hero section',
33
    group: 'Sections',
34
    description: 'Lorem ipsum',
35
    instances: 3,
36
    canEdit: true,
37
    library: null,
38
  },
39
]
40
*/