21 |
`;
34 | }
35 |
36 | protected get dataVersion(): Version {
37 | return Version.parse('1.0');
38 | }
39 |
40 | protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
41 | return {
42 | pages: [
43 | {
44 | header: {
45 | description: strings.PropertyPaneDescription
46 | },
47 | groups: [
48 | {
49 | groupName: strings.BasicGroupName,
50 | groupFields: [
51 | PropertyPaneTextField('description', {
52 | label: strings.DescriptionFieldLabel
53 | })
54 | ]
55 | }
56 | ]
57 | }
58 | ]
59 | };
60 | }
61 | }
62 |
--------------------------------------------------------------------------------
/samples/install-spfx-solution/README.md:
--------------------------------------------------------------------------------
1 | # Install SharePoint Framework solution
2 |
3 | ## Summary
4 |
5 | The `installSolution` allows you to install a solution you have deployed to the tenant app catalog and enabled using the new ALM APIs.
6 |
7 | > More details on ALM APIs are available from [official SharePoint Development documentation](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins).
8 |
9 | - For this example you need to first upload the solution to the app catalog and enable it.
10 |
11 | 
12 |
13 | - You then need to reference this solution in your InstallSPFXSolution script action. To get the solution ID login to a site using Connect-PnPOnline cmdlet and then run Get-PnPApp. This will return a list of your deployed solutions. Find the one you wish to install via site script and grab that id.
14 |
15 | 
16 |
17 | - After you execute your script, you can confirm that the solution has been installed on the site by moving to site contents view and confirming it's existance.
18 |
19 | 
20 |
21 | - Any SharePoint Framework client-side web part or extension included in the just deployed solution would be now available in the site.
22 |
23 | 
24 |
25 |
26 | > Notice that this `installSPFXSolution` has been designed for solutions which require to be installed on the sites and are not tenant-deployed through tenant app catalog.
27 |
28 |
29 | ## Sample
30 |
31 | Solution|Author(s)
32 | --------|---------
33 | install-appcat-solution | SharePoint Team
34 |
35 | ## Version history
36 |
37 | Version|Date|Comments
38 | -------|----|--------
39 | 1.0|April 10, 2018|Initial release
40 | 1.1|July 16, 2018|Action name has been changed from installSPFXSolution to installSolution
41 |
42 | ## Disclaimer
43 | **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.**
44 |
45 | ---
46 |
47 |
48 |
49 |
22 |
33 |
23 |
32 |
24 | Welcome to SharePoint!
25 |
31 | Customize SharePoint experiences using Web Parts.
26 |${escape(this.properties.description)}
27 | 28 | Learn more 29 | 30 |
69 |
`;
73 | }
74 | }
75 | }
76 | }
77 |
78 | private _onDispose(): void {
79 | console.log('Disposed custom bottom placeholders.');
80 | }
81 | }
82 |
--------------------------------------------------------------------------------
/samples/site-apply-company-theme/README.md:
--------------------------------------------------------------------------------
1 | # Applying custom theme
2 |
3 | ## Summary
4 | You can use a site script to apply a company theme to a modern site. The following example uses the applyTheme action to set a pre-loaded company theme after site creation. This action requires simply referencing a company theme name, so one must be first installed to your tenant gallery. For more details on this check out https://aka.ms/spsitetheming - and if you need help creating a theme be sure to check out the theme generator at https://aka.ms/spthemebuilder.
5 |
6 | 
7 |
8 | ## Sample
9 |
10 | Solution|Author(s)
11 | --------|---------
12 | site-apply-company-theme | SharePoint Team
13 |
14 | ## Version history
15 |
16 | Version|Date|Comments
17 | -------|----|--------
18 | 1.0|December 14, 2017|Initial release
19 |
20 | ## Disclaimer
21 | **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.**
22 |
23 | ---
24 |
25 | ## Additional notes
26 |
27 | Here is a sample theme you can use to try this out:
28 |
29 | ```ps
30 | $ContosoThemeSample=
31 | @{
32 | "themePrimary" = "#3ad600";
33 | "themeLighterAlt" = "#f4fff0";
34 | "themeLighter" = "#e9ffe1";
35 | "themeLight" = "#d4ffc4";
36 | "themeTertiary" = "#a4ff83";
37 | "themeSecondary" = "#41f400";
38 | "themeDarkAlt" = "#33c100";
39 | "themeDark" = "#289600";
40 | "themeDarker" = "#1f7600";
41 | "neutralLighterAlt" = "#ececec";
42 | "neutralLighter" = "#e8e8e8";
43 | "neutralLight" = "#dedede";
44 | "neutralQuaternaryAlt" = "#cfcfcf";
45 | "neutralQuaternary" = "#c6c6c6";
46 | "neutralTertiaryAlt" = "#bebebe";
47 | "neutralTertiary" = "#d6d6d6";
48 | "neutralSecondary" = "#474747";
49 | "neutralPrimaryAlt" = "#2e2e2e";
50 | "neutralPrimary" = "#333333";
51 | "neutralDark" = "#242424";
52 | "black" = "#1c1c1c";
53 | "white" = "#f1f1f1";
54 | "primaryBackground" = "#f1f1f1";
55 | "primaryText" = "#333333";
56 | "bodyBackground" = "#f1f1f1";
57 | "bodyText" = "#333333";
58 | "disabledBackground" = "#e8e8e8";
59 | "disabledText" = "#bebebe";
60 | "accent" = "#0072d6"
61 | }
62 | ```
63 |
64 | You can apply using the following PowerShell command:
65 |
66 | ```ps
67 | Add-SPOTheme -Name "Company Theme Sample" -Palette $ContosoThemeSample -IsInverted $false
68 | ```
69 |
70 | And then reference in your site script JSON:
71 |
72 | ```json
73 | var applyCompanyTheme =
74 | {
75 | "$schema": "schema.json",
76 | "actions": [
77 | {
78 | "verb": "applyTheme",
79 | themeName: "Company Theme Sample"
80 | }
81 | ],
82 | "bindata": { },
83 | "version": 1
84 | };
85 | ```
86 |
87 | You can create a site script with this action using REST or PowerShell - and then reference the returned
70 | ${escape(bottomString)}
71 |
72 |