Skip to content

Commit fe7ce77

Browse files
authored
Merge pull request #1956 from MicrosoftDocs/master
publish to live
2 parents c134c44 + 7ba120a commit fe7ce77

File tree

215 files changed

+1300
-489
lines changed

Some content is hidden

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

215 files changed

+1300
-489
lines changed

powerapps-docs/developer/component-framework/add-custom-controls-to-a-field-or-entity.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Add Custom Components to a field or entity | Microsoft Docs
3-
description: Process to import custom components
2+
title: Add code components to a field or entity | Microsoft Docs
3+
description: Process to import code components
44
keywords:
55
ms.author: nabuthuk
66
author: Nkrb
@@ -12,9 +12,13 @@ ms.tgt_pltfrm: ""
1212
ms.topic: "article"
1313
---
1414

15-
# Add custom components to a field or entity
15+
# Add code components to a field or entity in model-driven apps
1616

17-
Custom components let you transform fields that traditionally contain text into visualizations. Similarly, you can use custom components to transform datasets, such as a view, to display in a more visual rendering rather than a list of records. Custom components can appear as visualizations on forms, dashboards, views, and homepage grids.
17+
code components let you transform fields that traditionally contain text into visualizations. Similarly, you can use code components to transform datasets, such as a view, to display in a more visual rendering rather than a list of records. code components can appear as visualizations on forms, dashboards, views, and homepage grids.
18+
19+
20+
> [!div class="mx-imgBorder"]
21+
> ![Custom slider control](../../maker/model-driven-apps/media/slider-control.PNG "Slider control for a field")
1822
1923
## Add a custom component to a field
2024

@@ -30,15 +34,25 @@ Following the steps in this procedure will change the default label and text box
3034

3135
5. On the Add Control page, select the component that you want, such as the **Linear Slider** component, and then select **Add**.
3236

37+
> [!div class="mx-imgBorder"]
38+
> ![Add linear slider control](../../maker/model-driven-apps/media/add-slider.PNG "Add linear slider control")
39+
3340
6. Choose the client where you want the component to appear.
3441

3542
- **Web**. To make the custom component available from any web browser, select the Web option next to the component. Notice that setting the Web option includes rendering the component in web browsers on PCs, Macs, and mobile devices.
3643

3744
- **Phone**. To make the custom component available on phones running Dynamics 365 for phones, select the Phone option next to the component.
3845

3946
- **Tablet**. To make the custom component available on tablet devices running Dynamics 365 for tablets, select the Tablet option next to the component.
47+
48+
> [!div class="mx-imgBorder"]
49+
> ![Choose the client apps to view the custom control](../../maker/model-driven-apps/media/choose-client.png "Choose the client apps to view the custom control")
50+
4051
7. Select the pencil icon next to **Min**, **Max**, and **Step**, set the property option, and then select **OK**.
41-
52+
53+
> [!div class="mx-imgBorder"]
54+
> ![Add custom control properties](../../maker/model-driven-apps/media/ccf-add-properties.png "Add custom control properties")
55+
4256
- **Min**. Set the minimum accepted value. You can bind a static value that you enter or bind the value to an existing field. In this example **Bind to static value** is **Currency** and the minimum value that can be entered is *zero*.
4357

4458
- **Bind to a static value**. Select the data type, such as a whole number (Whole.None), currency, floating point (FP), or decimal. Next, enter a number that represents the minimum accepted value for the field.
@@ -72,6 +86,9 @@ To add a custom component like data-set component or simple table component to a
7286

7387
Open a record that includes the field with the custom component, such as the Opportunity form from the previous example, and view how the field is changed. The field is now rendered as a slider component instead of the text field.
7488

89+
> [!div class="mx-imgBorder"]
90+
> ![Slider control rendered on form](../../maker/model-driven-apps/media/slider-control.PNG "Slider control rendered on form")
91+
7592
### See also
7693

7794
[Implementing components in TypeScript](implementing-controls-using-typescript.md)<br/>
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: PowerApps component framework capabilities and limitations for canvas apps | Microsoft Docs
3+
description: Capabilities and limitations for canvas apps
4+
keywords:
5+
ms.author: nabuthuk
6+
author: Nkrb
7+
manager: kvivek
8+
ms.date: 08/31/2019
9+
ms.service: "powerapps"
10+
ms.suite: ""
11+
ms.tgt_pltfrm: ""
12+
ms.topic: "article"
13+
ms.assetid: 5d100dc3-bd82-4b45-964c-d90eaebc0735
14+
---
15+
16+
# PowerApps component framework capabilities and limitations for canvas apps
17+
18+
The following table describes the capabilities and limitations for building custom components using PowerApps component framework for canvas apps.
19+
20+
## PowerApps component framework APIs
21+
22+
23+
|API Name| Available for| Comments|
24+
|-------|------|---------|
25+
|Client|Model-driven apps||
26+
|Control|Both Model-driven apps and canvas apps (experimental preview)||
27+
|DataSet|Model-driven apps||
28+
29+
30+
## Manifest schema reference
31+
32+
|Property name|Available for|Comments|
33+
|------|-------|-------|
34+
|Code| Both model-driven and canvas apps||
35+
|control|Both model-driven and canvas apps||
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
title: PowerApps component framework for canvas apps | Microsoft Docs
3+
description: Create code components for canvas apps
4+
keywords:
5+
ms.author: nabuthuk
6+
author: Nkrb
7+
manager: kvivek
8+
ms.date: 08/31/2019
9+
ms.service: "powerapps"
10+
ms.suite: ""
11+
ms.tgt_pltfrm: ""
12+
ms.topic: "article"
13+
ms.assetid: 5d100dc3-bd82-4b45-964c-d90eaebc0735
14+
---
15+
16+
# PowerApps component framework for canvas apps
17+
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+
21+
PowerApps component framework enables app makers to create code components to use in an app or across the apps. more information: [PowerApps component framework overview](overview.md)
22+
23+
In this experimental preview, PowerApps component framework enables app makers to create code components, debug, import and add them to canvas apps using the PowerApps CLI tooling. Only certain APIs are supported in this experimental preview. It is recommened to check each individual API whether it supports canvas apps or not.
24+
25+
> [!WARNING]
26+
> 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 custom component solutions are from trusted source.
27+
28+
## Prerequisites
29+
30+
1. System Administrator privileges is required to enable PowerApps component feature in the environment.
31+
32+
> [!IMPORTANT]
33+
> By default PowerApps component framework is enabled for model-driven apps.
34+
35+
## Enable PowerApps component framework feature
36+
37+
To add code components to an app, you need to be enable the PowerApps component framework feature in each environment where they are to be used. To enable an environment to use code components inside its apps:
38+
39+
1. Sign in to [PowerApps](https://powerapps.microsoft.com/en-us/).
40+
41+
2. Click on the **Settings** icon and then select **Admin Center**.
42+
43+
![Settings admin center](media/select-admin-center-from-settings.png "Settings admin center")
44+
45+
3. Select the environment where you want to enable this feature and click on **...** and then select **Settings**.
46+
47+
4. Under the **Products** tab, select **Features**.
48+
49+
![Enable PCF](media/enable-pcf-feature.png "Enable PCF")
50+
51+
5. From the list of available features, turn on the switch under the **PowerApps component framework for canvas apps**.
52+
53+
6. Now, open the app where you want to add the code component and navigate to **File** > **App settings** and select **Advanced settings**.
54+
55+
![Enable components for pcf](media/enable-components-for-pcf.png "Enable components for pcf")
56+
57+
7. Turn on the **Components** switch under the **Experimental feature** section.
58+
59+
60+
61+
## Implementing code components
62+
63+
After you enable the PowerApps component framework feature in your environment, you can start implementing the logic for code components. The [implement sample component](implementing-controls-using-typescript.md) topic demonstrates the step by step process to create code components right from implementing the custom logic, manifest file, debug process, and creating a solution zip file.
64+
65+
> [!NOTE]
66+
> Implementing code components is same for both model-driven apps and canvas apps (experimental preview). The only difference is adding the code components.
67+
68+
## Add components to a canvas app
69+
70+
To add code components to a canvas app:
71+
72+
> [!NOTE]
73+
> To add code components to a field or an entity for model-driven apps, see [Add code components to model-driven apps](add-custom-controls-to-a-field-or-entity.md)
74+
75+
1. Navigate to PowerApps Studio.
76+
2. Create a new canvas app or edit an existing app that you want to add the custom component to.
77+
78+
> [!IMPORTANT]
79+
> Make sure the code components solution zip file is already [imported](https://docs.microsoft.com/en-us/powerapps/maker/common-data-service/import-update-export-solutions) into Common Data Service before you go onto the next step.
80+
81+
3. Click on **Insert** > **Components** > **Import component**.
82+
83+
![Insert components](media/insert-components-import.png "Insert components")
84+
85+
4. Select **Code (experimental)** tab and add a component from the list and click on **Import**. This adds the sample component in the **Components** menu.
86+
87+
![Import sample component](media/import-component-add-sample-component.png "Insert sample component")
88+
89+
5. Navigate to **Components** and select the component to add it to the app.
90+
91+
![Add sample component](media/add-sample-component-from-list.png "Add sample component")
92+
93+
## Known limitations
94+
95+
1. Only the field type of components are supported in the experimental preview and not the data set type components.
96+
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 [PowerApps component framework API reference](reference/index.md)
97+
98+
## See also
99+
100+
[PowerApps component framework overview](overview.md)<br/>
101+
[Implement sample component](implementing-controls-using-typescript.md)
102+

powerapps-docs/developer/component-framework/control-implementation-library.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Component implementation library | Microsoft Docs
3-
description: Create custom components using JavaScript or TypeScript
3+
description: Create code components using JavaScript or TypeScript
44
keywords:
55
ms.author: nabuthuk
66
author: Nkrb
@@ -13,7 +13,7 @@ ms.topic: "article"
1313
ms.assetid: 5d100dc3-bd82-4b45-964c-d90eaebc0735
1414
---
1515

16-
Implementing the component library is one of the key step when you are developing custom components using PowerApps component framework. Developers can implement component library using TypeScript. Each custom component must have a library that includes the definition of a function which returns an object that implements the methods described in the custom component interface.
16+
Implementing the component library is one of the key step when you are developing code components using PowerApps component framework. Developers can implement component library using TypeScript. Each custom component must have a library that includes the definition of a function which returns an object that implements the methods described in the custom component interface.
1717

1818
The object implements the following methods:
1919

powerapps-docs/developer/component-framework/create-custom-controls-using-pcf.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Create and build a custom component| Microsoft Docs
33
description: Start creating a component using the PowerApps component framework Tooling
4-
keywords: PowerApps component framework, Custom components, Component Framework
4+
keywords: PowerApps component framework, code components, Component Framework
55
ms.author: nabuthuk
66
author: Nkrb
77
manager: kvivek
@@ -17,7 +17,7 @@ ms.assetid: d2cbf58a-9112-45c2-b823-2c07a310714c
1717

1818
[!INCLUDE[cc-beta-prerelease-disclaimer](../../includes/cc-beta-prerelease-disclaimer.md)]
1919

20-
This topic demonstrates how to create and deploy custom components using PowerApps component framework. Ensure that you have installed Microsoft PowerApps CLI
20+
This topic demonstrates how to create and deploy code components using PowerApps component framework. Ensure that you have installed Microsoft PowerApps CLI
2121

2222
## Create a new component
2323

@@ -76,9 +76,9 @@ To build the component project, open the project folder in Visual Studio Code an
7676

7777
### See also
7878

79-
[Debug custom components](debugging-custom-controls.md)<br/>
79+
[Debug code components](debugging-custom-controls.md)<br/>
8080
[Package a custom component](import-custom-controls.md)<br/>
81-
[Add custom components to a field or entity](add-custom-controls-to-a-field-or-entity.md)<br/>
82-
[Updating existing custom components](updating-existing-controls.md)<br/>
81+
[Add code components to a field or entity](add-custom-controls-to-a-field-or-entity.md)<br/>
82+
[Updating existing code components](updating-existing-controls.md)<br/>
8383
[PowerApps component framework API Reference](reference/index.md)<br/>
8484
[PowerApps component framework Overview](overview.md)

0 commit comments

Comments
 (0)