honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1408 from pnp/react-enhanced-powerapps-codetour

This commit is contained in:
Hugo Bernier 2020-07-26 23:33:01 -04:00 committed by GitHub
parent f87e8b50ea b6f523e0d5
commit b1d401bae6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 186 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

166
samples/react-enhanced-powerapps/.tours/react-enhanced-powerapps.tour Normal file
View File

@ -0,0 +1,166 @@
{
"title": "React-Enhanced-PowerApps",
"steps": [
{
"title": "Introduction",
"description": "Before you can build this web part, you need to install all the dependencies by using the command-line and running:\r\n\r\n>> npm install\r\n",
"file": "README.md",
"line": 49
},
{
"file": "src/webparts/enhancedPowerApps/components/EnhancedPowerApps.tsx",
"line": 45,
"description": "## Passing theme values to Power Apps\r\n\r\nWe embed Power Apps by using an `IFRAME` which points to the app's web view.\r\n\r\nPower Apps support using query string parameters, so we build a URL with a query string parameter for each theme color name that we selected in the web part's properties.",
"selection": {
"start": {
"line": 45,
"character": 5
},
"end": {
"line": 58,
"character": 6
}
}
},
{
"file": "src/webparts/enhancedPowerApps/components/EnhancedPowerApps.tsx",
"line": 78,
"description": "## Rendering the application\r\n\r\nJust like the out-of-the-box Power Apps web part, we use an IFRAME to embed Power Apps.",
"selection": {
"start": {
"line": 78,
"character": 8
},
"end": {
"line": 80,
"character": 19
}
}
},
{
"file": "src/webparts/enhancedPowerApps/EnhancedPowerAppsWebPart.ts",
"line": 279,
"description": "## Providing dynamic property metadata\r\n\r\nWhen SharePoint needs to query a web part to see what kinds of dynamic properties it will access, it calls the web part's `propertiesMetadata` property.\r\n\r\nIt returns a list of dynamic property names and the type of data they accept.\r\n\r\nIn this case, `dynamicProp` accepts `string`.",
"selection": {
"start": {
"line": 279,
"character": 3
},
"end": {
"line": 287,
"character": 4
}
}
},
{
"file": "src/webparts/enhancedPowerApps/EnhancedPowerAppsWebPart.ts",
"line": 88,
"description": "## Resizing proportionally\r\n\r\nWhen the web part renders, we get the web part's `clientWidth` so we can pass it to the IFRAME later. \r\n\r\nWe also calculate the desired height by using the selected aspect ratio (e.g.: 16:9) and multiplying with the width of the web part.",
"selection": {
"start": {
"line": 88,
"character": 5
},
"end": {
"line": 120,
"character": 48
}
}
},
{
"file": "src/webparts/enhancedPowerApps/EnhancedPowerAppsWebPart.ts",
"line": 53,
"description": "## Defining dynamic properties\r\n\r\nTo add support for dynamic properties, we add a `DynamicProperty<string>` property to the web part's properties. This is where we'll store the dynamic values when they're available.\r\n\r\nTo keep things simple, we treat every dynamic value as a string, because they'll be passed to the Power Apps IFRAME via query string parameters.",
"selection": {
"start": {
"line": 53,
"character": 3
},
"end": {
"line": 53,
"character": 40
}
}
},
{
"file": "src/webparts/enhancedPowerApps/EnhancedPowerAppsWebPart.ts",
"line": 239,
"description": "## Conditionally adding dynamic property fields\r\n\r\nIf the user selects to use dynamic properties (`this.properties.useDynamicProp === true`) we add a `PropertyPaneDynamicFieldSet` for the `PropertyPaneDynamicField` bound to the web part's `dynamicProp` property.",
"selection": {
"start": {
"line": 239,
"character": 17
},
"end": {
"line": 246,
"character": 20
}
}
},
{
"file": "src/webparts/enhancedPowerApps/EnhancedPowerAppsWebPart.ts",
"line": 69,
"description": "## Adding theme support\r\n\r\nThis code adds support for theming. \r\n\r\nIt gets the current theme (and stores it to `_themeVariant`) which will be used later to pass the theme variant to the components.\r\n\r\nIt also binds to the `themeChangedEvent`, which will notify the web part when themes change or the section background color changes.",
"selection": {
"start": {
"line": 69,
"character": 3
},
"end": {
"line": 80,
"character": 4
}
}
},
{
"file": "src/webparts/enhancedPowerApps/EnhancedPowerAppsWebPart.ts",
"line": 298,
"description": "## Handling theme changed events\r\n\r\nWhen the theme changes, we store the new theme variant to `_themeVariant` and cause the web part to re-render -- thus refreshing the web part.",
"selection": {
"start": {
"line": 298,
"character": 3
},
"end": {
"line": 301,
"character": 4
}
}
},
{
"file": "src/webparts/enhancedPowerApps/EnhancedPowerAppsWebPart.ts",
"line": 126,
"description": "## Passing the theme variant\r\n\r\nWhen rendering the web part, we pass the theme variant we retrieved earlier so that we can forward the theme colors to Power Apps.",
"selection": {
"start": {
"line": 126,
"character": 9
},
"end": {
"line": 126,
"character": 42
}
}
},
{
"file": "src/webparts/enhancedPowerApps/EnhancedPowerAppsWebPart.manifest.json",
"line": 12,
"description": "## Adding theme support in the manifest\r\n\r\nFor web parts to adapt to changing themes, the manifest needs to add `\"supportsThemeVariants\": true`; otherwise, theme changes will not fire.",
"selection": {
"start": {
"line": 12,
"character": 3
},
"end": {
"line": 12,
"character": 33
}
}
},
{
"file": "src/webparts/enhancedPowerApps/ThemeVariantSlots.ts",
"line": 1,
"description": "## Dropdown theme color names\r\n\r\nTo make it easier to display the list of theme colors, we generated a static list of drop down options. I'm sure that there is a way to enumerate theme variant slots dynamically, but I wanted to keep the code simple."
}
]
}

9
samples/react-enhanced-powerapps/src/webparts/enhancedPowerApps/EnhancedPowerAppsWebPart.ts
View File

@ -80,10 +80,14 @@ export default class EnhancedPowerAppsWebPart extends BaseClientSideWebPart<IEnh
}
public render(): void {
const { clientWidth } = this.domElement;
// Context variables and dynamic properties
const dynamicProp: string | undefined = this.properties.dynamicProp.tryGetValue();
const locale: string = this.context.pageContext.cultureInfo.currentCultureName;
// Get the client width. This is how we'll calculate the aspect ratio and resize the iframe
const { clientWidth } = this.domElement;
// Get the aspect width and height based on aspect ratio for the web part
let aspectWidth: number;
let aspectHeight: number;
switch(this.properties.aspectratio) {
@ -104,10 +108,13 @@ export default class EnhancedPowerAppsWebPart extends BaseClientSideWebPart<IEnh
aspectHeight = 3;
break;
case "Custom":
// Custom aspects just use the width and height properties
aspectWidth = this.properties.width;
aspectHeight = this.properties.height;
}
// If we're using fixed height, we pass the height and don't resize, otherwise we
// calculate the height based on the web part's width and selected aspect ratio
const clientHeight: number = this.properties.layout === 'FixedHeight' ?
this.properties.height :
clientWidth * (aspectHeight/aspectWidth);

22
samples/react-enhanced-powerapps/src/webparts/enhancedPowerApps/components/EnhancedPowerApps.tsx
View File

@ -29,10 +29,13 @@ export default class EnhancedPowerApps extends React.Component<IEnhancedPowerApp
height,
width
} = this.props;
// The only thing we need for this web part to be configured is an app link or app id
const needConfiguration: boolean = !appWebLink;
const { semanticColors }: IReadonlyTheme = themeVariant;
// If we passed a dynamic property, add it as a query string parameter
const dynamicPropValue: string = useDynamicProp && dynamicProp !== undefined ? `&${encodeURIComponent(dynamicPropName)}=${encodeURIComponent(dynamicProp)}`:'';
// We can take an app id or a full link. We'll assume (for now) that people are passing a valid app URL
@ -43,16 +46,15 @@ export default class EnhancedPowerApps extends React.Component<IEnhancedPowerApp
let themeParams: string = "";
if (themeValues && themeValues.length > 0) {
themeValues.forEach((themeValue: string) => {
try {
const themeColor: string = semanticColors[themeValue];
themeParams = themeParams + `&${themeValue}=${encodeURIComponent(themeColor)}`;
} catch (e) {
console.log(e);
}
});
themeValues.forEach((themeValue: string) => {
try {
const themeColor: string = semanticColors[themeValue];
themeParams = themeParams + `&${themeValue}=${encodeURIComponent(themeColor)}`;
} catch (e) {
console.log(e);
}
});
}