Documentação
Instalação
$ yarn add @eduzz/fidc-alert
# or
$ npm i @eduzz/fidc-alert
Uso
import Alert from '@eduzz/fidc-alert';
...
<Alert eduzzId={1234567} userName='Fulano de Tal' />
API
Todas as props do componente:
prop | tipo | obrigatório | padrão | descrição |
---|---|---|---|---|
eduzzId | number |
true |
- | - |
userName | string |
true |
- | - |
action | modal ou newTab |
false |
newTab |
Fortemente recomendado usar como newTab por conta da experiência de maior qualidade pro usuário |
env | production ou homolog ou development |
false |
REACT_APP_ENV ou production |
Pode ser passado um objeto sobrescrevendo determinada propriedade da env |
returnTo | string |
false |
window.location.href |
URL que deseja retornar o usuário após o cadastro ser finalizado ou em outras ações de retornar |
application | Brands |
false |
eduzz |
Lista de aplicações que temos nos tokens do Houston, essa propriedade serve apenas para decidir a cor primária e secundária do componente, se a sua aplicação não está na lista, não precisa informar essa propriedade |
className | string |
false |
- |