@eduzz/apps-toolbar
v5.0.4
Published
[![version](https://img.shields.io/npm/v/@eduzz/apps-toolbar)](https://www.npmjs.com/package/@eduzz/apps-toolbar)
Downloads
1,019
Keywords
Readme
Eduzz Apps Toolbar
Toolbar cross-application.
Como User
Via package (sugerido):
Mesmo sendo instalado via package, ele possui um processo de auto-atualização, ou seja, no browser ele tentará baixar a última versão (^ patch, semver), caso sem sucesso, ele usará a versão do bundle.
import EduzzAppsToolbar from '@eduzz/apps-toolbar';
EduzzAppsToolbar({
application: 'nutror',
show: false //default false
}).then(toolbar => {
toolbar.show();
toolbar.setUser({/* user */});
//...
});
Via CDN:
Atenção na versão selecionada, importante manter o ^!
(function (d, l, c) {
var s = d.createElement('script');
s.async = true;
s.src = l;
s.onload = c;
d.body.append(s);
})(document, 'https://unpkg.com/@eduzz/apps-toolbar@^2.0.0/dist/widget.js', function () {
var toolbar = window.EduzzAppsToolbar({
application: 'nutror',
show: true //default false,
env: 'development'
});
// Or later
toolbar.show();
toolbar.hide();
});
API
// Parâmetros
interface IEduzzToolbarSetupParams {
show: boolean; // default false
application?: 'nutror'
| 'blinket'
| 'orbita'
| 'sun'
| 'jobzz'
| 'telescope'
| 'safevideo'
| 'alumy'
| 'orbit-pages'; // default null
applicationUrls?: { [key in typeEduzzToolbarApplications]: string }; // override application urls
env?: 'production' | 'homolog' | 'development'; // default production
disableChat?: boolean; // default false, pode ser alterado depois, apenas para black+
user?: { // default null, pode ser alterado depois
id: number;
email: string;
belt?: string;
isSupport?: boolean;
supportId?: number;
isClubeBlack?: boolean;
};
}
// Métodos
const EduzzAppsToolbar: (params: IEduzzToolbarSetupParams) => {
show(): void;
hide(): void;
setUser(user: IEduzzToolbarSetupParams['user']): void;
clearUser(): void;
enableChat(): void;
disableChat(): void;
};