Rich Media Templates syntax

Important notice
Starting from iOS 9, the operating system enables App Transport Security by default and requires all the network connection to support HTTPS and Perfect Secrecy. To use images, videos or other content for Rich Media that comes from non-secure HTTP servers you have to disable ATS in your app.
To disable ATS for your application, please follow this post.
Template structure
Template is simply a .zip archive that can contain HTML, JavaScript, CSS and images as Rich Media assets. The archive must contain index.html file in its root.
Please make sure that your index.html is UTF-8 encoded.
Template placeholders
You can use placeholders in the Rich Media templates that will allow you to change and localize the values in Rich Media content.
A placeholder must follow the format below:
{{ Placeholder name | Type | Default value }}
Where:
Placeholder name — is the name of the placeholder that will be visible in the Rich Media editor.
Type — is the type of the placeholder. The type can be any of the following values:
color — color input
text — text input
html — text area (multiline text)
Default value — default value that is used if no value is provided in the editor. If none is set then Placeholder name is used as a default value.
Example:
{{Header text|text|Tell Us What You Think}}
Adding Pushwoosh.json
You can group placeholders so they would be linked together in the Rich Media editor:
To achieve that, add pushwoosh.json file to the archive with your Rich Media template next to the index.html file.
The structure of the file is very simple and should be self explanatory:
1
{
2
  "input_groups": [
3
    ["Logo image URL", "Logo background color"],
4
    ["Topic text", "Topic text color", "Topic background color", "Sub-topic text"],
5
    ["Main text", "Text background color"],
6
    ["Button text", "Button URL", "Button text color", "Button background color"]
7
  ]
8
}
Copied!
Example
Here's the example for one of the default templates in the Control Panel. Happy coding!
1
<!DOCTYPE html>
2
<html>
3
<head>
4
    <link href='https://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
5
    <style type="text/css">
6
        html, body {
7
            height: 100%;
8
            width: 100%;
9
            padding: 0;
10
            margin: 0;
11
            font-family: "Open Sans";
12
        }
13
        .main {
14
            height: 100%;
15
            width: 100%;
16
            box-sizing: border-box;
17
            -moz-box-sizing: border-box;
18
            -webkit-box-sizing: border-box;
19
        }
20
        .logo {
21
            width: 100%;
22
            height: 15%;
23
            background-image: url('{{Logo image URL|text|https://www.pushwoosh.com/wp-content/themes/pushwoosh/img/logo.png}}');
24
            background-position: 50% 50%;
25
            background-size: 50%;
26
            background-repeat: no-repeat;
27
            background-color: #{{Logo background color|color|343434}};
28
        }
29
        .topic-wrapper {
30
            width: 100%;
31
            height: 30%;
32
            text-align: center;
33
            display: table;
34
            color: #{{Topic text color|color|FFFFFF}};
35
            background-color: #{{Topic background color|color|23B7A4}};
36
        }
37
        .topic {
38
            display: table-cell;
39
            text-align: center;
40
            vertical-align: middle;
41
        }
42
        .topic-wrapper h1, .topic-wrapper p {
43
            margin: 0;
44
        }
45
        .padding-wrapper {
46
            width: 100%;
47
            height: 55%;
48
            box-sizing: border-box;
49
            -moz-box-sizing: border-box;
50
            -webkit-box-sizing: border-box;
51
            padding: 0 2% 0 2%;
52
            background-color: #{{Text background color|color|FFFFFF}};
53
        }
54
        .text-wrapper {
55
            height: 70%;
56
            width: 100%;
57
            padding: 2% 0 2% 0;
58
            box-sizing: border-box;
59
            -moz-box-sizing: border-box;
60
            -webkit-box-sizing: border-box;
61
            overflow: hidden;
62
        }
63
        .text {
64
            width: 100%;
65
            height: 99%;
66
            overflow: auto;
67
            padding-right: 15px;
68
        }
69
        .button-wrapper {
70
            height: 30%;
71
            width: 100%;
72
            padding: 2% 0 2% 0;
73
            box-sizing: border-box;
74
            -moz-box-sizing: border-box;
75
            -webkit-box-sizing: border-box;
76
        }
77
        .button {
78
            display: table;
79
            width: 100%;
80
            height: 100%;
81
        }
82
        .button a {
83
            display: table-cell;
84
            vertical-align: middle;
85
            text-align: center;
86
            font-size: 2em;
87
            text-decoration: none;
88
            color:#{{Button text color|color|FFFFFF}} ;
89
            border-radius: 20px;
90
            background-color: #{{Button background color|color|23B7A4}};
91
        }
92
​
93
        @media only screen
94
        and (orientation: landscape) {
95
            .padding-wrapper {
96
                height: 45%;
97
            }
98
            .logo {
99
                height: 20%;
100
            }
101
            .button a {
102
                border-radius: 10px;
103
            }
104
        }
105
    </style>
106
</head>
107
<body>
108
​
109
<div class="main">
110
    <div class="logo"></div>
111
    <div class="topic-wrapper">
112
        <div class="topic">
113
            <h1>{{Topic text|text|TOPIC TEXT}}</h1>
114
            <p>{{Sub-topic text|text|Subtopic here}}</p>
115
        </div>
116
    </div>
117
    <div class="padding-wrapper">
118
        <div class="text-wrapper">
119
            <div class="text">
120
                {{Main text|html|Main text here}}
121
            </div>
122
        </div>
123
        <div class="button-wrapper">
124
            <div class="button">
125
                <a href="{{Button URL|text|https://www.pushwoosh.com}}">
126
                    {{Button text|text|Submit}}
127
                </a>
128
            </div>
129
        </div>
130
    </div>
131
</div>
132
</body>
133
</html>
Copied!

Content - Previous

Rich Media

Customizing Rich Media Appearance

Last modified 2yr ago

Copy link

Contents

Template structure

Template placeholders

Adding Pushwoosh.json

Example