honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated readme and sample.json

This commit is contained in:
Hugo Bernier 2024-08-31 19:00:11 -04:00
parent 27b5738d49
commit 0348c7fd75
2 changed files with 100 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

194
samples/react-quick-links-grid/README.md
View File

@ -1,10 +1,91 @@
# webpart-quick-links
# Quick Links Grid
## Summary
This project is a SharePoint Framework (SPFx) WebPart that displays a set of quick links fetched from a SharePoint list. The quick links are displayed with icons and titles in a responsive grid layout.
This project is a SharePoint Framework (SPFx) web part that displays a set of quick links fetched from a SharePoint list. The quick links are displayed with icons and titles in a responsive grid layout.
![Preview](./assets/react-quick-links-grid-sample-screenshot.png)
![Adding web part](./assets/preview.gif)
## Compatibility
| :warning: Important |
|:---------------------------|
| Every SPFx version is optimally compatible with specific versions of Node.js. In order to be able to build this sample, you need to ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.|
|Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. |
This sample is optimally compatible with the following environment configuration:
![SPFx 1.19.0](https://img.shields.io/badge/SPFx-1.19.0-green.svg)
![Node.js v18](https://img.shields.io/badge/Node.js-v18-green.svg)
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower")
![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
![Local Workbench Unsupported](https://img.shields.io/badge/Local%20Workbench-Unsupported-red.svg "Local workbench is no longer available as of SPFx 1.13 and above")
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)
## 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)
## Contributors
- [Venkadesh Sundaramurthy](https://github.com/VenkadeshSundaramurthy)
## Version history
| Version | Date | Comments |
| ------- | --------------- | --------------- |
| 1.0 | August 11, 2024 | Initial release |
## Prerequisites
- Node.js (v19.00.4)
- SharePoint Online environment
- A SharePoint list containing the quick links. This list is configured with columns
- **Title** - Single line of text
- **URL** - Hyperlink or Picture
- **Icon** - Single line of text // Fluent Icon names can be referred from (https://developer.microsoft.com/en-us/fluentui#/styles/web/icons)
![image](./assets/356854637-e68afa9a-0e48-40bf-abc0-f0fa12f154c7.png)
### Sample Data
![image](./assets/356854684-bae0b02d-aaa8-47ba-b3c1-57e684260fd1.png)
## Minimal path to awesome
- Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-quick-links-grid) then unzip it)
- From your command line, change your current directory to the directory containing this sample (`react-quick-links-grid`, located under `samples`)
- in the command line run:
- `npm install`
- `gulp serve`
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit <https://aka.ms/spfx-devcontainer> for further instructions.
### Configuration
Before running the WebPart, you need to configure the property pane to point to the correct SharePoint list and fields.
#### Property Pane Fields
- **List Title:** The title of the SharePoint list to fetch data from.
- **Title Field:** The internal name of the Title field in the SharePoint list.
- **URL Field:** The internal name of the URL field in the SharePoint list.
- **Icon Field:** The internal name of the Icon field in the SharePoint list.
### Usage
Run the web part locally:
gulp serve
Open the SharePoint Workbench to add the web part and configure the property pane fields.
https://github.com/user-attachments/assets/90ab66f0-e26f-4838-9803-131b42cbdc65
## Features
@ -15,111 +96,32 @@ https://github.com/user-attachments/assets/90ab66f0-e26f-4838-9803-131b42cbdc65
- **Theming Support**: Uses SharePoint theme colors for a consistent look with the rest of the SharePoint site, including theme-based colors for icons and text.
- **Error Handling**: Includes error handling for data fetching to manage issues with retrieving list items gracefully.
## Used SharePoint Framework Version
![version](https://img.shields.io/badge/version-1.19.0-green.svg)
1.19.0
## 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
- Node.js (v18.20.4)
- SharePoint Online environment
- A SharePoint list containing the quick links. This list is configured with columns
Title - Single line of text
URL - Hyperlink or Picture
Icon - Single line of text // Fluent Icon names can be referred from (https://developer.microsoft.com/en-us/fluentui#/styles/web/icons)
![image](https://github.com/user-attachments/assets/e68afa9a-0e48-40bf-abc0-f0fa12f154c7)
## Sample Data:
![image](https://github.com/user-attachments/assets/bae0b02d-aaa8-47ba-b3c1-57e684260fd1)
## Installation
1. Clone the repository:
git clone <repository-url>
2. Navigate to the project directory:
cd react-quick-links-grid
3. Install the dependencies:
npm install
## Configuration
Before running the WebPart, you need to configure the property pane to point to the correct SharePoint list and fields.
## Property Pane Fields
List Title: The title of the SharePoint list to fetch data from.
Title Field: The internal name of the Title field in the SharePoint list.
URL Field: The internal name of the URL field in the SharePoint list.
Icon Field: The internal name of the Icon field in the SharePoint list.
## Usage
Run the WebPart locally:
gulp serve
Open the SharePoint Workbench to add the WebPart and configure the property pane fields.
## Project Structure
### Project Structure
The project includes the following key files:
PnPQuickLinksGridWebPart.ts: Defines the main WebPart class and handles rendering and property pane configuration.
QuickLinksGrid.tsx: Defines the React component that fetches and displays the quick links.
PnPQuickLinksGridWebPart.module.scss: Contains the CSS styles for the QuickLinks component.
- **PnPQuickLinksGridWebPart.ts:** Defines the main web part class and handles rendering and property pane configuration.
- **QuickLinksGrid.tsx:** Defines the React component that fetches and displays the quick links.
- **PnPQuickLinksGridWebPart.module.scss:** Contains the CSS styles for the QuickLinks component.
## Building the Project
## Help
To build the project, run the following command:
We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.
gulp build
If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
## Deploying the WebPart
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-quick-links-grid%22) to see if anybody else is having the same issues.
## Solution
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-quick-links-grid) and see what the community is saying.
| Solution | Author(s) |
| ----------- | ----------------------- |
| react-quick-links-grid | Venkadesh Sundaramurthy |
If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-quick-links-grid&template=bug-report.yml&sample=react-quick-links-grid&authors=@VenkadeshSundaramurthy&title=react-quick-links-grid%20-%20).
## Version history
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-quick-links-grid&template=question.yml&sample=react-quick-links-grid&authors=@VenkadeshSundaramurthy&title=react-quick-links-grid%20-%20).
| Version | Date | Comments |
| ------- | --------------- | --------------- |
| 1.0 | August 11, 2024 | Initial release |
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-quick-links-grid&template=suggestion.yml&sample=react-quick-links-grid&authors=@VenkadeshSundaramurthy&title=react-quick-links-grid%20-%20).
## 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.**
**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.
> 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
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-quick-links-grid" />

4
samples/react-quick-links-grid/assets/sample.json
View File

@ -10,8 +10,8 @@
"Displays a set of quick links fetched from a SharePoint list.",
"The quick links are displayed with icons and titles in a responsive grid layout."
],
"creationDateTime": "2024-08-10",
"updateDateTime": "2024-08-10",
"creationDateTime": "2024-08-11",
"updateDateTime": "2024-08-11",
"products": [
"SharePoint"
],