Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CHANGELOG.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
{
"versions": [
{
"version": "3.20.0",
"changes": {
"new": [],
"enhancements": [
"Dispose of Async instance to prevent memory leak [#636](https://github.com/pnp/sp-dev-fx-property-controls/pull/636)"
],
"fixes": [
"`PropertyFieldDateTimePicker`: Fixed small typos and a sample in the documentation [#628](https://github.com/pnp/sp-dev-fx-property-controls/pull/628)",
"`PropertyFieldGrid`: Export PropertyFieldGrid [#642](https://github.com/pnp/sp-dev-fx-property-controls/pull/642)",
"`PropertyFieldViewPicker`: Export PropertyFieldViewPicker [#643](https://github.com/pnp/sp-dev-fx-property-controls/pull/643)",
"`PropertyFieldFolderPicker`: Fix property control page link [#644](https://github.com/pnp/sp-dev-fx-property-controls/pull/644)",
"`PropertyFieldDateTimePicker` & `PropertyFieldColorPicker`: Fix inaccurate localization for Swedish [#645](https://github.com/pnp/sp-dev-fx-property-controls/pull/645)"
]
},
"contributions": [
"[Antanina Druzhkina](https://github.com/Ateina)",
"[Guido Zambarda](https://github.com/GuidoZam)",
"[Kevin T. Coughlin](https://github.com/KevinTCoughlin)",
"[Peter Paul Kirschner](https://github.com/petkir)"
]
},
{
"version": "3.19.0",
"changes": {
Expand Down
18 changes: 18 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Releases

## 3.20.0

### Enhancements

- Dispose of Async instance to prevent memory leak [#636](https://github.com/pnp/sp-dev-fx-property-controls/pull/636)

### Fixes

- `PropertyFieldDateTimePicker`: Fixed small typos and a sample in the documentation [#628](https://github.com/pnp/sp-dev-fx-property-controls/pull/628)
- `PropertyFieldGrid`: Export PropertyFieldGrid [#642](https://github.com/pnp/sp-dev-fx-property-controls/pull/642)
- `PropertyFieldViewPicker`: Export PropertyFieldViewPicker [#643](https://github.com/pnp/sp-dev-fx-property-controls/pull/643)
- `PropertyFieldFolderPicker`: Fix property control page link [#644](https://github.com/pnp/sp-dev-fx-property-controls/pull/644)
- `PropertyFieldDateTimePicker` & `PropertyFieldColorPicker`: Fix inaccurate localization for Swedish [#645](https://github.com/pnp/sp-dev-fx-property-controls/pull/645)

### Contributors

Special thanks to our contributors (in alphabetical order): [Antanina Druzhkina](https://github.com/Ateina), [Guido Zambarda](https://github.com/GuidoZam), [Kevin T. Coughlin](https://github.com/KevinTCoughlin), [Peter Paul Kirschner](https://github.com/petkir).

## 3.19.0

## 3.18.0
Expand Down
1 change: 0 additions & 1 deletion config/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
},
"externals": {},
"localizedResources": {
"PropertyControlsTestWebPartStrings": "lib/webparts/propertyControlsTest/loc/{locale}.js",
"PropertyControlStrings": "lib/loc/{locale}.js"
}
}
18 changes: 18 additions & 0 deletions docs/documentation/docs/about/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Releases

## 3.20.0

### Enhancements

- Dispose of Async instance to prevent memory leak [#636](https://github.com/pnp/sp-dev-fx-property-controls/pull/636)

### Fixes

- `PropertyFieldDateTimePicker`: Fixed small typos and a sample in the documentation [#628](https://github.com/pnp/sp-dev-fx-property-controls/pull/628)
- `PropertyFieldGrid`: Export PropertyFieldGrid [#642](https://github.com/pnp/sp-dev-fx-property-controls/pull/642)
- `PropertyFieldViewPicker`: Export PropertyFieldViewPicker [#643](https://github.com/pnp/sp-dev-fx-property-controls/pull/643)
- `PropertyFieldFolderPicker`: Fix property control page link [#644](https://github.com/pnp/sp-dev-fx-property-controls/pull/644)
- `PropertyFieldDateTimePicker` & `PropertyFieldColorPicker`: Fix inaccurate localization for Swedish [#645](https://github.com/pnp/sp-dev-fx-property-controls/pull/645)

### Contributors

Special thanks to our contributors (in alphabetical order): [Antanina Druzhkina](https://github.com/Ateina), [Guido Zambarda](https://github.com/GuidoZam), [Kevin T. Coughlin](https://github.com/KevinTCoughlin), [Peter Paul Kirschner](https://github.com/petkir).

## 3.19.0

## 3.18.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ PropertyFieldDateTimePicker('datetime', {
timeConvention: TimeConvention.Hours12,
onPropertyChange: this.onPropertyPaneFieldChanged,
properties: this.properties,
onGetErrorMessage: null,
onGetErrorMessage: undefined,
deferredValidationTime: 0,
key: 'dateTimeFieldId',
showLabels: false
Expand All @@ -61,8 +61,8 @@ The `PropertyFieldDateTimePicker` control can be configured with the following p
| ---- | ---- | ---- | ---- |
| label | string | yes | Property field label displayed on top. |
| disabled | boolean | no | Specify if the control needs to be disabled. |
| initialData | IDateTimeFieldValue | yes | Initial date and time value of the control. |
| formatData | function | no | Defines a formatDate function that can override the output value. |
| initialDate | IDateTimeFieldValue | yes | Initial date and time value of the control. |
| formatDate | function | no | Defines a formatDate function that can override the output value. |
| dateConvention | DateConvention | no | Defines the date convention to use. By default this is set to date and time. |
| timeConvention | TimeConvention | no | Defines the time convention to use. By default this is set to 24-hour clock convention. |
| onPropertyChange | function | yes | Defines a onPropertyChange function to raise when the date gets changed. |
Expand Down
24 changes: 13 additions & 11 deletions docs/documentation/docs/guides/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,23 @@ Typos are embarrassing! Most PR's that fix typos will be accepted immediately. I
Before contributing:

- ensure that the **dev** branch on your fork is in sync with the original **sp-dev-fx-property-controls** repository
```sh
# assuming you are in the folder of your locally cloned fork....
git checkout dev

# assuming you have a remote named `upstream` pointing to the official **sp-dev-fx-property-controls** repo
git fetch upstream
```bash
# assuming you are in the folder of your locally cloned fork....
git checkout dev

# update your local dev to be a mirror of what's in the main repo
git pull --rebase upstream dev
```
# assuming you have a remote named `upstream` pointing to the official **sp-dev-fx-property-controls** repo
git fetch upstream

# update your local dev to be a mirror of what's in the main repo
git pull --rebase upstream dev
```

- create a feature branch for your change. If you'll get stuck on an issue or merging your PR will take a while, this will allow you to have a clean dev branch that you can use for contributing other changes
```sh
git checkout -b my-contribution
```

```bash
git checkout -b my-contribution
```

## DO's & DON'Ts

Expand Down
24 changes: 18 additions & 6 deletions docs/documentation/docs/guides/mpa.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,38 @@ The shortest way to prepare your local copy of the project for development and t

## Install prerequisites

Before you start contributing to this project, you will need Node.js. This project has been tested with the 10.x version of Node.js and the version of NPM that comes with it. You can use [Node Version Manager](https://github.com/nvm-sh/nvm) to switch between different versions of Node.js.
Before you start contributing to this project, you will need Node.js. This project (current version 3.x) has been tested with the 18.x version of Node.js and the version of NPM that comes with it. You can use [Node Version Manager](https://github.com/nvm-sh/nvm) or [Node Version Switcher](https://github.com/jasongin/nvs) to switch between different versions of Node.js.

## Get the local version of the project

- fork this repository
- clone your fork
- in the command line:
- in the command line, run the following commands:
- run `npm install` to restore dependencies
- run `gulp serve` to serve your project
- Start making your changes
- `npm install -g gulp-cli` in order to run `gulp` commands (run `npm list -g gulp-cli` to check if already installed on your machine or not)
- `gulp serve` to serve your project (or `npm run serve` if you want to use [`spfx-fast-serve`](https://github.com/s-KaiNet/spfx-fast-serve))
- Start making your changes

### Run the project locally

As this project embeds a SPFx solution, you have the ability to test all the property controls on your machine.

You can also debug them in any supported language, by running one of the following commands (for example in _french_):

- `gulp serve --locale=fr-fr`
- `npx fast-serve --locale=fr-fr` (if using `spfx-fast-serve`)

### Documentation

SharePoint Framework Property Controls uses [MkDocs](http://www.mkdocs.org) to publish documentation pages. See more information about installing MkDocs on your operating system at http://www.mkdocs.org/#installation.
SharePoint Framework Property Controls uses [MkDocs](http://www.mkdocs.org) to publish documentation pages. See more information about installing MkDocs on your operating system at <http://www.mkdocs.org/#installation>.

Also, documentation uses custom MkDocs theme that should be installed as well. See [Material theme for MkDocs](https://squidfunk.github.io/mkdocs-material/)
Also, documentation uses custom MkDocs theme that should be installed as well. See [Material theme for MkDocs](https://squidfunk.github.io/mkdocs-material/). Currently, documentation is working with version 3.1.0.

Once you have MkDocs and Material theme installed on your machine, in the command line:

- run `cd ./docs/documentation` to change directory to where the manual pages are stored
- run `mkdocs serve` to start the local web server with MkDocs and view the documentation in the web browser

For documentation update, we suggest you to use IDE extensions to help you for the writing process. For example, if you're using VS Code, you can install [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) for words spelling and [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) or [learn-markdown](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-markdown) for Markdown syntax.

![](https://telemetry.sharepointpnp.com/sp-dev-fx-property-controls/wiki/mpa)
35 changes: 18 additions & 17 deletions docs/documentation/docs/guides/submitting-pr.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,31 @@

We appreciate your initiative and would love to integrate your work with the rest of the project! Here is how you can help us do it as quickly as possible.

- check, that your feature branch is up-to-date. If it's not, there is a risk of merge conflicts or other issues that will complicate merging your changes into the main repository. Refer to these resources for more information on syncing your repo:
- Check, that your feature branch is up-to-date. If it's not, there is a risk of merge conflicts or other issues that will complicate merging your changes into the main repository. Refer to these resources for more information on syncing your repo:
- [GitHub Help: Syncing a Fork](https://help.github.com/articles/syncing-a-fork/)
- [AC: Keep Your Forked Git Repo Updated with Changes from the Original Upstream Repo](http://www.andrewconnell.com/blog/keep-your-forked-git-repo-updated-with-changes-from-the-original-upstream-repo)
- Looking for a quick cheat sheet? Look no further:

```sh
# assuming you are in the folder of your locally cloned fork....
git checkout dev
```bash
# assuming you are in the folder of your locally cloned fork....
git checkout dev

# assuming you have a remote named `upstream` pointing to the official **sp-dev-fx-property-controls** repo
git fetch upstream
# assuming you have a remote named `upstream` pointing to the official **sp-dev-fx-property-controls** repo
git fetch upstream

# update your local dev branch to be a mirror of what's in the main repo
git pull --rebase upstream dev
# update your local dev branch to be a mirror of what's in the main repo
git pull --rebase upstream dev

# switch to your branch where you are working, say "issue-xyz"
git checkout issue-xyz
# switch to your branch where you are working, say "issue-xyz"
git checkout issue-xyz

# update your branch to update its fork point to the current tip of dev & put your changes on top of it
git rebase dev
```
- submit PR to the **dev** branch of the main repo. PRs submitted to other branches will be declined
- let us know what's in the PR: is it a new command, bug fix or a minor update in the docs? The clearer the information you provide, the quicker your PR can be verified and merged
- ideally 1 PR = 1 commit - this makes it easier to keep the log clear for everyone and track what's changed. If you're new to working with git, we'll squash your commits for you when merging your changes into the main repo
- don't worry about changing the version or adding yourself to the list of contributors in `package.json`. We'll do that for you when merging your changes.
# update your branch to update its fork point to the current tip of dev & put your changes on top of it
git rebase dev
```

- Submit PR to the **dev** branch of the main repo. PRs submitted to other branches will be declined
- Let us know what's in the PR: is it a new command, bug fix or a minor update in the docs? The clearer the information you provide, the quicker your PR can be verified and merged
- Ideally 1 PR = 1 commit - this makes it easier to keep the log clear for everyone and track what's changed. If you're new to working with git, we'll squash your commits for you when merging your changes into the main repo
- Don't worry about changing the version or adding yourself to the list of contributors in `package.json`. We'll do that for you when merging your changes.

![](https://telemetry.sharepointpnp.com/sp-dev-fx-property-controls/wiki/SubmitPR)
9 changes: 7 additions & 2 deletions docs/documentation/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
site_name: '@pnp/spfx-property-controls'
nav:
- Home: 'index.md'
- 'Beta testing': 'beta.md'
- Guides:
- Overview: 'guides/index.md'
- Contributing: 'guides/contributing.md'
- 'Minimal Path to Awesome': 'guides/mpa.md'
- 'Submitting a PR': 'guides/submitting-pr.md'
- 'Migrate v1 to v2': 'guides/migrate-from-v1.md'
- Controls:
- PropertyFieldButton: 'controls/PropertyFieldButton.md'
- PropertyFieldCodeEditor: 'controls/PropertyFieldCodeEditor.md'
Expand Down Expand Up @@ -47,11 +54,9 @@ nav:
- PropertyFieldToggleWithCallout: 'controls/PropertyFieldToggleWithCallout.md'
- Helpers:
- PropertyPaneHelpers: 'helpers/PropertyPaneHelpers.md'
- 'Beta testing': 'beta.md'
- About:
- 'Release notes': 'about/release-notes.md'
- License: 'about/license.md'
- 'Project Guides': 'guides'
theme:
name: 'material'
palette:
Expand Down
Loading