1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/chiroc-jquery-messenger

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
Внести вклад в разработку кода
Синхронизировать код
Отмена
Подсказка: Поскольку Git не поддерживает пустые директории, создание директории приведёт к созданию пустого файла .keep.
Loading...
README.md

jQuery Messenger

jQuery Messenger — это мощный плагин для отображения сообщений на клиентской стороне, который облегчает работу разработчиков. Основные функции включают:

  • отображение базовой информации, сообщений об ошибках, предупреждений, успешных сообщений или сообщений в виде HTML/объекта jQuery;
  • отображение уведомлений на рабочем столе, если текущая страница неактивна;
  • добавление сообщения к указанному узлу DOM;
  • отображение сообщения в верхнем левом углу, по центру или справа, а также в нижнем левом углу, по центру или справа;
  • управление и анализ сообщений;
  • отправка сообщений на сервер.

Поддержка браузеров: IE10+.

Зависимости: jQuery 1.10+.

Установка (путь зависит от проекта):

<script type="text/javascript" src="../lib/jquery-1.11.1.js"></script>
<link rel="stylesheet" href="../style/jquery-messenger.css">
<script type="text/javascript" src="../jquery-messenger.js"></script>
<!-- lang file is optional, default language is English -->
<script type="text/javascript" src="../lang/zh-CN.js"></script>

Использование: обратитесь к демоверсии.

Документация API

Messenger.info(messages, [opt])

  • @param {string|jQuery|Array} messages
  • @param {object} [opt]
  • @returns {Messenger}

Отображает информационные сообщения с помощью синей рамки.

// Отображение одного строкового сообщения.
Messenger.info('Это обычное сообщение.');
// Одновременное отображение массива сообщений.
Messenger.info(['Сообщение 1.', 'Сообщение 2.', 'Сообщение 3.']);
// Отображение объекта jQuery с кнопкой события.
var btn = $('#btn').click(function(){ alert('Событие работает.'); });
Messenger.info(btn);
// Отображение сообщения с дополнительными параметрами.
Messenger.info('Привет, мир!', {
    target: $('#message-wrapper'),
    closable: false,
    messageIcon: true,
    messageTime: true
});

Messenger.success(messages, [opt])

Отображает сообщения об успешном выполнении с зелёной рамкой. Описание использования аналогично Messenger.info(messages, [opt]).

Messenger.warning(messages, [opt])

Отображает предупреждающие сообщения с жёлтой рамкой. Описание использования аналогично Messenger.info(messages, [opt]).

Messenger.error(messages, [opt])

Отображает сообщения об ошибке с красной рамкой. Описание использования аналогично Messenger.info(messages, [opt]).

Messenger.clear()

-@returns {Messenger}

Очищает все всплывающие сообщения.

Messenger.remove()

-@returns {Messenger}

Удаляет все кэшированные данные.

Messenger.openConsole()

-@returns {Messenger}

Открывает диалоговое окно управления.

Messenger.closeConsole()

-@returns {Messenger}

Закрывает диалоговое окно управления.

Messenger.setting(opts)

-@returns {Messenger}

Глобальные настройки плагина, которые переопределяют настройки по умолчанию.

var settings = {
            /**
             * true - показывать уведомления на рабочем столе.
             */
            notify: true,
            /**
             * префикс URL-адреса значка уведомления на рабочем столе.
             */
            notifyIconUrl: '..',
            /**
             * true - отображать кнопку закрытия сообщения.
             */
            closable: true,
            /**
             * true - отображать кнопку открытия мессенджера в нижней части окна при появлении сообщения.
             */
            handle: true,
            /**
             * true - каждый элемент сообщения будет добавляться к предыдущему перед тайм-аутом.
             * false - одновременно будет отображаться только один элемент сообщения.
             */
            multiple: true,
            /**
             * Максимальный размер всплывающего сообщения для одновременного отображения, работает, если 'multiple' = true.
             */
            popupSize: 5,
            /**
             * Расположение окна мессенджера, содержит: верхний левый угол, верхний центр, верхний правый угол, нижний левый угол, нижний центр, нижний правый угол.
             */
            layout: 'верхний центр',
            /**
             * Объект родительского элемента для окна мессенджера.
             */
            target: 'body',
            /**
             * Ширина окна мессенджера. Полная ширина равна '100%'.
             */
            width: 800,
            /**
             * Миллисекунды до закрытия сообщения. По умолчанию '0' — тайм-аут рассчитывается по длине текста.
             */ ### Messenger.getSettings()
-@returns {objects} settings

Получает глобальные настройки плагина.

### Messenger.getMessage(mid)
-@param {string} mid
-@returns {*|{}}

Получает отдельное сообщение по идентификатору сообщения.

### Messenger.getMessages()
-@returns {{}}

Получает весь кэш сообщений.

### Messenger.getMessagesId()
-@returns {Array}

Получает все идентификаторы сообщений из кэша.

### Messenger.setNotify(enable)
-@param {boolean} enable true — показывает уведомление на рабочем столе, когда текущая страница неактивна.
-@returns {Messenger}

Устанавливает переключатель уведомлений на рабочем столе.

### Messenger.setNotifyIconUrl()
-@param {string} url
-@returns {Messenger}

Задаёт префикс URI для значков уведомлений на рабочем столе.

### Messenger.setClosable(enable)
-@param {boolean} enable true — включает кнопку закрытия сообщения (в правом верхнем углу сообщения).
-@returns {Messenger}

Включает или выключает кнопку закрытия сообщения.

### Messenger.setCacheSize()
-@param {number} size
-@returns {Messenger}

Устанавливает размер кэша сообщений.

### Messenger.setMultiple(enable)
-@param {boolean} enable true — отображает сообщения (popupSize) одновременно. Если количество сообщений достигает popupSize, последнее сообщение заменяется новым. Все сообщения исчезают по истечении времени ожидания. false — отображает одно сообщение одновременно.
-@returns {Messenger}

Определяет режим отображения сообщений во всплывающем окне.

### Messenger.setPopupSize(size)
-@param {number} size
-@returns {Messenger}

Максимальное количество сообщений в поле всплывающих сообщений.

### Messenger.setPageSize(size)
-@param {number} size
-@returns {Messenger}

Максимальное количество сообщений на консоли мессенджера.

### Messenger.setLayout(layout)
-@param {string} layout
-@returns {Messenger}

Задаёт макет пользовательского интерфейса: top-center/top-left/top-right/bottom-center/bottom-left/bottom-right.

### Messenger.setTarget(target)
-@param {string|jQuery|$} target
-@returns {Messenger}

Указывает цель добавления окна мессенджера.

### Messenger.setTargetDefault()
-@returns {Messenger}

По умолчанию устанавливает целью добавления окно мессенджера «body».

### Messenger.setTimeout(timeout)
-@param {number} timeout 0 — рассчитывается системой автоматически.
-@returns {Messenger}

Устанавливает время ожидания сообщений. Это значение переопределяется определением отдельного сообщения.

### Messenger.setAutoUpload(enable)
-@param {boolean} enable
-@returns {Messenger}

Комментарии ( 0 )

Вы можете оставить комментарий после Вход в систему

Введение

Messenger используется для отображения сообщений при взаимодействии. Развернуть Свернуть
MIT
Отмена

Обновления

Пока нет обновлений

Участники

все

Недавние действия

Загрузить больше
Больше нет результатов для загрузки
1
https://api.gitlife.ru/oschina-mirror/chiroc-jquery-messenger.git
git@api.gitlife.ru:oschina-mirror/chiroc-jquery-messenger.git
oschina-mirror
chiroc-jquery-messenger
chiroc-jquery-messenger
master