obi-sdk 0.19.99 → 0.19.101-beta.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/README.md +16 -0
- package/dist/index.js +1 -1
- package/dist/obi-sdk.standalone.iife.js +1 -1
- package/dist/src/sdk.d.ts +11 -0
- package/dist/src/types.d.ts +6 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -135,6 +135,22 @@ sdk.updateConfig({ showMenu: true, isActive: true })
|
|
|
135
135
|
|
|
136
136
|
**Note**: For comprehensive documentation, usage examples, and best practices, refer to the [obi-loader package documentation](https://www.npmjs.com/package/obi-loader).
|
|
137
137
|
|
|
138
|
+
## Temporary V3 Rollout Gate
|
|
139
|
+
|
|
140
|
+
The SDK currently routes `update({ showMenu: true })` to Widget V3 (side panel) by default.
|
|
141
|
+
|
|
142
|
+
Temporary exception:
|
|
143
|
+
|
|
144
|
+
- Hostname `app.canibuild.com` remains on Widget V2 for `showMenu` calls.
|
|
145
|
+
|
|
146
|
+
Override behavior:
|
|
147
|
+
|
|
148
|
+
- Passing `showSidePanel` explicitly still wins:
|
|
149
|
+
- `update({ showMenu: true, showSidePanel: true })` forces V3.
|
|
150
|
+
- `update({ showMenu: true, showSidePanel: false })` forces V2.
|
|
151
|
+
|
|
152
|
+
This gate is temporary and should be removed once Canibuild is migrated to V3.
|
|
153
|
+
|
|
138
154
|
## Event API
|
|
139
155
|
|
|
140
156
|
The Obi SDK extends `EventEmitter` and provides events for monitoring SDK state and responding to changes. Access the SDK instance via `window.obi` to subscribe to events.
|