0.0.10 • Published 10 months ago

@react-bunker/toast-notification v0.0.10

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

👀 Links

⤵️ Instalando

Adicionar com yarn

yarn add @edinelsonslima/toast-notification

Adicionar com npm

npm install @edinelsonslima/toast-notification

👨🏻‍💻 Modo de usar

  • Adicione o componente <ToastContainer/> em algum lugar da sua aplicação;
  • Importe os estilos css de import '@edinelsonslima/toast-notification/dist/style.css';
import { ToastContainer } from '@edinelsonslima/toast-notification';
import '@edinelsonslima/toast-notification/dist/style.css';

export default function App(){
  //seu código

  return (
    <>
      <ToastContainer />
    </>
  )
}
  • Disparando os toast com a função toast de dentro do @edinelsonslima/toast-notification
import { toast } from '@edinelsonslima/toast-notification';

export default function MyComponent(){
  //seu código

  const exampleToast = () => {
    toast.success({ content: "Mensagem de exemplo" })
  }

  return (
    //seu código
  )
}

🧐 Informações adicionais

O que é disponível com o pacote

funçãopropriedades
ToastContainerclassNames position defaultDuration
toastcontent type duration
style/dist/style.css

As propriedades da função toast

propriedadetoast
contentA conteúdo que aparecerá dentro do toast
typeDefine o tipo de toast que é para aparecer
durationO tempo que o toast irá permanecer em tela

As propriedades do componente ToastContainer

propriedadeToastContainer
classNamesUm objeto de chave:valor onde a chave é o tipo de toast e o valor pode ser uma string (classNames) ou um objeto (CSSProperties)
positionDefine em qual parte da tela irá aparecer a toast notification, existe valores predefinidos
defaultDurationDefine tempo padrão de duração de todas as toast

Mais detalhes sobre as propriedades

propriedadetipoé obrigatóriopadrão
contentReactNodesim-
typestringsim-
durationnumbernão7_0000
defaultDurationnumbernão-
classNamesobjectnãoundefined
positionstringnãoright-top

ℹ️ O duration e defaultDuration estão em ms (milissegundos)

ℹ️ A função toast pode ser chamada de algumas formas, veja os exemplos a seguir:

caso seja chamada direta, será obrigatório informa o type

toast({ content: "mensagem exemplo", type: "info", duration: 1000 * 4 })

ou pode acessar o tipo do toast diretamente, assim omitindo ele do objeto enviado

toast.info({ content: "mensagem exemplo", durantino: 1000 * 4 })
toast.info('mensagem exemplo')
toast.info(<strong>mensagem exemplo</strong>)
toast.info(<MeuComponente>mensagem exemplo</MeuComponente>)
0.0.10

10 months ago

0.0.9

10 months ago

0.0.8

10 months ago

0.0.7

10 months ago

0.0.6

10 months ago

0.0.5

10 months ago

0.0.4

10 months ago

0.0.3

10 months ago

0.0.1

10 months ago

0.0.0

10 months ago