@itwin/one-click-lca-react 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -19,7 +19,7 @@ Users must have the `imodels_read` and `insights_view` [permissions](https://dev
|
|
|
19
19
|
## Sample usage
|
|
20
20
|
|
|
21
21
|
```tsx
|
|
22
|
-
import { OneClickLCAProvider } from "@itwin/one-click-lca-
|
|
22
|
+
import { OneClickLCAProvider } from "@itwin/one-click-lca-react";
|
|
23
23
|
|
|
24
24
|
<Viewer
|
|
25
25
|
...
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@itwin/one-click-lca-react",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "An iTwin.js 3D Viewer Widget that interfaces with the iTwin Carbon Calculation.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Bentley",
|
|
@@ -103,5 +103,5 @@
|
|
|
103
103
|
"test": "jest",
|
|
104
104
|
"cover": "nyc npm test"
|
|
105
105
|
},
|
|
106
|
-
"readme": "# @itwin/one-click-lca-react\n\nCopyright © Bentley Systems, Incorporated. All rights reserved.\n\nThe One Click CLA widget is a UI component for iTwin Viewer applications that simplifies how users (and developers) interface with the [Carbon Calculation One Click LCA APIs](https://developer.bentley.com/apis/carbon-calculation/overview/).\nThe one-click-lca-react package provides a UiProvider class, `OneClickLCAProvider`, which can be passed into the `uiProviders` prop of the iTwin Viewer's `<Viewer />` component.\n\n## Getting Started\n\nThis is not a standalone UI and requires a parent iTwin Viewer application to work as intended.\nA guide on how to create a basic iTwin Viewer application can be found [here](https://www.itwinjs.org/learning/tutorials/develop-web-viewer).\nThis package provides a viewer _widget_. Documentation on how to add a widget to your application can be found [here](https://developer.bentley.com/tutorials/itwin-viewer-hello-world/#2-your-first-ui-widget).\n\n## Permissions and Scopes\n\nThe SPA client used by your iTwin viewer application must have allowed scopes `insights:read` and `insights:write`, found under the Reporting & Insights category.\nUsers must have the `imodels_read` and `insights_view` [permissions](https://developer.bentley.com/apis/carbon-calculation/operations/create-oneclicklca-job/#authorization) assigned at either the Project or iModel level. Additional instruction on how to create roles and assign permissions can be found in the [iTwin Platform Projects API documentation](https://developer.bentley.com/apis/projects/tutorials/).\n\n## Sample usage\n\n```tsx\nimport { OneClickLCAProvider } from \"@itwin/one-click-lca-
|
|
106
|
+
"readme": "# @itwin/one-click-lca-react\n\nCopyright © Bentley Systems, Incorporated. All rights reserved.\n\nThe One Click CLA widget is a UI component for iTwin Viewer applications that simplifies how users (and developers) interface with the [Carbon Calculation One Click LCA APIs](https://developer.bentley.com/apis/carbon-calculation/overview/).\nThe one-click-lca-react package provides a UiProvider class, `OneClickLCAProvider`, which can be passed into the `uiProviders` prop of the iTwin Viewer's `<Viewer />` component.\n\n## Getting Started\n\nThis is not a standalone UI and requires a parent iTwin Viewer application to work as intended.\nA guide on how to create a basic iTwin Viewer application can be found [here](https://www.itwinjs.org/learning/tutorials/develop-web-viewer).\nThis package provides a viewer _widget_. Documentation on how to add a widget to your application can be found [here](https://developer.bentley.com/tutorials/itwin-viewer-hello-world/#2-your-first-ui-widget).\n\n## Permissions and Scopes\n\nThe SPA client used by your iTwin viewer application must have allowed scopes `insights:read` and `insights:write`, found under the Reporting & Insights category.\nUsers must have the `imodels_read` and `insights_view` [permissions](https://developer.bentley.com/apis/carbon-calculation/operations/create-oneclicklca-job/#authorization) assigned at either the Project or iModel level. Additional instruction on how to create roles and assign permissions can be found in the [iTwin Platform Projects API documentation](https://developer.bentley.com/apis/projects/tutorials/).\n\n## Sample usage\n\n```tsx\nimport { OneClickLCAProvider } from \"@itwin/one-click-lca-react\";\n\n<Viewer\n ...\n uiProviders={[new OneClickLCAProvider()]}\n/>\n```\n"
|
|
107
107
|
}
|