Skip to content

Commit 39c304b

Browse files
authored
Merge pull request #2431 from MicrosoftDocs/master
Pushing changes live
2 parents c9c1c78 + 257bbcf commit 39c304b

File tree

100 files changed

+1194
-227
lines changed

Some content is hidden

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

100 files changed

+1194
-227
lines changed

powerapps-docs/developer/component-framework/component-framework-for-canvas-apps.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,17 @@ ms.assetid: 5d100dc3-bd82-4b45-964c-d90eaebc0735
1515

1616
# Code components for canvas apps
1717

18-
> [!IMPORTANT]
19-
> This feature is still experimental and disabled by default. For more information, see [Experimental and preview features](../../maker/canvas-apps/working-with-experimental.md).
20-
2118
Power Apps component framework enables app makers to create code components to use in an app or across the apps. More information: [Power Apps component framework overview](overview.md)
2219

23-
In this experimental preview, Power Apps component framework enables app makers to create code components, debug, import, and add them to canvas apps using the Power Apps CLI tooling. Only specific APIs are supported in this experimental preview. We recommend that you check each API to determine whether it supports canvas apps.
20+
In this public preview, Power Apps component framework enables app makers to create code components, debug, import, and add them to canvas apps using the Power Apps CLI tooling. Only specific APIs are supported in this public preview. We recommend you to check each API to determine whether it supports canvas apps.
2421

2522
> [!WARNING]
2623
> Code components contain code that may not be generated by Microsoft and can potentially access security tokens and data. When adding code components to an app, make sure that the code component solutions are from a trusted source.
2724
2825
## Prerequisites
2926

30-
System Administrator privileges are required to enable the Power Apps component feature in the environment.
27+
1. A Power Apps license is required. More information: [Power Apps component framework licensing](overview.md#licensing)
28+
2. System Administrator privileges are required to enable the Power Apps component feature in the environment.
3129

3230
## Enable Power Apps component framework feature
3331

@@ -83,7 +81,7 @@ To add code components to a canvas app:
8381

8482
## Delete a code component
8583

86-
To delete a code component from a canvas app, select the code component that you want to delete and then select the **Delete** button on the menu. When the code component is deleted from the app, all the code component elements get deleted from the app and the app package.
84+
To delete a code component from a canvas app, select the code component that you want to delete and then select the **Delete** button on the menu. When the code component is deleted from the app, all the code component elements get deleted from the app and the app package.
8785

8886
## Update existing code components
8987

@@ -96,4 +94,3 @@ Whenever you update the code components and want to see the changes in runtime,
9694

9795
[Power Apps component framework overview](overview.md)<br/>
9896
[Create your first code component](implementing-controls-using-typescript.md)
99-

powerapps-docs/developer/component-framework/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Update the component version (minor or patch) in the component manifest file (fo
2121
Every update in the component needs a component version bump to be reflected on the Common Data Service server.
2222

2323
> [!NOTE]
24-
> - A new solutio must be created everytime if you wish to have a major version bump. Incrementing the major version number (eg 1.0 to 2.0) is not supported as an upgrade.
24+
> - A new solution must be created everytime if you wish to have a major version bump. Incrementing the major version number (eg 1.0 to 2.0) is not supported as an upgrade.
2525
> - Only three version sections are supported (i.e. MAJOR.MINOR.PATCH). These version number sections should be between 0 and 65536.
2626
2727
### What are the things to be considered from a performance perspective?

powerapps-docs/developer/component-framework/issues-and-workarounds.md

Lines changed: 56 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,41 +16,41 @@ ms.topic: "article"
1616

1717
Here are some common issues that you might come across while using the Power Apps component framework and Power Apps CLI.
1818

19-
**Msbuild error MSB4036**
19+
1. **Msbuild error MSB4036**
2020

21-
1. The name of the task in the project file is same as the name of the task class.
22-
2. The task class is public and implements the Microsoft.Build.Framework.ITask interface.
23-
3. The task is correctly declared with *\<UsingTask>* in the project file or in the *.tasks files located in the path directory.
21+
- The name of the task in the project file is same as the name of the task class.
22+
- The task class is public and implements the Microsoft.Build.Framework.ITask interface.
23+
- The task is correctly declared with *\<UsingTask>* in the project file or in the *.tasks files located in the path directory.
2424

25-
**Workaround**:
25+
**Workaround**:
2626

27-
1. Open Visual Studio Installer.
28-
1. For Visual Studio 2017, select **Modify**.
29-
1. Select **Individual Components**.
30-
1. Under Code Tools, check **NuGet targets & Build Tasks**.
27+
- Open Visual Studio Installer.
28+
- For Visual Studio 2017, select **Modify**.
29+
- Select **Individual Components**.
30+
- Under Code Tools, check **NuGet targets & Build Tasks**.
3131

3232
> [!NOTE]
3333
> We will be constantly adding common issues and workarounds as we come across during the development process. If you encounter an issue and have a workaround and you think that is helpful, raise the issue [here](https://powerusers.microsoft.com/t5/Power-Apps-Component-Framework/bd-p/pa_component_framework) or raise a pull request so that we can review and add it to the list.
3434
35-
**Publisher Prefix**
35+
2. **Publisher Prefix**
3636

37-
If a component is created using the CLI version lower than 0.4.3, you will encounter an error while trying to reimport the solution file into Common Data Service.
37+
If a component is created using the CLI version lower than 0.4.3, you will encounter an error while trying to reimport the solution file into Common Data Service.
3838

39-
**Workaround**:
39+
**Workaround**:
4040

41-
- Delete the solution containing the relevant component from Common Data Service.
42-
- The component needs to be removed from the filed or grid if the component is already configured to avoid dependencies.
43-
- Import the new solution with updates to the component built by the latest CLI version.
44-
- Newly imported components can now be configured on forms or grids.
41+
- Delete the solution containing the relevant component from Common Data Service.
42+
- The component needs to be removed from the filed or grid if the component is already configured to avoid dependencies.
43+
- Import the new solution with updates to the component built by the latest CLI version.
44+
- Newly imported components can now be configured on forms or grids.
4545

46-
**Issues while updating existing code components**
46+
3. **Issues while updating existing code components**
4747

48-
1. If you get a 1ES notification asking how pcf-scripts are being used, note that these scripts are only used to build the code components but they are not bundled or used by the resulting component.
49-
2. If you have created a code component using the CLI version 0.1.817.1 or earlier and want to ensure that the latest build and debug modules are being used, make the updates to the `package.json` file as shown below:
48+
- If you get a 1ES notification asking how pcf-scripts are being used, note that these scripts are only used to build the code components but they are not bundled or used by the resulting component.
49+
- If you have created a code component using the CLI version 0.1.817.1 or earlier and want to ensure that the latest build and debug modules are being used, make the updates to the `package.json` file as shown below:
5050

51-
```JSON
52-
"dependencies": { "@types/node": "^10.12.18", "@types/powerapps-component-framework": "1.1.0"}, "devDependencies": { "pcf-scripts": "~0", "pcf-start": "~0" }
53-
```
51+
```JSON
52+
"dependencies": { "@types/node": "^10.12.18", "@types/powerapps-component-framework": "1.1.0"}, "devDependencies": { "pcf-scripts": "~0", "pcf-start": "~0" }
53+
```
5454

5555
3. Error **Failed to retrieve information about Microsoft.PowerApps.MSBuild.Pcf from remote source <Feed Url>** when the build fails for authorization issues.
5656

@@ -74,11 +74,40 @@ If a component is created using the CLI version lower than 0.4.3, you will encou
7474
</configuration>
7575
```
7676

77-
**Web resource size is too big**
77+
4. **Web resource size is too big**
7878

79-
Error **Import Solution Failed: Web resource content size is too big**.
79+
Error **Import Solution Failed: Web resource content size is too big**.
8080

81-
**Workaround**
81+
**Workaround**
82+
83+
- When you're creating the `bundle.js` file from the CLI tooling, it bundles lot of components which makes the file large. Remove some of the components that are not necessary.
84+
- Build the component in `production` mode by modifying the `node_modules/pcf-scripts/webpackconfig.js` file.
85+
86+
5. **Power Apps component framework Datasets getValue by property alias doesn't work**
87+
88+
Power Apps component framework dataset APIs getValue function only searches record by the dataset column name and not the property alias set in the manifest. Attempting to get value by property alias will return an empty value.
89+
90+
**Workaround**
91+
92+
Use the dataset column name (component can get the dataset column name by searching the column array using the alias).
93+
94+
***Expected Behavior***
95+
96+
```TypeScript
97+
long = dataSet.records[currentRecordId].getValue("Longitude") //based on property set in manifest"-122.3514661"
98+
```
99+
100+
***Current Workaround***
101+
102+
```TypeScript
103+
lat = dataSet.records[currentRecordId].getValue("Address_x0020_1_x003a__x0020_Latitude")//based on the dataset column name
104+
```
105+
106+
6. **Power Apps component framework Datasets SharePoint issue**
107+
108+
Power Apps component framework dataset component currently does not properly show the records from SharePoint. While the network request will succeed with the correct data records returned, the deserialization fails and an empty dataset is returned.
109+
110+
**Workaround**
111+
112+
No workaround as of now. We are working on pushing a fix to our deployment trains.
82113

83-
1. When you're creating the `bundle.js` file from the CLI tooling, it bundles lot of components which makes the file large. Remove some of the components that are not necessary.
84-
2. Build the component in `production` mode by modifying the `node_modules/pcf-scripts/webpackconfig.js` file.

powerapps-docs/developer/component-framework/limitations.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,8 @@ ms.author: "nabuthuk"
1414

1515
With the release of Power Apps component framework, you can now create your own code components to improve the user experience in model-driven apps and canvas apps. Even though you can create your own components, there are some limitations that restrict developers implementing some features in the code components. Below are some of the limitations:
1616

17-
1. Only the *field* type of components are supported in the experimental preview for canvas apps and not the *dataset* type components.
18-
2. Common Data Service dependent APIs, including WebAPI along with few other APIs, are not available for this experimental preview. For individual API availability for this experimental preview release, see [Power Apps component framework API reference](reference/index.md).
19-
3. Code components should bundle all the code including external library content into the primary code bundle. To see an example of how the Power Apps command line interface can help with bundling your external library content into a component-specific bundle, see [Angular flip component](sample-controls/angular-flip-control.md) example.
17+
1. Common Data Service dependent APIs, including WebAPI along with few other APIs, are not available for this experimental preview. For individual API availability for this experimental preview release, see [Power Apps component framework API reference](reference/index.md).
18+
2. Code components should bundle all the code including external library content into the primary code bundle. To see an example of how the Power Apps command line interface can help with bundling your external library content into a component-specific bundle, see [Angular flip component](sample-controls/angular-flip-control.md) example.
2019

2120
> [!NOTE]
2221
> Support for shared libraries across components using library nodes in the component manifest is not yet supported. We are reviewing this and will be adding this capability in future release.

powerapps-docs/developer/component-framework/manifest-schema-reference/code.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ ms.assetid: 44d9fcfb-0cd8-48cc-aace-dd589099dd79
2323

2424
## Available for
2525

26-
Model-driven apps and canvas apps (experimental preview)
26+
Model-driven apps and canvas apps (public preview)
2727

2828
## Attributes
2929

3030
|Name|Description|Type|Required|Available for|
3131
|--|--|--|--|-----|
32-
|`path`|Place where the resource files are located|`String`|Yes|Model-driven apps and canvas apps (experimental preview) |
33-
|`order`|The order in which the resource files should load|`Positive integer`|Yes|Model-driven apps and canvas apps (experimental preview) |
32+
|`path`|Place where the resource files are located|`String`|Yes|Model-driven apps and canvas apps (public preview) |
33+
|`order`|The order in which the resource files should load|`Positive integer`|Yes|Model-driven apps and canvas apps (public preview) |
3434

3535
## Parent Elements
3636

powerapps-docs/developer/component-framework/manifest-schema-reference/control.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,20 @@ ms.assetid: 4dacd337-c9df-458e-86f3-bfb3ab543ea7
2222

2323
## Available for
2424

25-
Model-driven apps and canvas apps (experimental preview)
25+
Model-driven apps and canvas apps (public preview)
2626

2727
## Attributes
2828

2929
|Name|Description|Type|Required|Available for|
3030
|--|--|--|--|--------|
31-
|`namespace`|Defines the object prototype of the component|[!INCLUDE [alphanumerictype-description](includes/alphanumerictype-description.md)]|Yes|Model-driven apps and canvas apps (experimental preview) |
32-
|`constructor`|A method for initializing the object|[!INCLUDE [alphanumerictype-description](includes/alphanumerictype-description.md)]|Yes|Model-driven apps and canvas apps (experimental preview) |
33-
|`control-type`|Standard|[!INCLUDE [controltype-description](includes/controltype-description.md)]|No|Model-driven apps and canvas apps (experimental preview) |
34-
|`description-key`|Defines the description of the component that will be seen on the UI.|`string`|No|Model-driven apps and canvas apps (experimental preview) |
35-
|`display-name-key`|Defines the name of the control that is displayed on the UI.|`string`|Yes|Model-driven apps and canvas apps (experimental preview) |
31+
|`namespace`|Defines the object prototype of the component|[!INCLUDE [alphanumerictype-description](includes/alphanumerictype-description.md)]|Yes|Model-driven apps and canvas apps (public preview) |
32+
|`constructor`|A method for initializing the object|[!INCLUDE [alphanumerictype-description](includes/alphanumerictype-description.md)]|Yes|Model-driven apps and canvas apps (public preview) |
33+
|`control-type`|Standard|[!INCLUDE [controltype-description](includes/controltype-description.md)]|No|Model-driven apps and canvas apps (public preview) |
34+
|`description-key`|Defines the description of the component that will be seen on the UI.|`string`|No|Model-driven apps and canvas apps (public preview) |
35+
|`display-name-key`|Defines the name of the control that is displayed on the UI.|`string`|Yes|Model-driven apps and canvas apps (public preview) |
3636
|`preview-image`|Image that will be used on the customization screens to show a preview of the component.|`string`|No|Model-driven apps|
37-
|`version`|Defines the version of the component defined in [Semantic Versioning](https://semver.org)|`string`|Yes|Model-driven apps and canvas apps (experimental preview) |
37+
|`version`|Defines the version of the component defined in [Semantic Versioning](https://semver.org)|`string`|Yes|Model-driven apps and canvas apps (public preview) (public preview)|
38+
|`version`|Defines the version of the component defined in [Semantic Versioning](https://semver.org)|`string`|Yes|Model-driven apps and canvas apps (public preview) |
3839
<!--|`hidden`|Defines whether the component should be hidden or not|[!INCLUDE [booleantype-description](includes/booleantype-description.md)]| No|Model-driven apps|-->
3940

4041
## Parent Elements

powerapps-docs/developer/component-framework/manifest-schema-reference/css.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,16 @@ ms.assetid: b6119424-c0a4-4412-b25c-8239da6cbe36
2222

2323
## Available for
2424

25-
Model-driven apps and canvas apps (experimental preview)
25+
Model-driven apps and canvas apps (public preview)
2626

2727
## Attributes
2828

2929
|Name|Description|Type|Required|Available for|
3030
|--|--|--|--|-----|
31-
|`path`|Relative path w.r.t manifest where CSS files are located|`string`|Yes|Model-driven apps and canvas apps (experimental preview) |
32-
|`order`|The order in which the CSS files Should load|`Positive integer`|Optional|Model-driven apps and canvas apps (experimental preview) |
31+
|`path`|Relative path w.r.t manifest where CSS files are located|`string`|Yes|Model-driven apps and canvas apps (public preview) (public preview)|
32+
|`order`|The order in which the CSS files Should load|`Positive integer`|Optional|Model-driven apps and canvas apps (public preview) (public preview)|
33+
|`path`|Relative path w.r.t manifest where CSS files are located|`string`|Yes|Model-driven apps and canvas apps (public preview) |
34+
|`order`|The order in which the CSS files Should load|`Positive integer`|Optional|Model-driven apps and canvas apps (public preview) |
3335

3436
## Parent Elements
3537

@@ -40,7 +42,10 @@ Model-driven apps and canvas apps (experimental preview)
4042
## Example
4143

4244
```xml
43-
<css path="css/JS_HelloWorldControl.css" order="1" />
45+
<resources>
46+
<code path="TS_LocalizationAPI.js" order="1" />
47+
<css path="css/TS_LocalizationAPI.css" order="1" />
48+
</resources>
4449
```
4550

4651
### Related topics

powerapps-docs/developer/component-framework/manifest-schema-reference/data-set.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ ms.assetid: 9ffe8930-b290-4252-98d4-a1195b00205f
2424

2525
|Name|Description|Type|Required|Available for|
2626
|--|--|--|--|-------|
27-
|`description-key`|Defines the description of the property.|`string`|Optional|Model-driven apps and canvas apps (experimental preview)|
28-
|`display-name-key`|Defines the name of the property.|`string`|Yes|Model-driven apps and canvas apps (experimental preview)|
29-
|`name`|Name of the grid|`string`|Yes|Model-driven apps and canvas apps (experimental preview)|
30-
|`cds-data-set-options`|Displays the Commandbar, ViewSelector, QuickFindSearch if set to true |`boolean`|Yes|Model-driven apps and canvas apps (experimental preview)|
27+
|`description-key`|Defines the description of the property.|`string`|Optional|Model-driven apps and canvas apps (public preview)|
28+
|`display-name-key`|Defines the name of the property.|`string`|Yes|Model-driven apps and canvas apps (public preview)|
29+
|`name`|Name of the grid|`string`|Yes|Model-driven apps and canvas apps (public preview)|
30+
|`cds-data-set-options`|Displays the Commandbar, ViewSelector, QuickFindSearch if set to true |`boolean`|Yes|Model-driven apps and canvas apps (public preview)|
3131

3232
## Parent Elements
3333

powerapps-docs/developer/component-framework/manifest-schema-reference/html.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,15 @@ Model-driven apps
3737
|--|--|
3838
|[resources](resources.md)|[!INCLUDE [resources-description](includes/resources-description.md)]|
3939

40+
## Example
41+
42+
```XML
43+
<resources>
44+
<code path="TS_LocalizationAPI.js" order="1" />
45+
<html path="html/default.html" order="1" />
46+
</resources>
47+
```
48+
4049
### Related topics
4150

4251
[Power Apps component framework manifest schema reference](index.md)<br/>

powerapps-docs/developer/component-framework/manifest-schema-reference/img.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,10 @@ Model-driven apps
4040
### Example
4141

4242
```XML
43-
<img path="img/default.png" />
43+
<resources>
44+
<code path="index.ts" order="1" />
45+
<img path="img/default.png" />
46+
</resources>
4447
```
4548

4649
### Related topics

0 commit comments

Comments
 (0)