summaryrefslogtreecommitdiff
path: root/doc/api/embed_parameters.md
blob: dcbe3e5b37e3592d213277d2054b57a4423806b3 (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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# Embed parameters
You can easily embed your etherpad-lite into any webpage by using iframes. You can configure the embedded pad using embed paramters.

Example:

Cut and paste the following code into any webpage to embed a pad. The parameters below will hide the chat and the line numbers.

```
<iframe src='http://pad.test.de/p/PAD_NAME?showChat=false&showLineNumbers=false' width=600 height=400></iframe>
```

## showLineNumbers
 * Boolean

Default: true

## showControls
 * Boolean

Default: true

## showChat
 * Boolean

Default: true

## useMonospaceFont
 * Boolean

Default: false

## userName
 * String

Default: "unnamed"

Example: `userName=Etherpad%20User`

## userColor
 * String (css hex color value)

Default: randomly chosen by pad server

Example: `userColor=%23ff9900`

## noColors
 * Boolean

Default: false

## alwaysShowChat
 * Boolean

Default: false

## lang
 * String

Default: en

Example: `lang=ar` (translates the interface into Arabic)

## rtl
 * Boolean
 
Default: true
Displays pad text from right to left.