Fixed spelling mistakes and updated README
This commit is contained in:
Hugo Bernier
parent
db37947b7b
commit
0c8c8b62a7
|
|
@ -18,37 +18,51 @@ This list search web part allows the user to show data from lists or libraries.
|
|||
* Item limit to show
|
||||
* Item pagination
|
||||
* Group items by any field
|
||||
* Cache to retreive the items
|
||||
* Cache to retrieve the items
|
||||
* Get section color
|
||||
* Show item count with custom message
|
||||
|
||||
#### Merge items from different lists/libraries
|
||||
|
||||
|
||||
|
||||
|
||||
#### Select render of the selected fields
|
||||
|
||||
|
||||
|
||||
|
||||
#### Open documents in modal window
|
||||
|
||||
|
||||
|
||||
|
||||
#### Open documents in new tab
|
||||
|
||||
|
||||
|
||||
|
||||
#### Use of dynamic data
|
||||
|
||||
|
||||
|
||||
|
||||
#### Open selected item with same data
|
||||
|
||||
|
||||
|
||||
|
||||
#### Open selected item with selected properties
|
||||
|
||||
|
||||
|
||||
|
||||
#### Redirect to url depends on selected item
|
||||
|
||||
|
||||
## Used SharePoint Framework Version
|
||||
|
||||
|
||||
|
||||
## Compatibility
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Applies to
|
||||
|
||||
|
|
@ -76,24 +90,26 @@ Version|Date|Comments
|
|||
## Minimal Path to Awesome
|
||||
|
||||
### Dev Mode
|
||||
|
||||
* Clone this repository
|
||||
* In the command line run:
|
||||
* Navigate to list-search-webpart
|
||||
* Navigate to `list-search-webpart`
|
||||
* `npm install`
|
||||
* `gulp serve`
|
||||
* Open the *workbench* on your Office 365 Developer tenant
|
||||
* Test out the web part
|
||||
|
||||
### Sppkg
|
||||
* Download sppkg files from sppkg folder
|
||||
* Upload files to App Catalog
|
||||
|
||||
* Download `.sppkg` files from `sppkg` folder
|
||||
* Upload files to **App Catalog**
|
||||
|
||||
## Features
|
||||
|
||||
This Web Part illustrates the following concepts on top of the SharePoint Framework:
|
||||
|
||||
* Using react for building SharePoint Framework client-side web parts
|
||||
* Using [PnP Js](https://pnp.github.io/pnpjs) to retreive SharePoint data
|
||||
* Using [PnP Js](https://pnp.github.io/pnpjs) to retrieve SharePoint data
|
||||
* Using [PnP Js](https://pnp.github.io/pnpjs/odata/caching) to cache SharePoint data
|
||||
* Connection between SharePoint Framework components using dynamic data
|
||||
* [Support of section backgrounds color ](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/guidance/supporting-section-backgrounds)
|
||||
|
|
|
|||
|
|
@ -1,73 +0,0 @@
|
|||
# list-search-webpart
|
||||
|
||||
## Summary
|
||||
|
||||
Short summary on functionality and used technologies.
|
||||
|
||||
[picture of the solution in action, if possible]
|
||||
|
||||
## Used SharePoint Framework Version
|
||||
|
||||
|
||||
|
||||
## Applies to
|
||||
|
||||
- [SharePoint Framework](https://aka.ms/spfx)
|
||||
- [Microsoft 365 tenant](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
|
||||
|
||||
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
> Any special pre-requisites?
|
||||
|
||||
## Solution
|
||||
|
||||
Solution|Author(s)
|
||||
--------|---------
|
||||
folder name | Author details (name, company, twitter alias with link)
|
||||
|
||||
## Version history
|
||||
|
||||
Version|Date|Comments
|
||||
-------|----|--------
|
||||
1.1|March 10, 2021|Update comment
|
||||
1.0|January 29, 2021|Initial release
|
||||
|
||||
## Disclaimer
|
||||
|
||||
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
|
||||
|
||||
---
|
||||
|
||||
## Minimal Path to Awesome
|
||||
|
||||
- Clone this repository
|
||||
- Ensure that you are at the solution folder
|
||||
- in the command-line run:
|
||||
- **npm install**
|
||||
- **gulp serve**
|
||||
|
||||
> Include any additional steps as needed.
|
||||
|
||||
## Features
|
||||
|
||||
Description of the extension that expands upon high-level summary above.
|
||||
|
||||
This extension illustrates the following concepts:
|
||||
|
||||
- topic 1
|
||||
- topic 2
|
||||
- topic 3
|
||||
|
||||
> Notice that better pictures and documentation will increase the sample usage and the value you are providing for others. Thanks for your submissions advance.
|
||||
|
||||
> Share your web part with others through Microsoft 365 Patterns and Practices program to get visibility and exposure. More details on the community, open-source projects and other activities from http://aka.ms/m365pnp.
|
||||
|
||||
## References
|
||||
|
||||
- [Getting started with SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
|
||||
- [Building for Microsoft teams](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/build-for-teams-overview)
|
||||
- [Use Microsoft Graph in your solution](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/using-microsoft-graph-apis)
|
||||
- [Publish SharePoint Framework applications to the Marketplace](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/publish-to-marketplace-overview)
|
||||
- [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development
|
||||
|
|
@ -1 +0,0 @@
|
|||
|
||||
|
|
@ -6,12 +6,12 @@ define([], function () {
|
|||
SitesSelector: "Sites to get data",
|
||||
ListSelector: "List to get the data",
|
||||
ListSelectorLabel: "Select source lists",
|
||||
ListSelectorPanelHeader: "Configure lists and queries to retreive data",
|
||||
ListSelectorPanelHeader: "Configure lists and queries to retrieve data",
|
||||
CollectionDataSiteCollectionTitle: "Site Collection",
|
||||
CollectionDataListTitle: "List",
|
||||
CollectionDataListViewNameTitle: "List View Title",
|
||||
CollectionDataListCamlQueryTitle: "Caml Query",
|
||||
CollectionDataListCamlQueryPlaceHolder: "Empty - all elemets",
|
||||
CollectionDataListCamlQueryTitle: "CAML Query",
|
||||
CollectionDataListCamlQueryPlaceHolder: "Empty - all elements",
|
||||
GeneralPropertiesShowItemCount: "Show item count",
|
||||
GeneralPropertiesRowLimitLabel: "Item limit to show",
|
||||
GeneralPropertiesRowLimitDescription: "If 0 all items are render",
|
||||
|
|
@ -19,9 +19,9 @@ define([], function () {
|
|||
GeneralPropertiesGroupByField: "Group elements",
|
||||
FieldPropertiesGroup: "Fields",
|
||||
CollectionDataFieldsProperties: "Lists Field Properties",
|
||||
CollectionDataFieldsToRetreive: "Fields to retreive",
|
||||
CollectionDataFieldsToRetreive: "Fields to retrieve",
|
||||
CollectionDataFieldsSelectBtn: "Select fields",
|
||||
CollectionDataFieldsHeader: "Select fields to retreive and their mapping",
|
||||
CollectionDataFieldsHeader: "Select fields to retrieve and their mapping",
|
||||
CollectionDataFieldsSiteCollection: "Site Collection",
|
||||
CollectionDataFieldsList: "List",
|
||||
CollectionDataFieldsListField: "List Field",
|
||||
|
|
@ -51,12 +51,12 @@ define([], function () {
|
|||
GeneralFieldsPropertiesListDisplayName: "List column display name",
|
||||
GeneralFieldsPropertiesListDisplayNameOrder: "List column display name order",
|
||||
GeneralFieldsPropertiesListDisplayNameOrderDescription: "Order of list display name column",
|
||||
GeneralFieldsPropertiesListDisplayNameSearcheable: "List title searcheable in general filter",
|
||||
GeneralFieldsPropertiesListDisplayNameSearcheable: "List title searchable in general filter",
|
||||
GeneralFieldsPropertiesSiteDisplayName: "Site column display name",
|
||||
GeneralFieldsPropertiesSiteProperty: "Site property to display",
|
||||
GeneralFieldsPropertiesSiteDisplayNameOrder: "Site column display name order",
|
||||
GeneralFieldsPropertiesSiteDisplayNameOrderDescription: "Order of site display name column",
|
||||
GeneralFieldsPropertiesSiteDisplayNameSearcheable: "Site column searcheable in general filter",
|
||||
GeneralFieldsPropertiesSiteDisplayNameSearcheable: "Site column searchable in general filter",
|
||||
FilterPropertiesGeneralFilterPlaceHolder: "General filter placeholder",
|
||||
FilterPropertiesIndividualFilterPostion: "Individual filters position",
|
||||
FilterPropertiesClearAllBtnText: "Clear all button text",
|
||||
|
|
@ -67,7 +67,7 @@ define([], function () {
|
|||
ListSearchLoading: "Loading...",
|
||||
StoragePropertiesGroupName: "Cache",
|
||||
UseLocalStorage: "Use cache",
|
||||
MinutesToCacheData: "Time (minutes) to cache the retreived data",
|
||||
MinutesToCacheData: "Time (minutes) to cache the retrieved data",
|
||||
OnClickEvent: "Use on click event",
|
||||
OnClickSimpleModalText: "Modal with current data",
|
||||
OnClickCompleteModalText: "Modal with all item fields",
|
||||
|
|
@ -82,7 +82,7 @@ define([], function () {
|
|||
CompleteModalButton: "Configure modal fields",
|
||||
CompleteModalFieldsSiteCollection: "Site Collection",
|
||||
CompleteModalFieldsList: "List",
|
||||
CompleteModalFieldsListField: "Soruce Field",
|
||||
CompleteModalFieldsListField: "Source Field",
|
||||
CompleteModalFieldsTargetField: "Display field title",
|
||||
redirectDataFieldSelector: "Select urls to redirect",
|
||||
redirectDataHeaderSelector: "For each list select the url to redirect",
|
||||
|
|
@ -93,7 +93,7 @@ define([], function () {
|
|||
OnClickNumberOfClickOptionsToSelect: "Trigger option",
|
||||
OneClickTriggerText: "One click",
|
||||
TwoClickTriggerText: "Two clicks",
|
||||
InformationPropertiesGroupName: "Webpart Information",
|
||||
InformationPropertiesGroupName: "Web part Information",
|
||||
AboutPropertiesGroupName: "About",
|
||||
OnClickPropertiesGroup: "On click Properties",
|
||||
GroupFieldOptionsToSelect: "Field to group by",
|
||||
|
Before Width: | Height: | Size: 1.2 KiB After Width: | Height: | Size: 1.2 KiB |
|
Before Width: | Height: | Size: 383 B After Width: | Height: | Size: 383 B |
|
Before Width: | Height: | Size: 1.2 KiB After Width: | Height: | Size: 1.2 KiB |
|
Before Width: | Height: | Size: 383 B After Width: | Height: | Size: 383 B |
Loading…
Reference in New Issue