Skip to content

Commit 1618a75

Browse files
authored
Merge pull request MicrosoftDocs#1962 from MicrosoftDocs/Nava_pcf
Changing custom to code components
2 parents 1730831 + 4f17bb7 commit 1618a75

18 files changed

+72
-72
lines changed

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ ms.topic: "article"
1414

1515
# Add code components to a field or entity in model-driven apps
1616

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.
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.
1818

1919

2020
> [!div class="mx-imgBorder"]
2121
> ![Custom slider control](../../maker/model-driven-apps/media/slider-control.PNG "Slider control for a field")
2222
23-
## Add a custom component to a field
23+
## Add a code component to a field
2424

25-
Following the steps in this procedure will change the default label and text box field of the **Budget Amount** field to the slider custom component on the Opportunity entity. You can use similar steps to replace an existing field with a custom component or configure a custom component for a custom field.
25+
Following the steps in this procedure will change the default label and text box field of the **Budget Amount** field to the slider code component on the Opportunity entity. You can use similar steps to replace an existing field with a code component or configure a code component for a custom field.
2626

2727
1. Open solution explorer.
2828

2929
2. Expand **Entities**, expand the entity that you want, such as the **Opportunity** entity, select **Forms**, and then open a form such as the **Main** form.
3030

31-
3. In the form editor, double-click the field where you want to add a custom component, such as the **Budget Amount** field on the opportunity main form. Alternatively, you can create a custom field.
31+
3. In the form editor, double-click the field where you want to add a code component, such as the **Budget Amount** field on the opportunity main form. Alternatively, you can create a custom field.
3232

3333
4. On the **Field Properties** page, select the **Controls** tab, and then select **Add Control**.
3434

@@ -39,11 +39,11 @@ Following the steps in this procedure will change the default label and text box
3939
4040
6. Choose the client where you want the component to appear.
4141

42-
- **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.
42+
- **Web**. To make the code 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.
4343

44-
- **Phone**. To make the custom component available on phones running Dynamics 365 for phones, select the Phone option next to the component.
44+
- **Phone**. To make the code component available on phones running Dynamics 365 for phones, select the Phone option next to the component.
4545

46-
- **Tablet**. To make the custom component available on tablet devices running Dynamics 365 for tablets, select the Tablet option next to the component.
46+
- **Tablet**. To make the code component available on tablet devices running Dynamics 365 for tablets, select the Tablet option next to the component.
4747

4848
> [!div class="mx-imgBorder"]
4949
> ![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")
@@ -63,28 +63,28 @@ Following the steps in this procedure will change the default label and text box
6363

6464
- **Step**. This represents the unit to increment or decrement when adding to or subtracting from the current value. For example, for budget amount you can select 100 dollar increments\decrements.
6565

66-
- **Hide Default Control**. Selecting this option hides the component so neither the component or the data is displayed in any of the clients that don't support the custom component.
66+
- **Hide Default Control**. Selecting this option hides the component so neither the component or the data is displayed in any of the clients that don't support the code component.
6767

6868
8. Select **OK**, to close the Field Properties page.
6969

7070
9. To activate the customization, on the entity form select **Save**, and then select **Publish**.
7171

7272
10. Select **Save and Close** to close the form editor.
7373

74-
## Add custom component to an entity
74+
## Add code component to an entity
7575

76-
To add a custom component like data-set component or simple table component to a grid or view, follow the steps below:
76+
To add a code component like data-set component or simple table component to a grid or view, follow the steps below:
7777

7878
- Navigate to **Settings > Customizations** and click on **Customize the System**.
79-
- Click on the arrow next to **Entities** tab a select the entity you want to add the custom component.
79+
- Click on the arrow next to **Entities** tab a select the entity you want to add the code component.
8080
- Click on the **Controls** tab and click on **Add a control**.
8181
- On the Add Control page, select the component that you want, such as Simple Table component and then select **Add**.
8282
- Choose the client where you want the component to appear.
8383

8484

85-
## See the custom component in action
85+
## See the code component in action
8686

87-
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.
87+
Open a record that includes the field with the code 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.
8888

8989
> [!div class="mx-imgBorder"]
9090
> ![Slider control rendered on form](../../maker/model-driven-apps/media/slider-control.PNG "Slider control rendered on form")

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ PowerApps component framework enables app makers to create code components to us
2323
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.
2424

2525
> [!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.
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 code component solutions are from trusted source.
2727
2828
## Prerequisites
2929

@@ -73,7 +73,7 @@ To add code components to a canvas app:
7373
> 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)
7474
7575
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.
76+
2. Create a new canvas app or edit an existing app that you want to add the code component to.
7777

7878
> [!IMPORTANT]
7979
> 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.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -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 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.
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 code component must have a library that includes the definition of a function which returns an object that implements the methods described in the code component interface.
1717

1818
The object implements the following methods:
1919

@@ -22,5 +22,5 @@ The object implements the following methods:
2222
- [getOutputs](reference/control/getoutputs.md) (Optional)
2323
- [destroy](reference/control/destroy.md) (Required)
2424

25-
These methods controls the lifecycle of the custom component.
25+
These methods controls the lifecycle of the code component.
2626

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,5 +1,5 @@
11
---
2-
title: Create and build a custom component| Microsoft Docs
2+
title: Create and build a code component| Microsoft Docs
33
description: Start creating a component using the PowerApps component framework Tooling
44
keywords: PowerApps component framework, code components, Component Framework
55
ms.author: nabuthuk
@@ -13,7 +13,7 @@ ms.topic: "article"
1313
ms.assetid: d2cbf58a-9112-45c2-b823-2c07a310714c
1414
---
1515

16-
# Create and build a custom component
16+
# Create and build a code component
1717

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

@@ -33,14 +33,14 @@ To get started, open a new Developer Command Prompt for VS 2017 after installing
3333
> Currently, PowerApps CLI supports two types of components: **field** and **dataset**. For canvas apps, only field type is supported for experimental preview.
3434
3535
4. To retrieve all the required project dependencies, run the command `npm install`.
36-
5. Open your project folder (`C:\Users\<your name>\Documents\My_PCF_Component\<component name>`) in any developer environment of your choice and get started with your custom component development.
36+
5. Open your project folder (`C:\Users\<your name>\Documents\My_PCF_Component\<component name>`) in any developer environment of your choice and get started with your code component development.
3737

3838
## Build your component
3939

4040
To build the component project, open the project folder in Visual Studio Code and use the (Ctrl-Shift-B) command, then select the build options. Alternatively, you can also build the component quickly using the `npm run build` command in the Developer Command Prompt for VS 2017 window.
4141

4242
> [!TIP]
43-
> To debug the component during or after the build operation, see [Debug a custom component](debugging-custom-controls.md).
43+
> To debug the component during or after the build operation, see [Debug a code component](debugging-custom-controls.md).
4444
4545
## Known Configuration issues and Workarounds
4646

@@ -77,7 +77,7 @@ To build the component project, open the project folder in Visual Studio Code an
7777
### See also
7878

7979
[Debug code components](debugging-custom-controls.md)<br/>
80-
[Package a custom component](import-custom-controls.md)<br/>
80+
[Package a code component](import-custom-controls.md)<br/>
8181
[Add code components to a field or entity](add-custom-controls-to-a-field-or-entity.md)<br/>
8282
[Updating existing code components](updating-existing-controls.md)<br/>
8383
[PowerApps component framework API Reference](reference/index.md)<br/>

powerapps-docs/developer/component-framework/custom-controls-overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ controlObj.init(context,notifyOutputChanged,state,container);
6363
|Parameter|Description|
6464
|---|---|
6565
|context| Contains all the information about how the component is configured and all the parameters that can be used within the component along with the [framework APIs](reference/index.md). For example, the `context.parameters.["property name from manifest"]` can be used to access the input property.|
66-
|notifyOutputChanged |Alerts the framework whenever the custom component has new outputs ready to be retrieved asynchronously.|
66+
|notifyOutputChanged |Alerts the framework whenever the code component has new outputs ready to be retrieved asynchronously.|
6767
|state|Contains component data from the previous page load in the current session if component explicitly stored it earlier using `setControlState API`.|
6868
|container|An HTML div element to which you can append the HTML elements for the UI that defines your component. To display the value in the UI, you must get the data from `context.parameters.controlValue object`.|
6969

@@ -77,13 +77,13 @@ If the platform changes the data, it calls out the [updateView](reference/contro
7777

7878
### Page close
7979

80-
Whenever a user goes away from the page, custom component loses the scope and all the memory allocated in that page for the objects in the component will be cleared. However, some methods based on the browser implementation mechanism might stay and consume memory. Typically, these are event handlers. If the user wants to store the information, they should implement the `setControlState` method so that the information is given next time within the same session.
80+
Whenever a user goes away from the page, code component loses the scope and all the memory allocated in that page for the objects in the component will be cleared. However, some methods based on the browser implementation mechanism might stay and consume memory. Typically, these are event handlers. If the user wants to store the information, they should implement the `setControlState` method so that the information is given next time within the same session.
8181

8282
Developers should implement the [destroy](reference/control/destroy.md) method which is called when the page closes, and use it to remove any cleanup code such as removing any event handlers.
8383

8484
## Resources
8585

86-
Each custom component should have a resource file to construct its visualization. You can define a resource file in the manifest. The resource node in the manifest file refers to the resources that the component requires to implement its visualization. More information: [Resources](manifest-schema-reference/resources.md)
86+
Each code component should have a resource file to construct its visualization. You can define a resource file in the manifest. The resource node in the manifest file refers to the resources that the component requires to implement its visualization. More information: [Resources](manifest-schema-reference/resources.md)
8787

8888
### Related topics
8989

powerapps-docs/developer/component-framework/debugging-custom-controls.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Debug code components | MicrosoftDocs"
3-
description: "How to debug a custom component using Fiddler and Native debugging"
3+
description: "How to debug a code component using Fiddler and Native debugging"
44
manager: kvivek
55
ms.date: 04/23/2019
66
ms.service: "powerapps"
@@ -11,14 +11,14 @@ author: Nkrb
1111
---
1212
# Debug code components
1313

14-
Once you're done implementing the custom component logic, get started with testing and debugging the custom component using the `npm start` command. This builds the custom component and opens it in the local test harness.
14+
Once you're done implementing the code component logic, get started with testing and debugging the code component using the `npm start` command. This builds the code component and opens it in the local test harness.
1515

1616
> [!div class="mx-imgBorder"]
1717
> ![test harness 1](media/test-harness-1.png "test harness 1")
1818
19-
As shown in the image above, the browser window opens with 4 sections. The custom component is rendered in the left pane while the right pane has **Context Inputs**, **Data Inputs** and **Outputs** sections.
19+
As shown in the image above, the browser window opens with 4 sections. The code component is rendered in the left pane while the right pane has **Context Inputs**, **Data Inputs** and **Outputs** sections.
2020

21-
- **Context Inputs** provides a way to specify the form factor and test the custom component with each form factor (web, tablet, phone). This is especially helpful when the custom component is dependent on a particular form factor capability. In the coming release, you can have the ability to specify the height and width.
21+
- **Context Inputs** provides a way to specify the form factor and test the code component with each form factor (web, tablet, phone). This is especially helpful when the code component is dependent on a particular form factor capability. In the coming release, you can have the ability to specify the height and width.
2222
- **Data Inputs** is an interactive UI that displays all the properties and their types or type-groups defined in the manifest file. It allows you to key in the mock data for each property.
2323
- **Outputs** renders the output whenever a component's `getOutputs` method gets called. 
2424

powerapps-docs/developer/component-framework/get-powerapps-cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ To use Microsoft PowerApps CLI, do the following:
4545

4646

4747
> [!NOTE]
48-
> - To deploy your custom component using PowerApps CLI, you must have a Common Data Service environment with system administrator or system customizer privileges.
48+
> - To deploy your code component using PowerApps CLI, you must have a Common Data Service environment with system administrator or system customizer privileges.
4949
> - Currently, PowerApps CLI is supported only on Windows 10.
5050
5151
## Update Microsoft PowerApps CLI to the latest version

0 commit comments

Comments
 (0)