Releases: microsoft-search/pnp-modern-search
Releases · microsoft-search/pnp-modern-search
PnP Modern Search - 4.9.0
This solution includes only one .sppkg file:
pnp-modern-search-parts-<version_number>.sppkg(Mandatory).
Extensions (i.e. custom web components, layouts, etc.) must be deployed separately. See PnP Modern Search - Extensibility samples for more information.
Useful resources
What's Changed
- Small documentation corrections by @edarroudi in #2593
- 2644: Bug fix to allow the search results WebPart use the pagination buttons in MS Teams APP and MS Teams Web by @Macro21 in #2669
- #2507 Updated mgt package by @wobba in #2671
- Correct data-selection-all-toggle documentation by @patrikhellgren in #2679
- Fix for Select All button in DetailsList by @patrikhellgren in #2678
- BUG: Fixed paging error in "MS Teams Mobile". by @Macro21 in #2676
- Updated Create-a-useful-People-Search.md by @kasperbolarsen in #2689
- Fix for #2140 by @wobba in #2697
- First revision on Use PnP Search as a department web part scenario by @kasperbolarsen in #2720
- #2624: Bug fix to unhide disappearing filters without page refresh by @salimbharuchi in #2741
- New scenario Use query string from url for dynamic results by @davemehr in #2737
- First revision on additional guidance for issue verification before logging an issue by @kasperbolarsen in #2764
- Address vulnerabilities identified by Whitesource by @erkanch in #2843
- Changes to swedish translations by @patrikhellgren in #2841
- Fix for layout slots settings dialog by @patrikhellgren in #2845
- Update nb-no.js by @kjetilodegaarden in #2881
- @layer support added for search result styles by @StfBauer in #2924
- Fix tld length by @Lotsamocha01 in #2938
- Fix #2956 and #2847 by @wobba in #2957
- Support result web part as Teams app with SPFx Teams Context exposed by @wobba in #3004
- Fix AutoPreviewUrl slot to be view only by @wobba in #3008
- Allow .txt files as external template files for filter/result web part by @wobba in #3021
- Allow to clear as long as one value is picked by @wobba in #3027
- Don't replace {searchTerms} if empty by @wobba in #3028
- #1601 Made date range include start and end date by @wobba in #3029
- Added deephits parameter to refiners by @wobba in #3032
- Improve focus on item selection by @wobba in #3033
- #2242 Support props starting with a number in slots by @wobba in #3034
- Remove padding if hide on no result by @wobba in #3038
- Prefer thumbnailurl if present by @wobba in #3041
- Make guid regx better by @wobba in #3042
- Remove click handler for icon by @wobba in #3044
- Added collapse specification property by @svenbru in #3043
- Fix for number tokens in refinement strings by @wobba in #3039
New Contributors
- @Macro21 made their first contribution in #2669
- @kasperbolarsen made their first contribution in #2689
- @salimbharuchi made their first contribution in #2741
- @kjetilodegaarden made their first contribution in #2881
- @StfBauer made their first contribution in #2924
- @Lotsamocha01 made their first contribution in #2938
- @svenbru made their first contribution in #3043
Full Changelog: 4.8.0...4.9.0
Contributors
wobba, edarroudi, and 11 other contributors
Assets 3
PnP Modern Search - 4.8.0
This solution includes only one .sppkg file:
pnp-modern-search-parts-<version_number>.sppkg(Mandatory).
Note 1 This version uses SPFx v1.15.2. Any extensions you have must be upgraded and rebuilt to SPFx v1.15.2 to continue to work.
Note 2 Depending on the version you upgrade from and if you add the solution per site you may have to remove the app and re-add it for web parts to show up. Existing web parts will still work. This is due to an internal SPFx feature id change. See this Twitter thread.
Extensions (i.e. custom web components, layouts, etc.) must be deployed separately. See PnP Modern Search - Extensibility samples for more information.
Useful resources
What's Changed
- Fix for main branch package.json by @wobba in #2201
- Fixed #2205 - The custom layouts form extensibility libraries were not loaded in the property pane. by @FranckyC in #2218
- Fixed #1967 and DetailsList z-index by @FranckyC in #2219
- Fixed #2211 - Revert to previous version of @pnp/spfx-property-controls (3.2.0) by @FranckyC in #2220
- Fixed #1941 - Add "Presence.Read.All" permissions by default for the SPFx package by @FranckyC in #2252
- Scroll to view top of results by @emilyk0520 in #2244
- Bump terser from 4.8.0 to 4.8.1 in /search-extensibility by @dependabot in #2246
- Fixed #2212 regarding localization flag and owstaxidmetadataalltagsinfo managed property by @FranckyC in #2267
- Fixed #2280 - URL hash change was not triggered for search box by @FranckyC in #2285
- Fixed #2259 - Reset page number when new filters are selected by @FranckyC in #2286
- Bump terser from 4.8.0 to 4.8.1 in /search-extensibility by @dependabot in #2300
- Added missing translations for the sort control (#2288) by @FranckyC in #2301
- Disable PnP js telemetry by @wobba in #2309
- Fix #2308 by @wobba in #2312
- news scenario by @davemehr in #2323
- Added support for actionable Adaptive Cards in results by @PaoloPia in #2243
- Fixed small issues and typos in docs by @PaoloPia in #2361
- Added Teams messages entity type option for Microsoft search data source by @FranckyC in #2364
- Creating pt-br localization files and correct en-us file. by @Porantim in #2370
- Introducing clear search on empty search box by @salascz in #2369
- Fix to not use input query text after disabling by @patrikhellgren in #2395
- Disable interleaving when using query rules. by @wobba in #2473
- Fix: Rerender on empty results when inputQuery changes by @edarroudi in #2462
- Beta Entity Types Bookmark & Acronym by @edarroudi in #2446
- Upgrade spfx 115 by @wobba in #2518
- Pagination deeplink by @ferrarirosso in #2503
- Add "semver": "7.3.5" back by @brianpmccullough in #2528
- Use icons from fluentui package by @wobba in #2531
- Feature: interface query transformation by @edarroudi in #2035
- Enable custom data source extensibility by @patrikhellgren in #2400
- Removed a Typo by @asadrefai in #2254
- [Fix] Filter count bug due to PR2503 by @edarroudi in #2548
- Fix #2483 by @wobba in #2554
- Fixed #2555 - Added token resolution in the refinement filters field for SharePoint data source by @FranckyC in #2560
- Added Microsoft Graph Toolkit option for adaptive cards layout by @FranckyC in #2569
New Contributors
- @emilyk0520 made their first contribution in #2244
- @PaoloPia made their first contribution in #2243
- @Porantim made their first contribution in #2370
- @salascz made their first contribution in #2369
- @ferrarirosso made their first contribution in #2503
- @brianpmccullough made their first contribution in #2528
- @asadrefai made their first contribution in #2254
Full Changelog: 4.7.0...4.8.0
Modern Search v4 - June 2022
PnP Modern Search v4
This solution includes now only one .sppkg file:
pnp-modern-search-parts-v4.sppkg. Mandatory.
Getting started documentation here: https://microsoft-search.github.io/pnp-modern-search/
Feedback and comments are welcomed!
NOTE: We've updated the SPFx version to
1.14.0. If you have custom extensions, you must rebuild them using SPFx v1.14.0. If not they will not load.
Search Results Web Part
New features
- PR #2116 - Added support of adaptive cards layout rendering and Microsoft Search result types.
- PR #2125 - Allow tokens in "Send the query to a new page/ Property Page URL".
- PR #2135
- Added a trim duplicates options for SharePoint search and Microsoft Search (beta only).
- Added support of query template in Microsoft Search (beta endpoint only).
Fixes
- PR #2049 - Fixed #1803 Security fixes.
- PR #2065 - Fixed #2059 Support SharePoint soft navigation.
- PR #2068, #2043, #2108 - Fixed typos.
- PR #2087 - Fixed #2080 Udpdating the result types Handlebars expression to use the slot function and handle complex property paths (like resource."@odata.type").
- PR #2157 - Fixed #2151 - Fixed preview pane for 'List' and 'Cards' layouts when item selection is enabled.
- PR #2148 - Sanitize input query in getCountMessage
- PR #2181 - Fix/set graph version header
- PR #2171 - Fixed #2170 rowheader default changed to false
- PR #2167 - Support current URL for urlParse
Search filters
Fixes
- PR #2104 - Fixed #2031 Now the filter combo box values list is not re rendered when a filtered value is selected allowing to select multiple values consecutively.
- PR #2119 - Fixed #2072 Issue with localization enabled.
Search Verticals
Fixes
- PR #2133 - Fixed #2001 Check box filter text color for dark background.
- PR #2132 - Fixed #2130 Added a check on the vertical tab hyperlink if the search box query is empty and pass an empty string instead of undefined.
- PR #2134 - Fixed #2027 Fixed date intervals wording to match actual filter conditions #2027.
Search Box
Fixes
- PR #2090 - Checking nulls when clearing search.
Key contributors
Modern Search v4 - April 2022
PnP Modern Search v4
This solution includes now only one .sppkg file:
pnp-modern-search-parts-v4.sppkg. Mandatory.
Getting started documentation here: https://microsoft-search.github.io/pnp-modern-search/
Feedback and comments are welcomed!
Search Results Web Part
New features
- PR #1931
- Added a sort control component to layouts:
- Now the list of sortable properties is a static list of 'Sortable' managed properties in the search schema. Custom properties or RefinableXXX have to be entered manually.
- Updated the Details List sort behavior. Now there is no static sorting anymore. The field used to sort a column comes from the data source sort settings configuration and we clearly make the distinction between display value and sort value in the configuration.
- Added a sort control component to layouts:
- PR #1873 - Included new function for Handlebars Helper.
- PR #1989 - Added Spanish translations.
- PR #1987 - Added German translations.
- PR #1786 - Feature/fix query alteration options
- PR #1908 - Added pagination to the 'Custom' layout
Fixes
- PR #1986 - Fixed #1372 Fix momentjs locale
- PR #1980 - Fixed #1840 Added a conditional check for the data source reference property.
- PR #1979 - Fixed #1965 Added properties and utils from the main context to the Details List and Cards Handlebars context.
- PR #1952 - Fixed #1893 Added note in documentation about SPFx version for extensions.
- PR #1951 - Fixed #1943 Combo box search filter is now case insensitive.
- PR #1937 - Added data-instance-id to pnp-slider template.
- PR #1879 - Fixed #1878 Fix for multi-value UPA values.
- PR #1837 - Fixed #1797 Only enclosed term text value with the string() operator. Other values remain HEX encoded.
- PR #1836 - Fixed #1835. Refinement token shouldn't be enclosed with quotes if contains the range() FQL operator.
Search filters
N/A
Search Verticals
N/A
Search Box
N/A
Key contributors
Modern Search v4 - April 2022 (pre-release)
PnP Modern Search v4
This solution includes now only one .sppkg file:
pnp-modern-search-parts-v4.sppkg. Mandatory.
Getting started documentation here: https://microsoft-search.github.io/pnp-modern-search/
Feedback and comments are welcomed!
Search Results Web Part
New features
- PR #1931
- Added a sort control component to layouts:
- Now the list of sortable properties is a static list of 'Sortable' managed properties in the search schema. Custom properties or RefinableXXX have to be entered manually.
- Updated the Details List sort behavior. Now there is no static sorting anymore. The field used to sort a column comes from the data source sort settings configuration and we clearly make the distinction between display value and sort value in the configuration.
- Added a sort control component to layouts:
- PR #1873 - Included new function for Handlebars Helper.
Fixes
- PR #1980 - Fixed #1840 Added a conditional check for the data source reference property.
- PR #1979 - Fixed #1965 Added properties and utils from the main context to the Details List and Cards Handlebars context.
- PR #1952 - Fixed #1893 Added note in documentation about SPFx version for extensions.
- PR #1951 - Fixed #1943 Combo box search filter is now case insensitive.
- PR #1937 - Added data-instance-id to pnp-slider template.
- PR #1879 - Fixed #1878 Fix for multi-value UPA values.
- PR #1837 - Fixed #1797 Only enclosed term text value with the string() operator. Other values remain HEX encoded.
- PR #1836 - Fixed #1835. Refinement token shouldn't be enclosed with quotes if contains the range() FQL operator.
Search filters
N/A
Search Verticals
N/A
Search Box
N/A
Key contributors
Modern Search v4 - February 2022
PnP Modern Search v4
This solution includes now only one .sppkg file:
pnp-modern-search-parts-v4.sppkg. Mandatory.
Getting started documentation here: https://microsoft-search.github.io/pnp-modern-search/
Feedback and comments are welcomed!
General
- PR #1399 - Add finnish translations.
- PR #1671 - New scenario: "Create a search page with verticals within the same page".
Search Results Web Part
New features
- PR #1790 - Added "Hit Highlighted Properties" property for SharePoint data source.
Fixes
- PR #1764 - Fixed an issue where the
{inputQueryText}token was resolved as 'undefined' if empty and treated as a literal expression in query template.Now initialized as an empty string. - PR #1773 - #1749 Fix for moment and missing generic culture for Chinese.
- PR #1684 - Fixed #1675.
- PR #1666 - Fixed #1660 by moving Apply/Clear buttons on top of the combo box.
- PR #1784 - Fixed #1769 Updated the token logic for
{Site}and{User}tokens. If the token property is not found in the current context (client side resolution) then the value is let untouched for server side processing as a query variable + restricted manual character escape to curly braces only. - PR #1787 - Fixed #1729 Remove generated link with Url fragment (#) for tags in list and cards layout + CSS improvements.
- PR #1730 - Fixed #1623
- PR #1728 - Query template field value persistence fix.
- PR #1710 - Selected filter tags from overflowing.
- PR #1703 - Fixed an issue regarding taxonomy label translations. Refiners coming from formatted property bag properties (ex: L0|#) or 'owstaxidmetadataalltagsinfo' managed property were not translated correctly.
- PR #1692 - Item selection and tokens improvements.
- PR #1673 - Updated the
ObjectHelper,byPathmethod to handle wrong expression correctly. - PR #1665 - Fixed #1651.
- PR #1663 - Fixed missing FR translations #1662.
Search filters
N/A
Search Verticals
N/A
Search Box
N/A
Key contributors
Modern Search v4 - December 2021
[4.5.3 Update]
- Fixed #1651
- Fixed #1650
- Fixed #1662
- Fixed #1660
- [Microsoft Search] Updated property pane fields to match API capabilities. PR #1661.
[4.5.2 Update]
[4.5.1 Update]
- Fixed an issue where the
{User.Audiences}token were resolved as empty if used in the query template. - Added the Import/Export settings for the Search Verticals Web Part. #1634.
- Fixed Swedish translations #1643.
- Possible fix for #1483. PR #1646.
- Removed the "Include OneDrive results" option from SharePoint data source as it is not needed anymore (included by default).
PnP Modern Search v4
This solution includes now only one .sppkg file:
pnp-modern-search-parts-v4.sppkg. Mandatory.
Getting started documentation here: https://microsoft-search.github.io/pnp-modern-search/
Feedback and comments are welcomed!
General
- Add norwegian translations. PR #1498.
Search Results Web Part
New features
- Added a toggle in the property to turn on/off the PnP telemetry (application insights) PR #1523.
- Added support for result source configuration by scope and name. PR #1509.
- Added custom layout support. PR #1565.
- Added Search Results Web Parts connection capability. PR #1551.
- Updated verticals connection. Now you can select more than one vertical from the Search Results Web Part. PR #1551.
- Search data sources updates. PR #1540.
- Updated Microsoft Search source to use the v1.0 Graph endpoint and let user decide to use beta as well.
- Added dynamic managed properties list for sort order in Microsoft Search source.
- Normalized refinement string generation for both sources.
- Added the '{&' token operator to create AND KQL queries with comma delimited strings. PR #1521.
- Add getTagName helper. PR #1468.
- Added a Query Template option for the Microsoft Search data source. Original PR by @edarroudi #1484.
- Added spelling suggestions support in options for the Microsoft Search data source (from PR #1480 by @edarroudi).
Fixes
- PR #1561 Remove GUID strings from highlighted summary in the
getSummaryHandlebars helper. - PR #1591 Fixed
window.history.pushStateupdated twice causing default SharePoint links to break. - PR #1521 Updated the token resolution logic to use an escaped Regex instead of raw string if the case it contains special characters.
- Fixed #1550 - Cannot read properties of undefined (reading 'q'). PR #1618.
- Fixed #1579 - Getting site icon instead of correct image for items. PR #1619.
Search filters
New Features
- Added the ability to connect a search filters Web Part to a vertical. PR #1580.
- Search filters UI improvements. PR #1542.
- Added the ability to choose the operator dynamically for multi valued filters.
- Added a search box and a scroll behavior to handle long list of filter values.
- Updated UI for 'Checkbox' template. Now checkboxes are only used for multi values (radio buttons otherwise).
Fixes
- Ensure URL hash is always at the end of the string. PR #1624.
Search Verticals
New features
- Added new options for a vertical. Ability to set custom value usable with as tokens (
{verticals.value}for Search Results WP + select default vertical with query string parameter. PR #1551.
Fixes
- Fixed #1584 - Search Verticals Web Part Hover Issue on Dark Section Background
Key contributors
Modern Search v3 - December 2021
Contributors
wobba and cebud
Assets 3
Modern Search v4 - October 2021
PnP Modern Search v4
This solution includes now only one .sppkg file:
pnp-modern-search-parts-v4.sppkg. Mandatory.
Getting started documentation here: https://microsoft-search.github.io/pnp-modern-search/
Feedback and comments are welcomed!
Important - Important - Important
- IE11 support removed
- There's been an issue where
onclick,onloadetc. has not been sanitized correctly. This is now fixed so script (injection) in templated should now be fully blocked.- Custom templates with fallback/error templates on images are affected, and will require updates!
- Query variable handling now aligns with the classic implementation, and how Microsoft Search will handle them. A missing variable needs to have the
{?...}notation for the part to be removed from the KQL. It will not be replaced with*.
Search Results Web Part
General
- [Documentation] Clarify how to add managed properties to the selected properties in search results.
New features
- #1282 - Adds ability to sort columns with Handlebars expressions on Details List
- #1317 - Pick language from page translation over page context if available
- #1272 - Update
getAttachmentsHandlebars helper code to include index - #1402 - Added accessibility
Fixes
- #1352 - Wrong Handlebars context for the
groupByhelper. - #1188 - Updated the thumbnail and preview logic to not load thumbnail for non-SPO domains and interactive preview for different domain than Web Part.
- #1329 - Cards template with odd numbers
- #1277 - Fix preview for folders and fix icon for OneNote's
- #1236 - Double encoding for queryText in Search Box
- #1204 - Fix/Normalization for Taxonomy Refiner Localization
- #1178 - Fixed warning messages due to multiple file type icons load in the template service
- #1311 - Use correct UTZ date as bases
- #1178 - Optimize UI fabric styling and console warnings
- #1183 - Fixed some nl translations
- #1231 - Fix parsing of
{?QueryString.Parameter}query variable notation - #1252 - Allow pasting comma separated list of managed properties into selected properties
- #1191 - CSS fix for the persona template
- #1189 - Pick language from page translation over page context if available
- #1329 - Fixed cards template with odd numbers
- #1267 - Search Filters & Search Results break when lazy loading from header link
- #1348 - Fix preview and icon for site results in list template
- #1328 - Split on | for User multivalue tokens
- #1390 - Add
pnp-imgto be used instead ofimgtag and fix sanitization of markup attributes - #1392 - Fixed the 'default' helper
- #1339 - Fix for % in query term
- #1046 - UX changes to error message handling
Search filters
Fixes
- #1225 - Sticky "Apply | Clear" buttons in ComboBox
- #1222 - Fix touch scroll on filter panel
- #1323 - Filter combo control stops to "search as you type" after closing dropdown once with Esc-key or mouse.
- #1287 - Filters Modified Date Interval Wording
- #1144 - Filter panel appears when clearing search terms
- #1165 - Fix combo box selection issue
- #1185 - Allow accented characters in filter web part's filter box
- #1267 - Search Filters & Search Results break when lazy loading from header link
- #1287 - Filters Modified Date Interval Wording
- #1444 - Web Part does not re-render after a pushState when query string parameter is used in tokens
- #1402 - Accessibility compatibility
New Features
- #1282 - Adds ability to sort columns with handlebar expressions on Details List
- #1402 - Added accessibility
- #1364 - Add support for
personandlistentity on the graph provider. - #1428 - Added polish translations
- #1367 - Added filter deep links feature
- #1450 - Improved Swedish translations
Search box
New features
- #1402 - Added accessibility
Fixes
- #1339 - Fix for % in query term
Release PR link
#1426 All commits
Key contributors
Modern Search v3 - October 2021
Fixes
- #1212 Fix on triggering search on URL change
- #1251 Don't show preview for folders
- #1185 Allow filtering on diacritic characters in filters
- #1339 Fix when there's a % in the query
- #1392 Fix for
defaulthandlebar helper - Updated DOMpurify
New
- #1042 Allow text input on date filter
- #881 Added refinement values to template context
- #1046 Allow styling of error message - and show error message together with template
Key contributors
Contributors
wobba and jimmywim