Search Box
Public beta for Mapbox Search JS
Mapbox Search JS はパブリック ベータ版です。パブリック ベータ段階では、フレームワークが安定するにつれて変更される可能性があります。
Search Box provides a rich UI for single-box location search, allowing your users to search for addresses and points of interest by place name, address, or category.
This page includes reference documentation the Search Box components and hooks in the Mapbox Search JS React framework.
For installation instructions and a helpful introduction to using Search Box in your React app, see our React Search Box Quickstart Guide.
Components
SearchBox
<SearchBox>
is a React component that provides an interactive search box,
powered by the Mapbox Search Box API.
To use this element, you must have a Mapbox access token.
Internally, this wraps the <mapbox-search-box>
element.
Parameters
props
(SearchBoxProps)
Example
import { SearchBox } from "@mapbox/search-js-react";
export function Component() {
const [value, setValue] = React.useState('');
const handleChange = (d) => {
setValue(d);
};
return (
<SearchBox
options={{
proximity: {
lng: -122.431297,
lat: 37.773972,
},
}}
value={value}
onChange={handleChange}
accessToken="YOUR_MAPBOX_ACCESS_TOKEN"
/>
);
}
このsection on SearchBoxは役に立ちましたか?
Hooks
useSearchBoxCore
A React hook that returns a SearchBoxCore instance.
Parameters
Returns
SearchBoxCore
Example
import { useSearchBoxCore } from '@mapbox/search-js-react';
const searchBoxCore = useSearchBoxCore({ accessToken: 'YOUR_MAPBOX_ACCESS_TOKEN' });
const response = await searchBoxCore.suggest('1600 pennsylvania ave nw', {
sessionToken: 'test-123'
});
console.log(response);
// { suggestions: [...], attribution: '...', url: '...' };
Related
このsection on useSearchBoxCoreは役に立ちましたか?
useSearchSession
A React hook that returns a SearchSession instance.
Parameters
search
((SearchBoxCore | AddressAutofillCore))
Returns
SearchSession
: Related
このsection on useSearchSessionは役に立ちましたか?
Options and Type Definitions
SearchBoxProps
ObjectProperties
interceptSearch
(function (value: string): string)
: A callback providing the opportunity to validate and/or manipulate the input text before it triggers a search, for example by using a regular expression.
If a truthy string value is returned, it will be passed into the underlying search API. If
null
,
undefined
or empty string is returned, no search request will be performed.
map
(mapboxgl.Map)
: If specified, the map will be centered on the retrieved suggestion.
mapboxgl
(any)
: A
mapbox-gl
instance to use when creating
Markers
. Required if
SearchBoxProps#marker
is
true
.
marker
((boolean | mapboxgl.MarkerOptions))
: If
true
, a
Marker
will be added to the map at the location of the user-selected result using a default set of Marker options. If the value is an object, the marker will be constructed using these options. If
false
, no marker will be added to the map. Requires that
SearchBoxProps#mapboxgl
also be set.
onClear
(function (): void)
: Fired when the user has cleared the search box.
onRetrieve
(function (res: SearchBoxRetrieveResponse): void)
: Fired when the user has selected a suggestion.
The underlying response from
SearchBoxCore
is passed.
onSuggest
(function (res: SearchBoxSuggestionResponse): void)
: Fired when the user is typing in the input and provides a list of suggestions.
The underlying response from
SearchBoxCore
is passed.
onSuggestError
(function (error: Error): void)
: Fired when
SearchBoxCore
has errored providing a list of suggestions.
The underlying error is passed.
placeholder
(string)
: The input element's placeholder text. The default value may be localized if
SearchBoxOptions#language
is set.
このsection on SearchBoxPropsは役に立ちましたか?
このsection on SearchBoxRefTypeは役に立ちましたか?
このpageは役に立ちましたか?