@interopio/home-ui-react 2.1.1 → 2.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.
Files changed (7) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +56 -56
  3. package/dist/index.js +1 -1
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +2 -2
  6. package/dist/index.mjs.map +1 -1
  7. package/package.json +7 -7
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2020 Tick42
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2020 Tick42
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,57 +1,57 @@
1
- # @interopio/home-ui-react
2
-
3
- The `@interopio/home-ui-react` library offers React components and hooks for building a [Home App](https://docs.interop.io/browser/capabilities/home-app/overview/index.html) for **io.Connect Browser** projects.
4
-
5
- ![Using Home](https://docs.interop.io/browser/images/home/using-home.gif)
6
-
7
- ## Installation
8
-
9
- To install the `@interopio/home-ui-react` library in your project, execute the following command:
10
-
11
- ```cmd
12
- npm install @interopio/home-ui-react
13
- ```
14
-
15
- ## Usage
16
-
17
- The following example demonstrates initializing the `@interopio/home-ui-react` library with basic configuration:
18
-
19
- ```javascript
20
- import { IOConnectHome } from "@interopio/home-ui-react";
21
- import "@interopio/workspaces-ui-react/dist/styles/workspaces.css";
22
- import "@interopio/home-ui-react/src/index.css";
23
-
24
- const getConfig = () => {
25
- // Platform configuration.
26
- const platformConfig = {
27
- browserPlatform: {
28
- factory: IOBrowserPlatform,
29
- config: {
30
- // Required license key.
31
- licenseKey: "my-license-key",
32
- // Workspaces App configuration.
33
- workspaces: {
34
- src: "/",
35
- isFrame: true
36
- }
37
- }
38
- }
39
- };
40
-
41
- return platformConfig;
42
- };
43
-
44
- // Configuration for the `<IOConnectHome />` component.
45
- const config = {
46
- // Retrieve the platform configuration.
47
- getIOConnectConfig: getConfig
48
- };
49
-
50
- export function App() {
51
- return <IOConnectHome config={config} />
52
- };
53
-
54
- export default App;
55
- ```
56
-
1
+ # @interopio/home-ui-react
2
+
3
+ The `@interopio/home-ui-react` library offers React components and hooks for building a [Home App](https://docs.interop.io/browser/capabilities/home-app/overview/index.html) for **io.Connect Browser** projects.
4
+
5
+ ![Using Home](https://docs.interop.io/browser/images/home/using-home.gif)
6
+
7
+ ## Installation
8
+
9
+ To install the `@interopio/home-ui-react` library in your project, execute the following command:
10
+
11
+ ```cmd
12
+ npm install @interopio/home-ui-react
13
+ ```
14
+
15
+ ## Usage
16
+
17
+ The following example demonstrates initializing the `@interopio/home-ui-react` library with basic configuration:
18
+
19
+ ```javascript
20
+ import { IOConnectHome } from "@interopio/home-ui-react";
21
+ import "@interopio/workspaces-ui-react/dist/styles/workspaces.css";
22
+ import "@interopio/home-ui-react/src/index.css";
23
+
24
+ const getConfig = () => {
25
+ // Platform configuration.
26
+ const platformConfig = {
27
+ browserPlatform: {
28
+ factory: IOBrowserPlatform,
29
+ config: {
30
+ // Required license key.
31
+ licenseKey: "my-license-key",
32
+ // Workspaces App configuration.
33
+ workspaces: {
34
+ src: "/",
35
+ isFrame: true
36
+ }
37
+ }
38
+ }
39
+ };
40
+
41
+ return platformConfig;
42
+ };
43
+
44
+ // Configuration for the `<IOConnectHome />` component.
45
+ const config = {
46
+ // Retrieve the platform configuration.
47
+ getIOConnectConfig: getConfig
48
+ };
49
+
50
+ export function App() {
51
+ return <IOConnectHome config={config} />
52
+ };
53
+
54
+ export default App;
55
+ ```
56
+
57
57
  For more details on using the library, see the [official documentation](https://docs.interop.io/browser/capabilities/home-app/library-features/index.html) of **io.Connect Browser**.