@brokerize/elements 1.4.1 → 1.4.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 +10 -9
- package/dist/bundle.d.ts +7 -0
- package/dist/bundle.es.js +3217 -3187
- package/dist/bundle.umd.js +50 -47
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -267,15 +267,16 @@ createBrokerizeMain({
|
|
|
267
267
|
|
|
268
268
|
### properties
|
|
269
269
|
|
|
270
|
-
| Property
|
|
271
|
-
|
|
|
272
|
-
| apiCtx
|
|
273
|
-
| theme
|
|
274
|
-
| useNavigation
|
|
275
|
-
| addFrame
|
|
276
|
-
| supportLink
|
|
277
|
-
| openExternalLink
|
|
278
|
-
| returnToUrl
|
|
270
|
+
| Property | Description | optional |
|
|
271
|
+
| :------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | :------: |
|
|
272
|
+
| apiCtx | Instance of `AuthorizedApiContext` from `@brokerize/client` | ❌ |
|
|
273
|
+
| theme | You can use the <a href="https://app.brokerize.com/theming">brokerize theme designer</a> to build a theme JSON | ✅ |
|
|
274
|
+
| useNavigation | Show the default navigation bar on `BrokerizeMain` | ✅ |
|
|
275
|
+
| addFrame | Add a "powered by brokerize" frame to the component. Defaults to true. | ✅ |
|
|
276
|
+
| supportLink | Add a support link to the brokerize frame config, e.g. `{ emailSubject: 'Help needed for trading in XYZ app'}` | ✅ |
|
|
277
|
+
| openExternalLink | A function for handling links to external documents, e.g. cost estimations | ✅ |
|
|
278
|
+
| returnToUrl | URL to return to after login | ✅ |
|
|
279
|
+
| preferredExchangeId | One of the Exchange IDs as returned by the brokerize API's GetExchanges endpoint, will be set as the default exchange _if_ supported by the broker | ✅ |
|
|
279
280
|
|
|
280
281
|
### events
|
|
281
282
|
|
package/dist/bundle.d.ts
CHANGED
|
@@ -106,6 +106,11 @@ export declare type BrokerizeMainConfig = BrokerizeBaseConfig & {
|
|
|
106
106
|
* If provided, OAuth broker logins will return to this URL. Defaults to window.location.href.
|
|
107
107
|
*/
|
|
108
108
|
returnToUrl?: string;
|
|
109
|
+
/**
|
|
110
|
+
* Can be provided to pick a default exchange from the known brokerize exchanges.
|
|
111
|
+
* Note that it may be ignored depending on broker's preferences.
|
|
112
|
+
*/
|
|
113
|
+
preferredExchangeId?: number;
|
|
109
114
|
};
|
|
110
115
|
|
|
111
116
|
export declare type BrokerizeMainElement = BrokerizeElement & {
|
|
@@ -905,6 +910,8 @@ export declare type ThemeTokens = {
|
|
|
905
910
|
'zl-font-weight-semibold'?: string;
|
|
906
911
|
'zl-footer-color'?: string;
|
|
907
912
|
'zl-footer-font-size'?: string;
|
|
913
|
+
'zl-brokerlist-font-size'?: string;
|
|
914
|
+
'zl-brokerlist-checkbox-font-size'?: string;
|
|
908
915
|
'zl-form-item-background-color'?: string;
|
|
909
916
|
'zl-form-item-border-radius'?: string;
|
|
910
917
|
'zl-form-item-border'?: string;
|