summaryrefslogtreecommitdiffstats
path: root/browser/components/asrouter/docs/simple-cfr-template.rst
blob: a1edf4cc8a7957616ee5d653dd16887ad63fbeef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
Simple CFR Template
--------------------

The “Simple CFR Template” is a two-stage UI (a chiclet notification and a door-hanger)
that shows up on a configurable `trigger condition`__, such as when the user visits a
particular web page.

.. __: /toolkit/components/messaging-system/docs/TriggerActionSchemas

Warning! Before reading, you should consider whether a `Messaging Experiment is relevant for your needs`__.

.. __: https://docs.google.com/document/d/1S45a_nFn8QRM8gvsxCM6HHROrIQlQQl6fUlJ2j63PGI/edit

.. image:: ./cfr_doorhanger_screenshot.png
    :align: center
    :alt: Simple CFR Template 2 stage

Doorhanger Configuration
=========================

Stage 1 – Chiclet
++++++++++++++++++

* **chiclet_label**: The text that shows up in the chiclet. 20 characters max.
* **chiclet_color**: The background color of the chiclet as a HEX code.


Stage 2 – Door-hanger
++++++++++++++++++++++

* **title**: Title text at the top of the door hanger.
* **body**: A longer paragraph of text.
* **icon**: An image (please provide a URL or the image file up to 96x96px).
* **primary_button_label**: The label of the button.
* **primary_button_action**: The special action triggered by clicking on the button. Choose any of the available `button actions`__. Common examples include opening a section of about:preferences, or opening a URL.

.. __: /toolkit/components/messaging-system/docs/SpecialMessageActionSchemas