@os1-platform/console-ui-react 1.7.8 → 1.8.0
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/package.json +2 -2
- package/readme.md +55 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@os1-platform/console-ui-react",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.8.0",
|
|
4
4
|
"description": "React wrapper for console-ui library",
|
|
5
5
|
"main": "dist/commonjs/aaa/index.js",
|
|
6
6
|
"types": "dist/commonjs/types/aaa/index.d.ts",
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {
|
|
29
29
|
"@fullhuman/postcss-purgecss": "^5.0.0",
|
|
30
|
-
"@os1-platform/console-ui-js": "1.
|
|
30
|
+
"@os1-platform/console-ui-js": "1.8.0",
|
|
31
31
|
"@react-native-community/eslint-config": "^2.0.0",
|
|
32
32
|
"@types/react": "^17.0.37",
|
|
33
33
|
"axios": "^0.21.4",
|
package/readme.md
CHANGED
|
@@ -548,6 +548,61 @@ const broadcast = await cl.broadCastEvents(
|
|
|
548
548
|
|
|
549
549
|
```
|
|
550
550
|
|
|
551
|
+
### Support for Showing and Hiding Injectable Controls
|
|
552
|
+
|
|
553
|
+
- The system provides functionality to dynamically show or hide injectable controls at runtime.
|
|
554
|
+
|
|
555
|
+
1. Dynamic Control Visibility
|
|
556
|
+
Developers can invoke the exposed API method to toggle control visibility by passing the injectableId and an eventType parameter:
|
|
557
|
+
|
|
558
|
+
````
|
|
559
|
+
const payload = {
|
|
560
|
+
injectableId: "teamDropdown",
|
|
561
|
+
eventType: "HIDE",
|
|
562
|
+
};
|
|
563
|
+
consoleInstance?.injectableControllers(payload);
|
|
564
|
+
|
|
565
|
+
```
|
|
566
|
+
````
|
|
567
|
+
|
|
568
|
+
2. Initial Control Visibility on Page Load
|
|
569
|
+
Control visibility can also be configured at the time of application load or reload.
|
|
570
|
+
|
|
571
|
+
Available properties:
|
|
572
|
+
|
|
573
|
+
`hideInitialDisplay`: Boolean indicating whether the control should be hidden initially.
|
|
574
|
+
|
|
575
|
+
```
|
|
576
|
+
<OS1Provider
|
|
577
|
+
clientId={window.ENV.NEXT_PUBLIC_DISPATCH_CLIENT_ID}
|
|
578
|
+
loginRedirectPath={"/application"}
|
|
579
|
+
logoutRedirectPath={"/application/"}
|
|
580
|
+
appId={"app:uuuid"}
|
|
581
|
+
controls={[
|
|
582
|
+
...[
|
|
583
|
+
{
|
|
584
|
+
type: "DropDown",
|
|
585
|
+
width: 100,
|
|
586
|
+
placeholder: "Select team",
|
|
587
|
+
float: "left",
|
|
588
|
+
id: teamDropdownId,
|
|
589
|
+
hasAsyncFunctionBoundOption: true,
|
|
590
|
+
showInjectable: true,
|
|
591
|
+
hideInitialDisplay: true,
|
|
592
|
+
},
|
|
593
|
+
],
|
|
594
|
+
]}/>
|
|
595
|
+
</OS1Provider>
|
|
596
|
+
```
|
|
597
|
+
|
|
598
|
+
- The system exposes a logout event that developers can subscribe to in order to perform custom actions when a user logs out.
|
|
599
|
+
```
|
|
600
|
+
consoleInstance
|
|
601
|
+
.eventBus()
|
|
602
|
+
.on(consoleInstance.events().LogoutEvent, function () {
|
|
603
|
+
});
|
|
604
|
+
```
|
|
605
|
+
|
|
551
606
|
## Configuration for Injectable Controls offered by the Library
|
|
552
607
|
|
|
553
608
|
#### Common parameters, that will be passed in all injectable controls:-
|