Skip to main content

Interface: GraphSearchInputProps

Defined in: packages/graph-search/src/GraphSearchInput.tsx:12

Properties​

children?​

optional children: [Element]

Defined in: packages/graph-search/src/GraphSearchInput.tsx:42

It's possible to customize the drop down indicator, by passing a JSX Element. First one is for the "zoom in", second for "zoom out" and third for "view whole graph".

className?​

optional className: string

Defined in: packages/graph-search/src/GraphSearchInput.tsx:13

labels?​

optional labels: Labels

Defined in: packages/graph-search/src/GraphSearchInput.tsx:48

Map of the labels we use in the component. This is usefull for I18N

onChange()​

onChange: (e) => void

Defined in: packages/graph-search/src/GraphSearchInput.tsx:25

What we do when user select an item

Parameters​

e​

null | GraphSearchOption

Returns​

void

onFocus()?​

optional onFocus: (e) => void

Defined in: packages/graph-search/src/GraphSearchInput.tsx:30

What we do when user focus an item on the dropdown. This can be useful to highlight the focus element in the graph

Parameters​

e​

null | GraphSearchOption

Returns​

void

postSearchResult()?​

optional postSearchResult: (options) => GraphSearchOption[]

Defined in: packages/graph-search/src/GraphSearchInput.tsx:36

With this function, you can filter/enhance the result displayed to the user. This can be useful to add action / messages, limit the number of result or highlight the search result in the graph

Parameters​

options​

GraphSearchOption[]

Returns​

GraphSearchOption[]

type?​

optional type: ItemsType

Defined in: packages/graph-search/src/GraphSearchInput.tsx:21

If not specified, we search on nodes & edges

value?​

optional value: null | GraphSearchOption

Defined in: packages/graph-search/src/GraphSearchInput.tsx:17

The value of the input