Releases: microsoft-search/pnp-modern-search
Modern Search - November 2020
Search Parts
Fixes
- Added Danish language support
- Added de-de language support
- Fixed #496 null check issue
- Fixed #515 getUrl forcelink issue
- Fixed #575 regarding FQL operators and URL filters.
- Fixed #558 regarding external URL templates and property pane textfield.
- Fixed #537 smart routing issue when navigating to OOB search page
Key contributors
Modern Search - September 2020
Search Parts
Features
- Added ability to handle Z dates better #115
- Added
onerror
capability for<Icon>
- Added Swedish language support
Fixes
- Fixed refiner bugs introduced in v3.15, and allow 50000 values for RefinableString properties
- Fixed resolving if opt out for PnPTelemetry is available
- Routing error
- Fixed HTML sanitization
- Changed URL behavior in
getUrl
to work in more enviroments #414, #455 - Fixed URL's working with SharePoint routing #302
- Fixed filter/refiner handling and paging #361, #322, #406 and more
- Fixed filter/refiner handling and vertical switching #341
- Fixed persona click target #392
- Fixed preview loading #312
- Fix synonym handling where synonym has multiple terms #133
- Fix filters deep links where many filters get selected issue #230
- Fix persona link if there is no Path to the profile
- Fixed docs on
<pnp-persona-card>
#180 - Remove card click target if there is no preview #400
- Fixed sorting state #331
- Added thumbnails for videos #410
- Fixed refiner sorting based on locale #415
- Fix to handle userinfo is undefined in persona template #422
- Fix sorting issue on pagination #423
- Fix daterange refiner #449
- Fix to blur searchbox on execution #398
Key contributors
Modern Search - June 2020
Search Parts
Features
- Added the ability to specify a result by name. PR #314.
- Added German translation. PR #321
- Disable PnP component telemetry
Fixes
- Fixed #311 Added exception to DOMpurify for opening Office documents in client application.
- Fixed #308 Added an additional 'TaxId' property in results for localized taxonomy properties to be able to still use the original value in templates.
- Fixed dynamic data issue #325. PR #340.
- Fixed template leakage among web parts. PR #319
- Fixed preview for subite items
- Fix for picking correct UI culture
- Fix for URL open on mobile devices #334
Key contributors
PnP Provisioning Sample Search Template
Mark8 Project Team with custom search result page
This template illustrates the use of a custom search result page. When searching from the navigation bar search box you are redirected to a custom search result page. The search result page displays items from within the current site using SPFx search result web parts and custom templating.
Template content
The template contains the following structures and assets:
- Custom search results page using PnP Modern Search web parts
- The template is built using PnP Modern Search v3.14.2. If you have an older version installed of the PnP Modern Search web parts v3 the template might not work.
- If pnp-modern-search-parts.sppkg is already installed in your tenant, it will not be overwritten.
- Information about PnP Modern Search.
- Complex welcome page with out-of-the-box web parts
- Example images and Office documents
The template source can be found at the PnP SharePoint Provisioning Templates GitHub repository.
Notice - If applied on top of an existing communication site, the welcome page content will be overridden.
Installation
As a SharePoint administrator run the below commands to create a sample site at /sites/CustomSearch
. Change the SiteUrl
parameter to deploy it at a different URL. The template can also be applied to an existing site.
Connect-PnPOnline -Url https://contoso-admin.sharepoint.com
Apply-PnPTenantTemplate -Path .\modern-search-sample.pnp -Parameters @{"SiteUrl"="/sites/CustomSearch"}
Modern Search - May 2020
General
Search Parts
- New web components. PR #253
- Support of
.url
documents. PR #271. - Small update on refiner options filter to always display selected options, even if they do not match the filtering text specified in the text box by the user. PR #277 .
- Enhancement for Secondary Results. PR #226.
- Enhance search verticals #246
- If more than five refinement values are displayed, show apply button on top as well. PR #284 (merged manually in develop).
Search Custom Renderer
Fixes
- Fixed #273 #274 regarding PDF files preview URL. PR #280.
- Fixed issue #232. Now, we allow all custom attributes format (with or without data- prefix).
- Fixed issue #250 regarding search verticals count.
- Fixed #237 regarding the empty sort. PR #243
- BaseWebComponent in Extensibility Lib was not considering data-*. PR #245.
Key contributors
Modern Search - April 2020
General
- v3.12.1 has fix for sorting panel and open items in new tabs
- Updated documentation
Search Parts
-
[BREAKING CHANGE] Added a
data-
prefix for all web component attributes. If you created custom web component, you should add this prefix as well. -
New #172. Sanitize CSS/HTML to prevent CSS and script injection
-
New #173. Allow specifying a default vertical based on query parameter
-
New #189. SPFx page context can be retrieved using
{{getPageContext "property"}}
(32d4cc8) -
New #211. Add a feature to search verticals to be able to set an arbitrary link URL for a tab. Related to #165.
Fixes
- Fixed #179 . The styles elements were not removed once prefixed. PR #212.
- Fixed #175. The preview initialization method was not called in details list and slider components for custom Handlebars expressions. PR #213.
- Fixed #162. Reworked logic to ensure better thumbnails and open URL's for all items in all templates. PR #208.
- Fixed #156. Adding pagination to default template
- Fixed #171 #191. Improved handling of fabric icons used on items
- Fixed #158. Fixed search box theming colors when dark background
- Fixed #177 #197 #214. Fixes on sort panel and paging. PR #215 #216 #217
Key contributors
Modern Search - March 2020
[UPDATE 01/04/2020] 3.11.1: Fix #163
General
- Updated documentation
Search Parts
- [BREAKING CHANGE] Replaced the pagination Web Part by a web component. You can still decide where to put the component in the template + additional property pane options. PR #155. If you had custom templates and need pagination, refer to https://microsoft-search.github.io/pnp-modern-search/search-parts/search-pagination/.
- [BREAKING CHANGE]. Removed the search navigation Web Part. Replaced by the search verticals Web Part. PR #155
- Added an
instanceId
information in the Handlebars context for templates to be able to scope CSS styles per Web part instance. PR #155 - [BREAKING CHANGE] Removed the NLP feature from the Search Box. Even if you didn't use this feature, you will have to reconnect your search box with the Search Results WP. See https://microsoft-search.github.io/pnp-modern-search/search-parts/search-results/#search-settings.
- Added support for faster development with a separate webpack dev server. PR #144
- Added a per refiner option to be able to filter refinement values if too many displayed. PR #146
Fixes
- Fixed #118 Now search verticals fit nicely in responsive mode.
- Fixed #106 A
map
instead of afilter
was used to see if a current date range refiner was selected causing a reset of the refinement count and a null rendering. - Fixed #134 Added the logic to resolve tokens in the query template field for search verticals.
- Fixed #135 Added a default image when a 404 is returned.
- Fixed #132 Now the WP title is hidden as well when the "Show blank" option is set.
- Fixed #129 The 'Size' managed property was not returning the correct refinement name. Now, we use the refiner name every time regardless the value returned by the API.
Key contributors
Modern Search - February 2020
General
- Updated documentation
Search Parts
- Renamed the 'Search Refiners' Web Part to 'Search Filters' according to MS naming convention.
- Styling improvements regarding the search box suggestions. The suggestion content was not rendered correctly when the WP was added in a small vertical column.
- New
getAttachments
Handlebars block helper to display list item attachments . PR #86 - Ability to choose among multiple query modifiers. Only one at once per Web Part instance is allowed. PR #105
- Setting default sortable field and direction with the same field as set in the default results sort (if same field is the same option on both configurations). PR #108
- Added the ability to created deep links for refinement filters using URL query string parameter
filters
. PR #116. Related to #90 and #48.
Search Extensibility
- Ability to define multiple query modifiers that can be used in search results Web Parts. PR #105
Fixes
- Fixed #92. Now the container tree refiner template follows the "Expand filter by default" option set in the associated refiner configuration.
- Fixed #91
- Fixed #100. Now image links are correctly computed in templates and redirect on the preview instead of the list item form.
Key contributors
Modern Search - January 2020
General
- Updated documentation
Search Parts
- Added a 'Persona' and 'File type' refiner templates for the filters Web Part (#16).
- Added a 'Container tree' refiner template giving the ability to navigate trough a folder hierarchy as metadata by parsing the parent link URL segments (#72).
- Added the support of custom suggestions (#44) and query modifier (#67) for the search results Web Part.
- Added the support of section background colors via theming (#42).
- Updated the solution to SPFx 1.10.0.
Fixes
- Fixed #62
- Replaced the react-custom-scrollbars component by the Office UI Fabric Scroll pane component in the Panel layout for refiners.
- Fixed the vertical layout when many refiners are displayed.
- Fixed #69
- Added the ability to preview image files using the
getpreview.ashx
handler.
- Added the ability to preview image files using the
- Fixed #31
- Removed the
this.context.dynamicDataProvider.registerAvailableSourcesChanged(this.render);
method to avoid multiple renders every time. According to SharePoint/sp-dev-docs#2985 (comment), the DynamicProperty should wait for the wired data source and re-render the component when available so no need to to it manually anymore.
- Removed the
- Fixed #30
- Added relevant mock data for local workbench scenario.
- Fixed #43
- Added an 'OR' operator {| in available tokens for page taxonomy and choice multi values columns. Added the corresponding documentation.
- Fixed #18
- Now the text is correctly encoded in the refiner persona template.
- Fixed #28
- Added a 'TimeZoneId' information in the search query based on either the web time zone or user time zone. If the user does not have a time zone set, then we use the web time zone.
- Fixed #53
- Fixed the 'Apply/Clear' button state in multi refinement template.
- Fixed #55
- Added a 'queryModification' information in the Handlebars context to see query with SharePoint/WP resolved tokens. Now the debug template is available even if there is no results.
- Fixed #46
- Now the pagination Web Part does not render when only 1 page.
- Fixed #47 + #20
- The error was due to the searchParams.append() method encoding spaces with a '+' causing a double encoding.
- Fixed #41
- Fixed the thumbnail height in the cards layout.
- Fixed #22
- Added the missing condition for the
showFileIcon
option in the DocumentCardComponent.
- Added the missing condition for the
Search Extensibility
- Added new custom suggestions feature.
- Added new custom query modifier feature.
Search Custom Renderer
No change.
Search Query Enhancer
No change.
Key contributors
Modern Search - December 2019
General
- Improved documentation by using mkdocs
Search Parts
- Added support for custom web components registrations
- Added
totalPrimaryAndSecondaryResults
andhasPrimaryOrSecondaryResults
properties to handlbars render context - Updated all templates to display a 'No Results' message if no primary or secondary results are returned. Also, now all the templates have the ability to control the display according to results length and the 'showBlank' option.
Fixes
- Fixed PDF preview in tiles layouts #24
- Fixed loading logic to display placeholders and spinner due to #21
- Fixed #19
Search Extensibility
- Added a new extensibility project with predefined structure to create custom web components to be integrated in the search results Web Parts Handlebars templates
Search Custom Renderer
No change.
Search Query Enhancer
- Improved documentation