![QUIQQER Info Popup](bin/images/Readme.png)

QUIQQER Info Popup
========

Display simple information popups to your visitors – announcements, notices,
promotions or any other message you want to show when a page is opened.

Popups are created and managed in the QUIQQER administration. Each popup has a
multilingual title and content, a chosen layout and an optional media area with
an image and/or background colour. The content is rendered on the server and
delivered lazily, so the popup markup is only loaded right before it is shown.
Every visitor sees a popup only once per version – as soon as the content is
edited, it is shown again.

Package name:

    quiqqer/info-popup


Features
--------

![QUIQQER Info Popup_Preview](bin/images/preview/QUIQQER-Info-Popup-Example-2.png)

- Create, edit, delete and (de)activate information popups directly in the
  QUIQQER backend
- Priority per popup controls the opening order when several popups are due
- Multilingual title and content, each with a rich-text editor per language;
  the content is edited through a preview box that opens the editor in its own
  window
- Four layouts, chosen with visual preview cards:
    - **Content only** – no media area
    - **Media on the left** / **Media on the right** – content beside the media
      area
    - **Media on top** – media area above the content
- Media area with an image and/or a background colour; for "Media on top", the
  complete image can optionally determine its own height without being cropped
- Project-wide defaults for the design, maximum width/height and the display
  delay – every value can be overridden per popup, or left on "Default
  (project setting)"
- Adjustable vertical content alignment (top, center, bottom)
- Optional horizontal centering for the title and otherwise unaligned content
- Visibility control per popup: everyone, guests only, logged-in users, or
  specific user groups
- Scheduling with "valid from" / "valid until" dates (open-ended when left
  empty)
- Server-rendered content with lazy delivery (markup is fetched per popup just
  before it opens) and a per-version render cache
- "Seen once" logic per popup version via the visitor's local storage – editing
  a popup makes it appear again
- Accessible modal dialog: `role="dialog"` / `aria-modal`, focus moved into the
  dialog and ESC to close
- Styling through the QUIQQER three-layer CSS variable pattern

Installation
------------

The package name is: `quiqqer/info-popup`


MCP integration
---------------

With the optional `quiqqer/ai-mcp` package, AI agents can list, read, create,
partially update and delete project-bound info popups through the central
QUIQQER MCP server. Grant the MCP user the `quiqqer.infoPopup.mcp` permission
to enable these tools. New popups are inactive by default.


Contribution
----------

- Issue Tracker: https://dev.quiqqer.com/quiqqer/info-popup/-/issues
- Source Code: https://dev.quiqqer.com/quiqqer/info-popup/-/tree/main


Support
-------

If you found any flaws, have any wishes or suggestions you can send an email
to [support@pcsg.de](mailto:support@pcsg.de) to inform us about your concerns.
We will try to respond to your request and forward it to the responsible developer.


License
-------

GPL-3.0+
