0.1.0 • Published 5 years ago
menonro-notification v0.1.0
Установка
Подключение через тег
<script type="text/javascript" src="notification.js"></script>
Подключение через require() || import()
import Notification from 'menonro-notification'
/////////
const Notification = require('menonro-notification');
Использование
Инициализация
const myBoard = new Notifications([ verticalPosition: string, horizontalPosition: string, [ customColors: object ] ])
verticalPosition: string
Позиция блока уведомлений по вертикали Возможные значения: top || bottom
horizontalPosition: string
Позиция блока уведомлений по вертикали Возможные значения: left || right ( || center в будущем )
customColors: object
Объект с предустановкой базовых цветов для элементов Не обязательно указывать все значения
// Указаны стандартные значения
// Можно использовать любые значения, которыми можно выразить цвет (RGB, RGBA, HEX и др.)
const options = {
color: 'white', // Цвет текста и крестика
colorAlt: 'black', // Цвет текста и крестика у уведомления со статусом 'clear'
success: '#4caf50', // Задний фон уведомлений со статусом 'success'
warning: '#ffc107', // Задний фон уведомлений со статусом 'warning'
error: '#f44336', // Задний фон уведомлений со статусом 'error'
clear: '#e8f5e9' // Задний фон уведомлений со статусом 'clear'
}
Дабы избежать совпадений в названиии css классов каждый раз генерируется новый hash, который доступен в переменной window.NotificationsHash
Вызов уведомления
myBoard.send(youMessage: string, [ status: string, timeToHide: number ])
youMessage: string
Текст вашего сообщения, который может содержать любые теги HTML
status: string
Статус определяет, какие цвета будут использоваться в сообщении (По умолчанию 'clear')
Возможные значения: success || warning || error || clear
timeToHide: number
Время в ms, как долго будет висеть сообщение (по умолчанию 30000)
В будущем будут добавлены методы .success, .warning, .error, .clear
0.1.0
5 years ago