Skip to content

Commit c690734

Browse files
Merge branch 'dev' of https://github.com/pnp/sp-dev-fx-controls-react into feature/treeview-clear
2 parents ff30d04 + 19676dc commit c690734

File tree

114 files changed

+5319
-360
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+5319
-360
lines changed

CHANGELOG.JSON

Lines changed: 62 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,62 @@
11
{
22
"versions": [
3+
{
4+
"version": "2.4.0",
5+
"changes": {
6+
"new": [
7+
"`AccessibleAccordion` control [#770](https://github.com/pnp/sp-dev-fx-controls-react/pull/770)"
8+
],
9+
"enhancements": [
10+
"`Placeholder`: support of custom rendering for `iconText` and `description`",
11+
"`PeoplePicker`: ability just to display inactive users name (ideally the value fetched from 'Author/Title') [#768](https://github.com/pnp/sp-dev-fx-controls-react/issues/768)",
12+
"`TaxonomyPicker`: New `onPanelSelectionChange` property added. Can be used to interact with the control while selecting items in the panel, before Click or Cancel is clicked. [#761](https://github.com/pnp/sp-dev-fx-controls-react/issues/761)",
13+
"`TaxonomyPicker`: `selectChildrenIfParentSelected` property added. Specifies if the children should be selected when parent item is selected (defaults to false). [#765](https://github.com/pnp/sp-dev-fx-controls-react/issues/765)",
14+
"`ListPicker`: ability to pick lists from specified site using `webAbsoluteUrl` property.",
15+
"`FilePicker`: `buttonIconProps` to define properties of the button's icon [#770](https://github.com/pnp/sp-dev-fx-controls-react/pull/770)"
16+
],
17+
"fixes": [
18+
"`DateTimePicker`: documentation fix [#767](https://github.com/pnp/sp-dev-fx-controls-react/pull/767)",
19+
"`PeoplePicker`: documentation fix - Changed isRequired property to new required [#769](https://github.com/pnp/sp-dev-fx-controls-react/pull/769)",
20+
"Documentation fix - missing `IFramePanel` link on home page [#775](https://github.com/pnp/sp-dev-fx-controls-react/pull/775)",
21+
"Documentation fix for `FilePicker`: updated `onChaged` to `onChange` [#776](https://github.com/pnp/sp-dev-fx-controls-react/pull/776)"
22+
]
23+
},
24+
"contributions": [
25+
"[André Lage](https://github.com/aaclage)",
26+
"[Christian Metz](https://github.com/ChrisOMetz)",
27+
"[Gaurav Goyal](https://github.com/Gaurav8Bizportals)",
28+
"[Leif Frederiksen](https://github.com/Leif-Frederiksen)",
29+
"[Ravichandran Krishnasamy](https://github.com/ravichandran-blog)",
30+
"[San](https://github.com/sankarkumar23)",
31+
"[João Mendes](https://github.com/joaojmendes)"
32+
]
33+
},
34+
{
35+
"version": "2.3.0",
36+
"changes": {
37+
"new": [
38+
"`Dashboard` control for Microsoft Teams [#758](https://github.com/pnp/sp-dev-fx-controls-react/pull/758)",
39+
"`Toobar` control for Microsoft Teams [#758](https://github.com/pnp/sp-dev-fx-controls-react/pull/758)"
40+
],
41+
"enhancements": [
42+
"`TaxonomyPicker`: Added `useSessionStorage` property [#759](https://github.com/pnp/sp-dev-fx-controls-react/pull/759)"
43+
],
44+
"fixes": [
45+
"`FilePicker`: documentation fix: '|' not escaped [#756](https://github.com/pnp/sp-dev-fx-controls-react/pull/756)",
46+
"`TaxonomyPicker`: Return `TermSetId` for suggestions [#762](https://github.com/pnp/sp-dev-fx-controls-react/pull/762)",
47+
"`WebPartTitle`: Fluent UI Updates to SharePoint - WebPartTitle control too thin now [#605](https://github.com/pnp/sp-dev-fx-controls-react/issues/605)",
48+
"`ListView`: Sticky Header scrolling issue [#734](https://github.com/pnp/sp-dev-fx-controls-react/issues/734)",
49+
"`DateTimePicker`: hours dropdown not re-rendered when state changed programmatically [#757](https://github.com/pnp/sp-dev-fx-controls-react/issues/757)",
50+
"`RichText`: controlled mode doesn't work [#666](https://github.com/pnp/sp-dev-fx-controls-react/issues/666)"
51+
]
52+
},
53+
"contributions": [
54+
"[Gautam Sheth](https://github.com/gautamdsheth)",
55+
"[Marcin Wojciechowski](https://github.com/mgwojciech)",
56+
"[Nikolay Belykh](https://github.com/nbelyh)",
57+
"[André Lage](https://github.com/aaclage)"
58+
]
59+
},
360
{
461
"version": "2.2.0",
562
"changes": {
@@ -10,7 +67,8 @@
1067
"`FieldCollectionData`: `SearchBox` instead of `TextBox` [#719](https://github.com/pnp/sp-dev-fx-controls-react/pull/719)",
1168
"`TaxonomyPicker`: control does not show an error message for an invalid/unresolved input [#728](https://github.com/pnp/sp-dev-fx-controls-react/issues/728)",
1269
"Canadian French localization [#671](https://github.com/pnp/sp-dev-fx-controls-react/issues/671)",
13-
"`FilePicker`: reduce bundle size [#732](https://github.com/pnp/sp-dev-fx-controls-react/issues/732)"
70+
"`FilePicker`: reduce bundle size [#732](https://github.com/pnp/sp-dev-fx-controls-react/issues/732)",
71+
"`FilePicker`: Custom render callbacks for the 'Upload' and 'Link' tabs [#746](https://github.com/pnp/sp-dev-fx-controls-react/issues/746)"
1472
],
1573
"fixes": [
1674
"Localization: Fixing some wrong localizations for the DatePicker short day in Spanish.[#702](https://github.com/pnp/sp-dev-fx-controls-react/pull/702)",
@@ -24,7 +82,8 @@
2482
"Documentation fix for 'attention' block on index page [#740](https://github.com/pnp/sp-dev-fx-controls-react/pull/740)",
2583
"`TaxonomyPicker`: `sessionStorage` exceeds max-size when browsing large termsets [#739](https://github.com/pnp/sp-dev-fx-controls-react/issues/739)",
2684
"`FolderExplorer` and `FolderPicker` do not seem to work for document libraries [#741](https://github.com/pnp/sp-dev-fx-controls-react/issues/741)",
27-
"`FilePicker`: `onChange` event does not exist despite being documented [#747](https://github.com/pnp/sp-dev-fx-controls-react/issues/747)"
85+
"`FilePicker`: `onChange` event does not exist despite being documented [#747](https://github.com/pnp/sp-dev-fx-controls-react/issues/747)",
86+
"`ListItemPicker`: Selected values are not getting cleared or reset [#659](https://github.com/pnp/sp-dev-fx-controls-react/issues/659)"
2887
]
2988
},
3089
"contributions": [
@@ -139,8 +198,7 @@
139198
{
140199
"version": "1.19.0",
141200
"changes": {
142-
"new": [
143-
],
201+
"new": [],
144202
"enhancements": [
145203
"`ListView`: Add clear button to filter text box [#549](https://github.com/pnp/sp-dev-fx-controls-react/issues/549)",
146204
"`FolderExplorer`: Add clear button to filter text box [#553](https://github.com/pnp/sp-dev-fx-controls-react/pull/553)",

CHANGELOG.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,55 @@
11
# Releases
22

3+
## 2.4.0
4+
5+
### New control(s)
6+
7+
- `AccessibleAccordion` control [#770](https://github.com/pnp/sp-dev-fx-controls-react/pull/770)
8+
9+
### Enhancements
10+
11+
- `Placeholder`: support of custom rendering for `iconText` and `description`
12+
- `PeoplePicker`: ability just to display inactive users name (ideally the value fetched from 'Author/Title') [#768](https://github.com/pnp/sp-dev-fx-controls-react/issues/768)
13+
- `TaxonomyPicker`: New `onPanelSelectionChange` property added. Can be used to interact with the control while selecting items in the panel, before Click or Cancel is clicked. [#761](https://github.com/pnp/sp-dev-fx-controls-react/issues/761)
14+
- `TaxonomyPicker`: `selectChildrenIfParentSelected` property added. Specifies if the children should be selected when parent item is selected (defaults to false). [#765](https://github.com/pnp/sp-dev-fx-controls-react/issues/765)
15+
- `ListPicker`: ability to pick lists from specified site using `webAbsoluteUrl` property.
16+
- `FilePicker`: `buttonIconProps` to define properties of the button's icon [#770](https://github.com/pnp/sp-dev-fx-controls-react/pull/770)
17+
18+
### Fixes
19+
20+
- `DateTimePicker`: documentation fix [#767](https://github.com/pnp/sp-dev-fx-controls-react/pull/767)
21+
- `PeoplePicker`: documentation fix - Changed isRequired property to new required [#769](https://github.com/pnp/sp-dev-fx-controls-react/pull/769)
22+
- Documentation fix - missing `IFramePanel` link on home page [#775](https://github.com/pnp/sp-dev-fx-controls-react/pull/775)
23+
- Documentation fix for `FilePicker`: updated `onChaged` to `onChange` [#776](https://github.com/pnp/sp-dev-fx-controls-react/pull/776)
24+
25+
### Contributors
26+
27+
Special thanks to our contributors (in alphabetical order): [André Lage](https://github.com/aaclage), [Christian Metz](https://github.com/ChrisOMetz), [Gaurav Goyal](https://github.com/Gaurav8Bizportals), [Leif Frederiksen](https://github.com/Leif-Frederiksen), [Ravichandran Krishnasamy](https://github.com/ravichandran-blog), [San](https://github.com/sankarkumar23), [João Mendes](https://github.com/joaojmendes).
28+
29+
## 2.3.0
30+
31+
### New control(s)
32+
33+
- `Dashboard` control for Microsoft Teams [#758](https://github.com/pnp/sp-dev-fx-controls-react/pull/758)
34+
- `Toobar` control for Microsoft Teams [#758](https://github.com/pnp/sp-dev-fx-controls-react/pull/758)
35+
36+
### Enhancements
37+
38+
- `TaxonomyPicker`: Added `useSessionStorage` property [#759](https://github.com/pnp/sp-dev-fx-controls-react/pull/759)
39+
40+
### Fixes
41+
42+
- `FilePicker`: documentation fix: '|' not escaped [#756](https://github.com/pnp/sp-dev-fx-controls-react/pull/756)
43+
- `TaxonomyPicker`: Return `TermSetId` for suggestions [#762](https://github.com/pnp/sp-dev-fx-controls-react/pull/762)
44+
- `WebPartTitle`: Fluent UI Updates to SharePoint - WebPartTitle control too thin now [#605](https://github.com/pnp/sp-dev-fx-controls-react/issues/605)
45+
- `ListView`: Sticky Header scrolling issue [#734](https://github.com/pnp/sp-dev-fx-controls-react/issues/734)
46+
- `DateTimePicker`: hours dropdown not re-rendered when state changed programmatically [#757](https://github.com/pnp/sp-dev-fx-controls-react/issues/757)
47+
- `RichText`: controlled mode doesn't work [#666](https://github.com/pnp/sp-dev-fx-controls-react/issues/666)
48+
49+
### Contributors
50+
51+
Special thanks to our contributors (in alphabetical order): [Gautam Sheth](https://github.com/gautamdsheth), [Marcin Wojciechowski](https://github.com/mgwojciech), [Nikolay Belykh](https://github.com/nbelyh), [André Lage](https://github.com/aaclage).
52+
353
## 2.2.0
454

555
### Enhancements
@@ -10,6 +60,7 @@
1060
- `TaxonomyPicker`: control does not show an error message for an invalid/unresolved input [#728](https://github.com/pnp/sp-dev-fx-controls-react/issues/728)
1161
- Canadian French localization [#671](https://github.com/pnp/sp-dev-fx-controls-react/issues/671)
1262
- `FilePicker`: reduce bundle size [#732](https://github.com/pnp/sp-dev-fx-controls-react/issues/732)
63+
- `FilePicker`: Custom render callbacks for the 'Upload' and 'Link' tabs [#746](https://github.com/pnp/sp-dev-fx-controls-react/issues/746)
1364

1465
### Fixes
1566

@@ -25,6 +76,7 @@
2576
- `TaxonomyPicker`: `sessionStorage` exceeds max-size when browsing large termsets [#739](https://github.com/pnp/sp-dev-fx-controls-react/issues/739)
2677
- `FolderExplorer` and `FolderPicker` do not seem to work for document libraries [#741](https://github.com/pnp/sp-dev-fx-controls-react/issues/741)
2778
- `FilePicker`: `onChange` event does not exist despite being documented [#747](https://github.com/pnp/sp-dev-fx-controls-react/issues/747)
79+
- `ListItemPicker`: Selected values are not getting cleared or reset [#659](https://github.com/pnp/sp-dev-fx-controls-react/issues/659)
2880

2981
### Contributors
3082

docs/documentation/docs/about/release-notes.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,55 @@
11
# Releases
22

3+
## 2.4.0
4+
5+
### New control(s)
6+
7+
- `AccessibleAccordion` control [#770](https://github.com/pnp/sp-dev-fx-controls-react/pull/770)
8+
9+
### Enhancements
10+
11+
- `Placeholder`: support of custom rendering for `iconText` and `description`
12+
- `PeoplePicker`: ability just to display inactive users name (ideally the value fetched from 'Author/Title') [#768](https://github.com/pnp/sp-dev-fx-controls-react/issues/768)
13+
- `TaxonomyPicker`: New `onPanelSelectionChange` property added. Can be used to interact with the control while selecting items in the panel, before Click or Cancel is clicked. [#761](https://github.com/pnp/sp-dev-fx-controls-react/issues/761)
14+
- `TaxonomyPicker`: `selectChildrenIfParentSelected` property added. Specifies if the children should be selected when parent item is selected (defaults to false). [#765](https://github.com/pnp/sp-dev-fx-controls-react/issues/765)
15+
- `ListPicker`: ability to pick lists from specified site using `webAbsoluteUrl` property.
16+
- `FilePicker`: `buttonIconProps` to define properties of the button's icon [#770](https://github.com/pnp/sp-dev-fx-controls-react/pull/770)
17+
18+
### Fixes
19+
20+
- `DateTimePicker`: documentation fix [#767](https://github.com/pnp/sp-dev-fx-controls-react/pull/767)
21+
- `PeoplePicker`: documentation fix - Changed isRequired property to new required [#769](https://github.com/pnp/sp-dev-fx-controls-react/pull/769)
22+
- Documentation fix - missing `IFramePanel` link on home page [#775](https://github.com/pnp/sp-dev-fx-controls-react/pull/775)
23+
- Documentation fix for `FilePicker`: updated `onChaged` to `onChange` [#776](https://github.com/pnp/sp-dev-fx-controls-react/pull/776)
24+
25+
### Contributors
26+
27+
Special thanks to our contributors (in alphabetical order): [André Lage](https://github.com/aaclage), [Christian Metz](https://github.com/ChrisOMetz), [Gaurav Goyal](https://github.com/Gaurav8Bizportals), [Leif Frederiksen](https://github.com/Leif-Frederiksen), [Ravichandran Krishnasamy](https://github.com/ravichandran-blog), [San](https://github.com/sankarkumar23), [João Mendes](https://github.com/joaojmendes).
28+
29+
## 2.3.0
30+
31+
### New control(s)
32+
33+
- `Dashboard` control for Microsoft Teams [#758](https://github.com/pnp/sp-dev-fx-controls-react/pull/758)
34+
- `Toobar` control for Microsoft Teams [#758](https://github.com/pnp/sp-dev-fx-controls-react/pull/758)
35+
36+
### Enhancements
37+
38+
- `TaxonomyPicker`: Added `useSessionStorage` property [#759](https://github.com/pnp/sp-dev-fx-controls-react/pull/759)
39+
40+
### Fixes
41+
42+
- `FilePicker`: documentation fix: '|' not escaped [#756](https://github.com/pnp/sp-dev-fx-controls-react/pull/756)
43+
- `TaxonomyPicker`: Return `TermSetId` for suggestions [#762](https://github.com/pnp/sp-dev-fx-controls-react/pull/762)
44+
- `WebPartTitle`: Fluent UI Updates to SharePoint - WebPartTitle control too thin now [#605](https://github.com/pnp/sp-dev-fx-controls-react/issues/605)
45+
- `ListView`: Sticky Header scrolling issue [#734](https://github.com/pnp/sp-dev-fx-controls-react/issues/734)
46+
- `DateTimePicker`: hours dropdown not re-rendered when state changed programmatically [#757](https://github.com/pnp/sp-dev-fx-controls-react/issues/757)
47+
- `RichText`: controlled mode doesn't work [#666](https://github.com/pnp/sp-dev-fx-controls-react/issues/666)
48+
49+
### Contributors
50+
51+
Special thanks to our contributors (in alphabetical order): [Gautam Sheth](https://github.com/gautamdsheth), [Marcin Wojciechowski](https://github.com/mgwojciech), [Nikolay Belykh](https://github.com/nbelyh), [André Lage](https://github.com/aaclage).
52+
353
## 2.2.0
454

555
### Enhancements
@@ -10,6 +60,7 @@
1060
- `TaxonomyPicker`: control does not show an error message for an invalid/unresolved input [#728](https://github.com/pnp/sp-dev-fx-controls-react/issues/728)
1161
- Canadian French localization [#671](https://github.com/pnp/sp-dev-fx-controls-react/issues/671)
1262
- `FilePicker`: reduce bundle size [#732](https://github.com/pnp/sp-dev-fx-controls-react/issues/732)
63+
- `FilePicker`: Custom render callbacks for the 'Upload' and 'Link' tabs [#746](https://github.com/pnp/sp-dev-fx-controls-react/issues/746)
1364

1465
### Fixes
1566

@@ -25,6 +76,7 @@
2576
- `TaxonomyPicker`: `sessionStorage` exceeds max-size when browsing large termsets [#739](https://github.com/pnp/sp-dev-fx-controls-react/issues/739)
2677
- `FolderExplorer` and `FolderPicker` do not seem to work for document libraries [#741](https://github.com/pnp/sp-dev-fx-controls-react/issues/741)
2778
- `FilePicker`: `onChange` event does not exist despite being documented [#747](https://github.com/pnp/sp-dev-fx-controls-react/issues/747)
79+
- `ListItemPicker`: Selected values are not getting cleared or reset [#659](https://github.com/pnp/sp-dev-fx-controls-react/issues/659)
2880

2981
### Contributors
3082

387 KB
Loading
99.4 KB
Loading
42.5 KB
Loading
Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
# Dashboard control
2+
3+
Dashboard component for Microsoft Teams.
4+
5+
!!! Note
6+
As this component is based on `@fluentui/react-northstar` the main usage scenario is Microsoft Teams projects. You can still use it in non-Teams related projects as well.
7+
8+
Here is an example of the control in action:
9+
10+
![Carousel control](../assets/dashboard.png)
11+
12+
## How to use this control in your solutions
13+
14+
- Check that you installed the `@pnp/spfx-controls-react` dependency. Check out the [getting started](../../#getting-started) page for more information about installing the dependency.
15+
- Import the following modules to your component:
16+
17+
```TypeScript
18+
import { WidgetSize, Dashboard } from '@pnp/spfx-controls-react/lib/Dashboard';
19+
```
20+
21+
- Use the `Dashboard` control in your code as follows:
22+
23+
```TypeSCript
24+
const linkExample = { href: "#" };
25+
const calloutItemsExample = [
26+
{
27+
id: "action_1",
28+
title: "Info",
29+
icon: <Icon iconName={'Edit'} />,
30+
},
31+
{ id: "action_2", title: "Popup", icon: <Icon iconName={'Add'} /> },
32+
];
33+
// ...
34+
<Dashboard
35+
widgets={[{
36+
title: "Card 1",
37+
desc: "Last updated Monday, April 4 at 11:15 AM (PT)",
38+
widgetActionGroup: calloutItemsExample,
39+
size: WidgetSize.Triple,
40+
body: [
41+
{
42+
id: "t1",
43+
title: "Tab 1",
44+
content: (
45+
<Text>
46+
Content #1
47+
</Text>
48+
),
49+
},
50+
{
51+
id: "t2",
52+
title: "Tab 2",
53+
content: (
54+
<Text>
55+
Content #2
56+
</Text>
57+
),
58+
},
59+
{
60+
id: "t3",
61+
title: "Tab 3",
62+
content: (
63+
<Text>
64+
Content #3
65+
</Text>
66+
),
67+
},
68+
],
69+
link: linkExample,
70+
},
71+
{
72+
title: "Card 2",
73+
size: WidgetSize.Single,
74+
link: linkExample,
75+
},
76+
{
77+
title: "Card 3",
78+
size: WidgetSize.Double,
79+
link: linkExample,
80+
}]} />
81+
```
82+
83+
## Implementation
84+
85+
The Dashboard component can be configured with the following properties:
86+
87+
| Property | Type | Required | Description |
88+
| ---- | ---- | ---- | ---- |
89+
| widgets | IWidget[] | yes | Widgtets collection. |
90+
| allowHidingWidget | boolean | no | Specifies if widgets can be hidden from the dashboard. |
91+
| onWidgetHiding | (widget: IWidget) => void | no | Handler of widget hiding event. |
92+
| toolbarProps | IToolbarProps | no | Dashboard toolbar props. See [Toolbar](./Toolbar). |
93+
94+
Interface `IWidget`
95+
96+
Provides settings of Dashboard's widget
97+
98+
| Property | Type | Required | Description |
99+
| ---- | ---- | ---- | ---- |
100+
| size | WidgetSize | yes | Size. |
101+
| title | string | yes | Title. |
102+
| desc | string | no | Description. |
103+
| widgetActionGroup | IWidgetActionKey[] | no | Actions. |
104+
| controlOptions | IWidgetControlOptions | no | Component rendering options. |
105+
| body | IWidgetBodyContent[] | no | Widget's content (children) rendered as tabs. |
106+
| link | IWidgetLink | no | Widget's link rendered at the bottom part of the widget. |
107+
108+
Interface `IWidgetActionKey`
109+
110+
Provides Dashboard Widget Action properties
111+
112+
| Property | Type | Required | Description |
113+
| ---- | ---- | ---- | ---- |
114+
| id | string | yes | Action id. |
115+
| icon | JSX.Element | no | Action icon. |
116+
| title | string | yes | Action title. |
117+
| onClick | () => void | no | Action handler. |
118+
119+
Interface `IWidgetControlOptions`
120+
121+
Provides Widget component options
122+
123+
| Property | Type | Required | Description |
124+
| ---- | ---- | ---- | ---- |
125+
| isHidden | boolean | no | Specifies if current widget is hidden. |
126+
127+
Interface `IWidgetBodyContent`
128+
129+
Provides Widget content (tab) properties
130+
131+
| Property | Type | Required | Description |
132+
| ---- | ---- | ---- | ---- |
133+
| id | string | yes | Content (tab) id. |
134+
| title | string | yes | Content (tab) title. |
135+
| content | React.ReactNode | yes | Tab content. |
136+
137+
Interface `IWidgetLink`
138+
139+
Provides Widget link properties
140+
141+
| Property | Type | Required | Description |
142+
| ---- | ---- | ---- | ---- |
143+
| href | string | yes | Link to be opened. |
144+
145+
Enum `WidgetSize`
146+
147+
Provides size of the widget
148+
149+
| Value | Description |
150+
| ---- | ---- |
151+
| Single | Single-sized grid item. |
152+
| Double | Double-width grid item. |
153+
| Triple | Triple width grid item. |
154+
| Box | Double-width, double-height grid item. |
155+
156+
![](https://telemetry.sharepointpnp.com/sp-dev-fx-controls-react/wiki/controls/Dashboard)

0 commit comments

Comments
 (0)