Skip to content

Merge main (v1.8.9) into develop #525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 35 commits into from
Jun 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
5955aef
Version 1.8.0
Fondryext Feb 20, 2025
df3726e
Add optional ariaLabel prop to FilterSearch to set aria-label on input
tpotla Mar 25, 2025
8f2f474
Automated update to repo's documentation from github action
github-actions[bot] Mar 25, 2025
b47f3f4
Merge pull request #495 from yext/dev/filtersearch-wcag-fix
k-gerner Mar 25, 2025
a1394a8
Update version to 1.8.1
k-gerner Mar 25, 2025
89a08ed
Merge pull request #500 from yext/update-package-version-1.8.1
k-gerner Mar 25, 2025
07fdc33
Fix test build errors
k-gerner Mar 25, 2025
0993d9c
Add esbuild to dev deps to force upgrade
k-gerner Mar 25, 2025
5a30e6b
try installing playwright before run test for react 16
k-gerner Mar 25, 2025
1d997d3
seemed to work with react 16, try for other versions
k-gerner Mar 25, 2025
a895f71
bump version
k-gerner Mar 25, 2025
c2607aa
Automated update to repo's documentation from github action
github-actions[bot] Mar 25, 2025
73ef0d6
add playwright install to wcag action
k-gerner Mar 25, 2025
15bf870
Add iframeWindow and allowUpdates props to MapboxMap. Also add zoom b…
k-gerner Mar 26, 2025
d0d500c
remove console.log
k-gerner Mar 26, 2025
6fe04fc
missed a couple calls to the mapboxInstance
k-gerner Mar 26, 2025
c7449b8
update coverage workflow to install playwright
k-gerner Mar 26, 2025
bc006a4
Merge pull request #503 (Update MapboxMap with VLE props for using in…
k-gerner Mar 26, 2025
99957a8
update snapshot workflow with playwright
k-gerner Mar 27, 2025
b14d7df
Update snapshots
github-actions[bot] Mar 27, 2025
77f2136
synchoronize mapbox gl version in test site and src
k-gerner Mar 27, 2025
055c51d
Merge pull request #502 from yext/hotfix/v1.8.2 - Mapbox VLE props + …
k-gerner Mar 27, 2025
3fe4af2
v1.8.3: Add debouncing to filter search and autocomplete (#511)
k-gerner Apr 14, 2025
9f1be48
Deduplicate generative answer sources (#514)
mkouzel-yext Apr 22, 2025
0d78fc0
Import `@tailwindcss/typography` for markdown styling. (#516)
anguyen-yext2 May 14, 2025
692649c
Support interactive mapbox pins (#518)
anguyen-yext2 May 21, 2025
f35d236
v1.8.7 Improve MapboxMap zoom, render, and styling functionality (#520)
k-gerner May 21, 2025
2eab3c7
Replace pinColor with markerOptionsOverride (#522)
anguyen-yext2 May 22, 2025
3ba9ab4
Localize the Mapbox map based on the search locale (#524)
anguyen-yext2 Jun 4, 2025
2a9333e
Merge branch 'develop' into dev/merge-v1.8.9-3ba9ab4-into-develop
anguyen-yext2 Jun 4, 2025
1ff5b40
Update snapshots
github-actions[bot] Jun 4, 2025
22fc9e8
Update snapshots
github-actions[bot] Jun 4, 2025
b5f226b
Update snapshots
github-actions[bot] Jun 4, 2025
1c26412
Update snapshots
github-actions[bot] Jun 4, 2025
2deb470
Update snapshots
github-actions[bot] Jun 4, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .storybook/snapshots/__snapshots__/mapboxmap--multiple-pins.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
95 changes: 93 additions & 2 deletions THIRD-PARTY-NOTICES
Original file line number Diff line number Diff line change
Expand Up @@ -1192,6 +1192,7 @@ limitations under the License.
The following NPM packages may be included in this product:

- @tailwindcss/forms@0.5.10
- @tailwindcss/typography@0.5.16
- tailwindcss@3.4.17

These packages each contain the following license and notice below:
Expand Down Expand Up @@ -3435,6 +3436,7 @@ THE SOFTWARE.
The following NPM packages may be included in this product:

- lodash-es@4.17.21
- lodash.merge@4.6.2
- lodash@4.17.21

These packages each contain the following license and notice below:
Expand Down Expand Up @@ -3489,6 +3491,94 @@ terms above.

-----------

The following NPM package may be included in this product:

- lodash.castarray@4.4.0

This package contains the following license and notice below:

The MIT License (MIT)

Copyright 2012-2016 The Dojo Foundation <http://dojofoundation.org/>
Based on Underscore.js, copyright 2009-2016 Jeremy Ashkenas,
DocumentCloud and Investigative Reporters & Editors <http://underscorejs.org/>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

-----------

The following NPM package may be included in this product:

- lodash.isplainobject@4.0.6

This package contains the following license and notice below:

Copyright jQuery Foundation and other contributors <https://jquery.org/>

Based on Underscore.js, copyright Jeremy Ashkenas,
DocumentCloud and Investigative Reporters & Editors <http://underscorejs.org/>

This software consists of voluntary contributions made by many
individuals. For exact contribution history, see the revision history
available at https://github.com/lodash/lodash

The following license applies to all parts of this software except as
documented below:

====

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

====

Copyright and related rights for sample code are waived via CC0. Sample
code is defined as all source code displayed within the prose of the
documentation.

CC0: http://creativecommons.org/publicdomain/zero/1.0/

====

Files located in the node_modules and vendor directories are externally
maintained libraries used by this software which have their own
licenses; we recommend you read them, as their terms may differ from the
terms above.

-----------

The following NPM packages may be included in this product:

- longest-streak@2.0.4
Expand Down Expand Up @@ -4680,11 +4770,12 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

-----------

The following NPM package may be included in this product:
The following NPM packages may be included in this product:

- postcss-selector-parser@6.0.10
- postcss-selector-parser@6.1.2

This package contains the following license and notice below:
These packages each contain the following license and notice below:

Copyright (c) Ben Briggs <beneb.info@gmail.com> (http://beneb.info)

Expand Down
4 changes: 2 additions & 2 deletions docs/search-ui-react.mapboxmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A component that renders a map with markers to show result locations using Mapbo
**Signature:**

```typescript
declare function MapboxMap<T>({ mapboxAccessToken, mapboxOptions, PinComponent, renderPin, getCoordinate, onDrag, iframeWindow, allowUpdates, }: MapboxMapProps<T>): JSX.Element;
declare function MapboxMap<T>({ mapboxAccessToken, mapboxOptions, PinComponent, renderPin, getCoordinate, onDrag, iframeWindow, allowUpdates, onPinClick, markerOptionsOverride, }: MapboxMapProps<T>): JSX.Element;
```

## Parameters
Expand All @@ -32,7 +32,7 @@ Description
</th></tr></thead>
<tbody><tr><td>

{ mapboxAccessToken, mapboxOptions, PinComponent, renderPin, getCoordinate, onDrag, iframeWindow, allowUpdates, }
{ mapboxAccessToken, mapboxOptions, PinComponent, renderPin, getCoordinate, onDrag, iframeWindow, allowUpdates, onPinClick, markerOptionsOverride, }


</td><td>
Expand Down
13 changes: 13 additions & 0 deletions docs/search-ui-react.mapboxmapprops.markeroptionsoverride.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [MapboxMapProps](./search-ui-react.mapboxmapprops.md) &gt; [markerOptionsOverride](./search-ui-react.mapboxmapprops.markeroptionsoverride.md)

## MapboxMapProps.markerOptionsOverride property

The options to apply to the map markers based on whether it is selected.

**Signature:**

```typescript
markerOptionsOverride?: (selected: boolean) => MarkerOptions;
```
40 changes: 39 additions & 1 deletion docs/search-ui-react.mapboxmapprops.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,25 @@ Omit&lt;mapboxgl.MapboxOptions, 'container'&gt;
_(Optional)_ Interface for map customization derived from Mapbox GL's Map options.


</td></tr>
<tr><td>

[markerOptionsOverride?](./search-ui-react.mapboxmapprops.markeroptionsoverride.md)


</td><td>


</td><td>

(selected: boolean) =&gt; MarkerOptions


</td><td>

_(Optional)_ The options to apply to the map markers based on whether it is selected.


</td></tr>
<tr><td>

Expand All @@ -145,7 +164,26 @@ _(Optional)_ Interface for map customization derived from Mapbox GL's Map option

</td><td>

_(Optional)_ A function which is called when user drag the map.
_(Optional)_ A function which is called when user drags or zooms the map.


</td></tr>
<tr><td>

[onPinClick?](./search-ui-react.mapboxmapprops.onpinclick.md)


</td><td>


</td><td>

(result: Result&lt;T&gt; \| undefined) =&gt; void


</td><td>

_(Optional)_ A function that handles a pin click event.


</td></tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/search-ui-react.mapboxmapprops.ondrag.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## MapboxMapProps.onDrag property

A function which is called when user drag the map.
A function which is called when user drags or zooms the map.

**Signature:**

Expand Down
13 changes: 13 additions & 0 deletions docs/search-ui-react.mapboxmapprops.onpinclick.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [MapboxMapProps](./search-ui-react.mapboxmapprops.md) &gt; [onPinClick](./search-ui-react.mapboxmapprops.onpinclick.md)

## MapboxMapProps.onPinClick property

A function that handles a pin click event.

**Signature:**

```typescript
onPinClick?: (result: Result<T> | undefined) => void;
```
4 changes: 2 additions & 2 deletions docs/search-ui-react.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ A React Component which displays and collects location information in order to b
</td></tr>
<tr><td>

[MapboxMap({ mapboxAccessToken, mapboxOptions, PinComponent, renderPin, getCoordinate, onDrag, iframeWindow, allowUpdates, })](./search-ui-react.mapboxmap.md)
[MapboxMap({ mapboxAccessToken, mapboxOptions, PinComponent, renderPin, getCoordinate, onDrag, iframeWindow, allowUpdates, onPinClick, markerOptionsOverride, })](./search-ui-react.mapboxmap.md)


</td><td>
Expand Down Expand Up @@ -1433,7 +1433,7 @@ The data associated with the currently focused item.

</td><td>

A function which is called when user drag the map.
A function which is called when user drags or zooms the map.


</td></tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/search-ui-react.ondraghandler.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## OnDragHandler type

A function which is called when user drag the map.
A function which is called when user drags or zooms the map.

**Signature:**

Expand Down
1 change: 1 addition & 0 deletions docs/search-ui-react.pincomponentprops.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ type PinComponentProps<T> = {
index: number;
mapbox: mapboxgl.Map;
result: Result<T>;
selected?: boolean;
};
```
19 changes: 19 additions & 0 deletions docs/search-ui-react.verticalresultsprops.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,5 +91,24 @@ boolean
_(Optional)_ Whether or not all results should be displayed when there are none returned from the search. Defaults to true.


</td></tr>
<tr><td>

[setResultsRef?](./search-ui-react.verticalresultsprops.setresultsref.md)


</td><td>


</td><td>

(index: number) =&gt; ((result: HTMLDivElement) =&gt; void) \| null


</td><td>

_(Optional)_ set individual result refs.


</td></tr>
</tbody></table>
13 changes: 13 additions & 0 deletions docs/search-ui-react.verticalresultsprops.setresultsref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [VerticalResultsProps](./search-ui-react.verticalresultsprops.md) &gt; [setResultsRef](./search-ui-react.verticalresultsprops.setresultsref.md)

## VerticalResultsProps.setResultsRef property

set individual result refs.

**Signature:**

```typescript
setResultsRef?: (index: number) => ((result: HTMLDivElement) => void) | null;
```
7 changes: 6 additions & 1 deletion etc/search-ui-react.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import { FilterSearchResponse } from '@yext/search-headless-react';
import { GenerativeDirectAnswerResponse } from '@yext/search-headless-react';
import { HighlightedValue } from '@yext/search-headless-react';
import { default as mapboxgl_2 } from 'mapbox-gl';
import { MarkerOptions } from 'mapbox-gl';
import { Matcher } from '@yext/search-headless-react';
import { NumberRangeValue } from '@yext/search-headless-react';
import { PropsWithChildren } from 'react';
Expand Down Expand Up @@ -490,7 +491,7 @@ export interface LocationBiasProps {
}

// @public
export function MapboxMap<T>({ mapboxAccessToken, mapboxOptions, PinComponent, renderPin, getCoordinate, onDrag, iframeWindow, allowUpdates, }: MapboxMapProps<T>): JSX.Element;
export function MapboxMap<T>({ mapboxAccessToken, mapboxOptions, PinComponent, renderPin, getCoordinate, onDrag, iframeWindow, allowUpdates, onPinClick, markerOptionsOverride, }: MapboxMapProps<T>): JSX.Element;

// @public
export interface MapboxMapProps<T> {
Expand All @@ -499,7 +500,9 @@ export interface MapboxMapProps<T> {
iframeWindow?: Window;
mapboxAccessToken: string;
mapboxOptions?: Omit<mapboxgl_2.MapboxOptions, 'container'>;
markerOptionsOverride?: (selected: boolean) => MarkerOptions;
onDrag?: OnDragHandler;
onPinClick?: (result: Result<T> | undefined) => void;
PinComponent?: PinComponent<T>;
renderPin?: (props: PinComponentProps<T> & {
container: HTMLElement;
Expand Down Expand Up @@ -595,6 +598,7 @@ export type PinComponentProps<T> = {
index: number;
mapbox: mapboxgl_2.Map;
result: Result<T>;
selected?: boolean;
};

// @public
Expand Down Expand Up @@ -980,6 +984,7 @@ export interface VerticalResultsProps<T> {
CardComponent: CardComponent<T>;
customCssClasses?: VerticalResultsCssClasses;
displayAllOnNoResults?: boolean;
setResultsRef?: (index: number) => ((result: HTMLDivElement) => void) | null;
}

// @public
Expand Down
Loading
Loading