Skip to content

Commit

Permalink
Merge pull request #1402 from HarminderSethi/main
Browse files Browse the repository at this point in the history
  • Loading branch information
hugoabernier authored Sep 1, 2024
2 parents 484aeff + 19d2ab0 commit be18c54
Show file tree
Hide file tree
Showing 273 changed files with 31,368 additions and 96,087 deletions.
68 changes: 34 additions & 34 deletions .github/workflows/merge-json-samples.yaml
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
name: Merge Samples

on:
push:
branches:
- main
pull_request:
branches:
- main
types: [closed]

jobs:
merge_samples:
runs-on: ubuntu-latest
if: github.event.pull_request.merged == true || github.event_name == 'push'
steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '16'

- name: Merge samples
run: node .github/scripts/merge-samples/index.js

- name: Commit and push if necessary
run: |
git config --global user.email "[email protected]"
git config --global user.name "GitHub Action"
git add -A
git diff --staged --quiet || git commit -m "Automated samples.json update"
git push
name: Merge Samples

on:
push:
branches:
- main
pull_request:
branches:
- main
types: [closed]

jobs:
merge_samples:
runs-on: ubuntu-latest
if: github.event.pull_request.merged == true || github.event_name == 'push'
steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '16'

- name: Merge samples
run: node .github/scripts/merge-samples/index.js

- name: Commit and push if necessary
run: |
git config --global user.email "[email protected]"
git config --global user.name "GitHub Action"
git add -A
git diff --staged --quiet || git commit -m "Automated samples.json update"
git push
4 changes: 2 additions & 2 deletions .metadata/samples.json
Original file line number Diff line number Diff line change
Expand Up @@ -7237,7 +7237,7 @@
"2. Copy Name allows to copy the name of the document without using the currently available rename functionality."
],
"creationDateTime": "2023-10-04",
"updateDateTime": "2023-10-04",
"updateDateTime": "2024-08-28",
"products": [
"SharePoint"
],
Expand All @@ -7248,7 +7248,7 @@
},
{
"key": "SPFX-VERSION",
"value": "1.18.0"
"value": "1.19.0"
}
],
"tags": [],
Expand Down
182 changes: 91 additions & 91 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,91 +1,91 @@
---
page_type: sample
products:
- office-sp
languages:
- typescript
extensions:
contentType: samples
technologies:
- SharePoint Framework
createdDate: 6/1/2017 4:27:24 AM
---
# SharePoint Framework Extensions Samples & Tutorial Materials

This repository contains the samples that demonstrate different usage patterns for the SharePoint Framework extensions.

> We do welcome community contributions to the samples folder in this repository for demonstrating different use cases with SharePoint Framework. Notice that if you use 3rd party libraries, please make sure that library license allows distributions of it as part of your sample.
SharePoint extensions are controls that appear inside a SharePoint page but run locally in the browser. They're the building blocks of pages that appear on a SharePoint site. You can build extensions using modern script development tools and you can deploy your extensions to modern pages in Office 365 tenants. In addition to plain JavaScript projects, you can build extensions alongside common scripting frameworks, such as AngularJS and React. For example, you can use React along with components from [Fluent UI](https://developer.microsoft.com/en-us/fluentui#/) to quickly create experiences based on the same components used in Office 365 natively.

## Have issues or questions?

Please use following logic on submitting your questions or issues to right location to ensure that they are noticed and addressed as soon as possible.

* You have general question or challenge with SPFx - use [sp-dev-docs repository issue list](https://github.com/SharePoint/sp-dev-docs/issues).
* You have issue on specific extension or sample - use [issue list in this repository](https://github.com/pnp/sp-dev-fx-extensions/issues).

## Additional resources

* [SharePoint Framework Extensions](https://docs.microsoft.com/sharepoint/dev/spfx/extensions/overview-extensions)
* [Overview of the SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [SharePoint Framework development tools and libraries](https://docs.microsoft.com/sharepoint/dev/spfx/tools-and-libraries)

## Using the samples

To build and start using these projects, you'll need to clone and build the projects.

Clone this repo by executing the following command in your console:

```shell
git clone https://github.com/pnp/sp-dev-fx-extensions.git
```

Navigate to the cloned repository folder which should be the same as the repository name:

```shell
cd sp-dev-fx-extensions
```

To access the samples use the following command, where you replace `sample-folder-name` with the name of the sample you want to access.

```shell
cd samples
cd sample-folder-name
```

and for the tutorials, use the following command:

```shell
cd tutorials
```

Now run the following command to install the npm packages:

```shell
npm install
```

This will install the required npm packages and dependencies to build and run the client-side project.

Once the npm packages are installed, run the following command to start nodejs to host your extension and preview that in the SharePoint Online pages:

```shell
gulp serve
```

## Authors

This repository's contributors are all community members who volunteered their time to share code samples. Work is done as an open source community project, with each sample contained in their own solution.

## Contributions

These samples are direct from the feature teams, SharePoint PnP core team (http://aka.ms/m365pnp) or shared by the community. We welcome your input on issues and suggestions for new samples. We do also welcome community contributions around the extensions. If you have any questions, just let us know.

Please have a look on our [Contribution Guidance](./CONTRIBUTING.md) before submitting your pull requests, so that we can get your contribution processed as fast as possible.

## Code of Conduct

This repository has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

> Sharing is caring!
---
page_type: sample
products:
- office-sp
languages:
- typescript
extensions:
contentType: samples
technologies:
- SharePoint Framework
createdDate: 6/1/2017 4:27:24 AM
---
# SharePoint Framework Extensions Samples & Tutorial Materials

This repository contains the samples that demonstrate different usage patterns for the SharePoint Framework extensions.

> We do welcome community contributions to the samples folder in this repository for demonstrating different use cases with SharePoint Framework. Notice that if you use 3rd party libraries, please make sure that library license allows distributions of it as part of your sample.
SharePoint extensions are controls that appear inside a SharePoint page but run locally in the browser. They're the building blocks of pages that appear on a SharePoint site. You can build extensions using modern script development tools and you can deploy your extensions to modern pages in Office 365 tenants. In addition to plain JavaScript projects, you can build extensions alongside common scripting frameworks, such as AngularJS and React. For example, you can use React along with components from [Fluent UI](https://developer.microsoft.com/en-us/fluentui#/) to quickly create experiences based on the same components used in Office 365 natively.

## Have issues or questions?

Please use following logic on submitting your questions or issues to right location to ensure that they are noticed and addressed as soon as possible.

* You have general question or challenge with SPFx - use [sp-dev-docs repository issue list](https://github.com/SharePoint/sp-dev-docs/issues).
* You have issue on specific extension or sample - use [issue list in this repository](https://github.com/pnp/sp-dev-fx-extensions/issues).

## Additional resources

* [SharePoint Framework Extensions](https://docs.microsoft.com/sharepoint/dev/spfx/extensions/overview-extensions)
* [Overview of the SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [SharePoint Framework development tools and libraries](https://docs.microsoft.com/sharepoint/dev/spfx/tools-and-libraries)

## Using the samples

To build and start using these projects, you'll need to clone and build the projects.

Clone this repo by executing the following command in your console:

```shell
git clone https://github.com/pnp/sp-dev-fx-extensions.git
```

Navigate to the cloned repository folder which should be the same as the repository name:

```shell
cd sp-dev-fx-extensions
```

To access the samples use the following command, where you replace `sample-folder-name` with the name of the sample you want to access.

```shell
cd samples
cd sample-folder-name
```

and for the tutorials, use the following command:

```shell
cd tutorials
```

Now run the following command to install the npm packages:

```shell
npm install
```

This will install the required npm packages and dependencies to build and run the client-side project.

Once the npm packages are installed, run the following command to start nodejs to host your extension and preview that in the SharePoint Online pages:

```shell
gulp serve
```

## Authors

This repository's contributors are all community members who volunteered their time to share code samples. Work is done as an open source community project, with each sample contained in their own solution.

## Contributions

These samples are direct from the feature teams, SharePoint PnP core team (http://aka.ms/m365pnp) or shared by the community. We welcome your input on issues and suggestions for new samples. We do also welcome community contributions around the extensions. If you have any questions, just let us know.

Please have a look on our [Contribution Guidance](./CONTRIBUTING.md) before submitting your pull requests, so that we can get your contribution processed as fast as possible.

## Code of Conduct

This repository has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

> Sharing is caring!
13 changes: 0 additions & 13 deletions samples/js-application-analytics/.vscode/settings.json

This file was deleted.

Loading

0 comments on commit be18c54

Please sign in to comment.