Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 | 10x 4x 4x 2x 2x 2x 2x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x | /* eslint-disable @typescript-eslint/no-namespace */
import React, { useRef, useEffect, useImperativeHandle } from 'react';
import {
Options,
SuggestionResponse,
RetrieveResponse
} from '@mapbox/search-js-core';
import {
MapboxSearchBox,
Theme,
MapboxHTMLEvent,
PopoverOptions
} from '@mapbox/search-js-web';
declare global {
namespace JSX {
interface IntrinsicElements {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
'mapbox-search-box': any;
}
}
}
/**
* @typedef SearchBoxRefType
*/
export interface SearchBoxRefType {
/**
* @see {@link MapboxSearchBox#focus}
*/
focus: typeof MapboxSearchBox.prototype.focus;
}
/**
* @typedef SearchBoxProps
*/
export interface SearchBoxProps {
/**
* The [Mapbox access token](https://docs.mapbox.com/help/glossary/access-token/) to use for all requests.
*/
accessToken: string;
/**
* Options to pass to the underlying {@link MapboxSearch} interface.
* @example
* ```typescript
* <SearchBox options={{
* language: 'en',
* country: 'US',
* }}>
* ```
*/
options?: Partial<Options>;
/**
* The {@link Theme} to use for styling the search box.
* @example
* ```typescript
* <SearchBox theme={{
* variables: {
* colorPrimary: 'myBrandRed'
* }
* }}>
* ```
*/
theme?: Theme;
/**
* The {@link PopoverOptions} to define popover positioning.
* @example
* ```typescript
* <SearchBox popoverOptions={{
* placement: 'top-start',
* flip: true,
* offset: 5
* }}>
* ```
*/
popoverOptions?: Partial<PopoverOptions>;
/**
* If specified, the map will be centered on the retrieved suggestion.
*/
map?: mapboxgl.Map;
/**
* Value to display in the search box.
*/
value?: string;
/**
* Callback for when the value changes.
*/
onChange?: (value: string) => void;
/**
* Fired when the user is typing in the input and provides a list of suggestions.
* The underlying response from {@link MapboxSearch} is passed.
*/
onSuggest: (res: SuggestionResponse) => void;
/**
* Fired when {@link MapboxSearch} has errored providing a list of suggestions.
* The underlying error is passed.
*/
onSuggestError: (error: Error) => void;
/**
* Fired when the user has selected a suggestion.
* The underlying response from {@link MapboxSearch} is passed.
*/
onRetrieve: (res: RetrieveResponse) => void;
}
/**
* `<SearchBox>` is a React component that provides an interactive search box,
* powered by the Mapbox Search API.
*
* To use this element, you must have a [Mapbox access token](https://www.mapbox.com/help/create-api-access-token/).
*
* Internally, this wraps the [`<mapbox-search-box>`](https://docs.mapbox.com/mapbox-search-js/api/web/search/#mapboxsearchbox) element.
*
* @function SearchBox
* @param {SearchBoxProps} props
* @example
* ```typescript
* export function Component() {
* const [value, setValue] = React.useState('');
* return (
* <form>
* <SearchBox accessToken={<your access token here>} />
* </form>
* );
* }
* ```
*/
export const SearchBox = React.forwardRef(
(props: SearchBoxProps, refProp): React.ReactElement => {
const {
accessToken,
options,
theme,
popoverOptions,
map,
value,
onChange,
onSuggest,
onSuggestError,
onRetrieve
} = props;
const ref = useRef<MapboxSearchBox>();
useImperativeHandle(refProp, () => ({
focus: () => {
if (ref.current) return ref.current.focus();
throw new Error('SearchBox is not mounted');
}
}));
// Update options.
useEffect(() => {
if (ref.current) ref.current.options = options;
}, [ref.current, options]);
// Update theme.
useEffect(() => {
if (ref.current) ref.current.theme = theme;
}, [ref.current, theme]);
// Update popoverOptions
useEffect(() => {
if (ref.current) ref.current.popoverOptions = popoverOptions;
}, [ref.current, popoverOptions]);
// Update value.
useEffect(() => {
if (ref.current) ref.current.value = value;
}, [ref.current, value]);
// Update map.
useEffect(() => {
const node = ref.current;
Iif (!node) return;
node.bindMap(map);
return () => {
node.unbindMap();
};
}, [ref.current, map]);
// Update onSuggest.
useEffect(() => {
const node = ref.current;
Iif (!node) return;
const fn = (e: MapboxHTMLEvent<SuggestionResponse>) =>
onSuggest(e.detail);
node.addEventListener('suggest', fn);
return () => {
node.removeEventListener('suggest', fn);
};
}, [ref.current, onSuggest]);
// Update onSuggestError.
useEffect(() => {
const node = ref.current;
Iif (!node) return;
const fn = (e: MapboxHTMLEvent<Error>) => onSuggestError(e.detail);
node.addEventListener('suggesterror', fn);
return () => {
node.removeEventListener('suggesterror', fn);
};
}, [ref.current, onSuggestError]);
// Update onRetrieve.
useEffect(() => {
const node = ref.current;
Iif (!node) return;
const fn = (e: MapboxHTMLEvent<RetrieveResponse>) => onRetrieve(e.detail);
node.addEventListener('retrieve', fn);
return () => {
node.removeEventListener('retrieve', fn);
};
}, [ref.current, onRetrieve]);
// Update onChange.
useEffect(() => {
const node = ref.current;
Iif (!node) return;
const fn = (e: MapboxHTMLEvent<string>) => onChange(e.detail);
node.addEventListener('input', fn);
return () => {
node.removeEventListener('input', fn);
};
}, [ref.current, onChange]);
// Update accessToken.
useEffect(() => {
if (ref.current) ref.current.accessToken = accessToken;
}, [ref.current, accessToken]);
return <mapbox-search-box ref={ref} />;
}
);
|