Toastr
Multi layout renderless Toaster Notification
Can be used outside of the Enso ecosystem.
For live examples and demos, you may visit laravel-enso.com
Installation
Install the package:
yarn add @enso-ui/toastr
(within Enso, remember to cd
into the client
folder before installing front-end assets)
Note that this package has a couple of external dependencies. Read here for more info.
Exports
@enso-ui/toastr/bulma
:
Toastr
@enso-ui/tabs/renderless
:
CoreToastr
@enso-ui/transitions/renderless
:
Bounce
Usage
Import the component(s):
import Toastr from '@enso-ui/toastr/bulma';
import ToastrPlugin from '@enso-ui/toastr';
Install the plugin:
Vue.use(ToastrPlugin, {
layout: Toastr,
options: {
duration: 3500,
position: 'right',
},
});
Note that the provided duration and position are the defaults, but they can be overriden on each use.
Examples
this.$toastr.success('You operation was successful')
this.$toastr.title('Warning')
.position('bottom-left')
.duration(5000)
.warning('Something is wrong...')
this.$toastr.title('HTML').html('<span class="tag is-success'>v2.0.0</span>`)
Tip
You can create your own layouts & transitions by using the renderless component
CoreToastr.vue
The renderless toaster notification component which can be built upon to create custom implementations.
Props
duration
-number
, required - the duration of the bounce animation, in ms, used when showing the notificationposition
-string
, required - the position, valid options are: 'top-left', 'top-right', 'top-center', 'bottom-left', 'bottom-right', 'bottom-center'
Methods
title(string)
- sets on optional titleduration(number)
- sets the duration in msposition(string)
- sets the position, available options 'top-left', 'top-right', 'top-center', 'bottom-left', 'bottom-right', 'bottom-center'html(html)
- displays html content
The methods below are used to display a themed message:
error(message)
info(message)
message(message)
primary(message)
success(message)
warning(message)
Toastr
The bulma styled toaster notification component built on top of its renderless version.
Props
All the props from CoreToastr
can be provided here
transitions/Bounce.vue
A reusable bounce transition.
Props
position
-string
, required, the position of the animated contents valid options are: 'top-left', 'top-right', 'top-center', 'bottom-left', 'bottom-right', 'bottom-center',
Depending on the given position, the transition's enter & leave classes are automatically determined.
Slots
default
, slot for the actual contents
Questions & Issues
For questions and support please use the issues functionality for this package's github repository.
Please make sure to search for existing issues before creating a new issue, and when opening a new issue, fill the required information in the issue template.
Issues not conforming to the guidelines may be closed immediately.
Contributions
are welcome. Pull requests are great, but issues are good too.
Thank you to all the people who already contributed to Enso!
License
← Themes Transitions →