Show:

Q.Notice Class

Defined in: platform/plugins/Q/web/js/Q.js:12926
Module: Q

Operates with notices.

Item Index

Methods

Properties

Methods

add

(
  • options
)

Defined in platform/plugins/Q/web/js/Q.js:12946

Adds a notice.

Parameters:

  • options Object

    Object of options

    • [key] String optional

      Unique key for this notice. Need if you want to modify/remove notice by key.

    • content String

      HTML contents of this notice.

    • [closeable=true] Boolean optional

      Whether notice can be closed with red x icon.

    • [handler] Function | String optional

      Something (callback or URL) to handle with Q.handle()

    • [type=common] String optional

      Arbitrary type of notice. Can be used to apply different styles dependent on type, because appropriate CSS class appended to the notice. May be 'error', 'warning'.

    • [timeout=false] Boolean | Number optional

      Time in seconds after which to remove notice.

    • [persistent=false] Boolean | Number optional

      Whether to save this notice to session to show after page refresh.

get

(
  • notice
)

Defined in platform/plugins/Q/web/js/Q.js:13047

Get a notice by key.

Parameters:

  • notice String | HTMLElement

    HTMLElement or key Unique key of notice which has been provided when notice was added. Or notice HTMLElement

hide

(
  • notice
)

Defined in platform/plugins/Q/web/js/Q.js:13101

Hides a notice.

Parameters:

  • notice String | HTMLElement

    HTMLElement or key Unique key of notice which has been provided when notice was added. Or notice HTMLElement

parseNotices

()

Defined in platform/plugins/Q/web/js/Q.js:13130

Parse notices loaded from backend.

remove

(
  • notice
)

Defined in platform/plugins/Q/web/js/Q.js:13066

Removes a notice.

Parameters:

  • notice String | HTMLElement

    HTMLElement or key Unique key of notice which has been provided when notice was added. Or notice HTMLElement

show

(
  • notice
)

Defined in platform/plugins/Q/web/js/Q.js:13116

Shows a previously notice.

Parameters:

  • notice String | HTMLElement

    HTMLElement or key Unique key of notice which has been provided when notice was added. Or notice HTMLElement

Properties

container

HTMLElement

Defined in platform/plugins/Q/web/js/Q.js:12939

Container for notices

popUpTime

Number

Defined in platform/plugins/Q/web/js/Q.js:12932

Setting that changes notices slide down / slide up time.

Default: 500