aboutsummaryrefslogtreecommitdiff
path: root/files/es/web/api/fullscreen_api/index.html
blob: 0914c6d6277af1db43f738a2bc88085bfea1900a (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
---
title: Fullscreen API
slug: Web/API/Fullscreen_API
translation_of: Web/API/Fullscreen_API
---
<p>{{DefaultAPISidebar("Fullscreen API")}}</p>

<p class="summary">La <strong><code>API Fullscreen</code></strong> provee una manera fácil de presentar contenido web usando la pantalla completa del usuario. La API permite indicar al navegador que un elemento y sus hijos, si los tiene, ocupar la pantalla completa, ocultando toda la interfaz del usuario y otras aplicaciones de la pantalla mientras se esté en pantalla completa.</p>

<div class="note">
<p>De momento, no todos los navegadores usan la versión sin prefijo de la API. Consulta la <a href="#Prefijado">tabla que resume las diferencias de prefijos y nombres</a>.</p>
</div>

<h2 id="Specification" name="Specification">Activando modo de pantalla completa</h2>

<p>Para cualquier elemento que quieras presentar en pantalla completa (como por ejemplo, un elemento {{ HTMLElement("video") }}), puedes presentarlo en pantalla completa, simplemente invocando a su método <code>requestFullscreen()</code>.</p>

<p>Consideremos este elemento {{ HTMLElement("video") }}:</p>

<pre class="brush: html">&lt;video controls id="myvideo"&gt;
  &lt;source src="somevideo.webm"&gt;&lt;/source&gt;
  &lt;source src="somevideo.mp4"&gt;&lt;/source&gt;
&lt;/video&gt;
</pre>

<p>Podemos poner este video en pantalla completa con un script como éste:</p>

<pre class="brush: js">var elem = document.getElementById("myvideo");
if (elem.requestFullscreen) {
  elem.requestFullscreen();
}
</pre>

<h3 id="Diferencias_de_presentación">Diferencias de presentación</h3>

<p>Cabe aclarar una diferencia clave entre las implementaciones de Gecko y WebKit: Gecko automáticamente añade reglas CSS al elemento para ajustarlo a las dimensiones de la pantalla: "<code>width: 100%; height: 100%</code>". WebKit no hace esto; en su lugar, centra el elemento con su mismo tamaño original en un fondo negro. Para obtener el mismo comportamiento en WebKit, necesitas añadir manualmente las reglas CSS "<code>width: 100%; height: 100%;</code>" al elemento:</p>

<pre class="brush: css">#myvideo:-webkit-full-screen {
  width: 100%;
  height: 100%;
}
</pre>

<p>Por otro lado, si quieres emular el comportamiento de WebKit en Gecko, necesitarías colocar el elemento a presentar dentro de otro elemento, con las reglas CSS necesarias para ajustarlo a la apariencia requerida, y será dicho elemento contenedor el que se establecerá para aparecer en pantalla completa.</p>

<h3 id="Notificación">Notificación</h3>

<p>Cuando el modo de pantalla completa sea invocado exitosamente, el documento que contiene al elemento recibe un evento {{ event("fullscreenchange") }}. Cuando se sale del modo de pantalla completa, el documento recibe de nuevo un evento {{ event("fullscreenchange") }}. Nótese que el evento {{ event("fullscreenchange") }} no provee información alguna sobre si el documento está entrando o saliendo a modo de pantalla completa, pero puedes saber si está en dicho modo si la propiedad {{ domxref("document.fullscreenElement", "fullscreenElement") }} del documento no es nula.</p>

<h3 id="Cuando_la_solicitud_de_pantalla_completa_falla">Cuando la solicitud de pantalla completa falla</h3>

<p>No es garantía que se pueda cambiar a modo de pantalla completa. Por ejemplo, los elementos {{ HTMLElement("iframe") }} tienen un atributo {{ HTMLAttrXRef("allowfullscreen", "iframe") }} para decidir si se permitirá que el contenido se muestre en pantalla completa. Además, ciertos tipos de contenido, como plug-ins en ventana, no pueden ser presentados en modo de pantalla completa. Intentar hacerlo con elementos que no lo permitan (o el padre o descendente de un elemento así), no funcionará. En su lugar, el elemento que solicitó la pantalla completa recibirá un evento <code>fullscreenerror</code>. En Firefox, cuando falla una solicitud de pantalla completa, el navegador registrará un mensaje de error en la consola, explicando la falla de la solicitud. En Chrome y versiones recientes de Opera, sin embargo, no se genera ninguna advertencia.</p>

<div class="note">
<p><strong>Nota:</strong> Las solicitudes de pantalla completa necesitan ser invocadas dentro de un manejador de eventos, o de otro modo, serán denegadas.</p>
</div>

<h2 id="Saliendo_del_modo_de_pantalla_completa">Saliendo del modo de pantalla completa</h2>

<p>El usuario siempre tendrá la habilidad de salir del modo de pantalla completa por su propia cuenta; véase {{ anch("Things_your_users_want_to_know", "Cosas que los usuarios querrán saber") }}. Incluso se puede hacer programáticamente, llamando al método {{domxref("exitFullscreen()")}}.</p>

<h2 id="Otra_información">Otra información</h2>

<p>El objeto {{ domxref("document") }} provee información adiciional que puede ser útil al desarrollar aplicaciones de pantalla completa:</p>

<dl>
 <dt>{{ domxref("document.fullscreenElement", "fullscreenElement") }}</dt>
 <dd>El atributo <code>fullscreenElement</code> apunta al {{ domxref("element", "elemento") }} actualmente en modo pantalla. Si no es nulo, el documento está en pantalla completa, y si es nulo, no lo está.</dd>
 <dt>{{ domxref("document.fullscreenEnabled", "fullscreenEnabled") }}</dt>
 <dd>El atributo <code>fullscreenEnabled</code> indica si el documento está actualmente en un estado que permitiría solicitudes al modo de pantalla completa.</dd>
</dl>

<h2 id="Things_your_users_want_to_know" name="Things_your_users_want_to_know">Cosas que los usuarios querrán saber</h2>

<p>Puedes asegurarte de hacer saber a los usuarios que pueden presionar la tecla <kbd>ESC</kbd> (o <kbd>F11</kbd>) para salir del modo de pantalla completa.</p>

<p>Adicionalmente, navegando a otra página, cambiando de pestaña, o cambiando a otra aplicación(usando, por ejemplo, <kbd>Alt</kbd>-<kbd>Tab</kbd>) mientras se está en pantalla completa, también se saldrá de dicho modo.</p>

<h2 id="Specification" name="Specification">Ejemplo</h2>

<p>En este ejemplo, se presenta un video en una página web. Presionando la tecla <kbd>Return</kbd><kbd>Enter</kbd> el usuario podrá moverse entre modo de ventana o de pantalla completa para la presentación del video.</p>

<p><a href="/samples/domref/fullscreen.html">Ver ejemplo en vivo</a></p>

<h3 id="Observando_la_tecla_Enter">Observando la tecla <kbd>Enter</kbd></h3>

<p>Cuando la página se carga, este código se ejecuta para establecer un evento para cuando se presione la tecla <kbd>Enter</kbd>.</p>

<pre class="brush: js">document.addEventListener("keydown", function(e) {
  if (e.keyCode == 13) {
    toggleFullScreen();
  }
}, false);
</pre>

<h3 id="Cambiando_entre_modo_de_pantalla_completa_y_modo_de_ventana">Cambiando entre modo de pantalla completa y modo de ventana</h3>

<p>Este código es llamado cuando el usuario presiona la tecla <kbd>Enter</kbd>, como se ve arriba.</p>

<pre class="brush: js">function toggleFullScreen() {
  if (!document.fullscreenElement) {
      document.documentElement.requestFullscreen();
  } else {
    if (document.exitFullscreen) {
      document.exitFullscreen();
    }
  }
}
</pre>

<p>En este código, primero se observa si el atributo <code>fullscreenElement</code> de {{ domxref("document") }} (comprobando si tiene prefijo <code>moz</code>,<code> ms</code>, o <code>webkit</code>). Si es <code>null</code>, el documento está en modo de ventana actualmente, así que necesitamos cambiarlo a modo de pantalla completa. Esto se hace llamando a la función {{ domxref("element.requestFullscreen()") }}.</p>

<p>Si el modo de pantalla completa está activado (<code>fullscreenElement</code> no es <code>null</code>), llamamos a la función {{ domxref("document.exitFullscreen()") }}.</p>

<h2 id="Prefijado">Prefijado</h2>

<p>De momento, no todos los navegadores están implementando la versión sin prefijo de la API. Aquí está la tabla que resume los prefijos y diferencias de nombres entre ellos:</p>

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">Estándar</th>
   <th scope="col">Blink (Chrome y Opera)</th>
   <th scope="col">Gecko (Firefox)</th>
   <th scope="col">Internet Explorer 11</th>
   <th scope="col">Edge</th>
   <th scope="col">Safari (WebKit)</th>
  </tr>
  <tr>
   <td>{{domxref("Document.fullscreen")}}</td>
   <td><code>webkitIsFullScreen</code></td>
   <td><code>mozFullScreen</code></td>
   <td><em>-</em></td>
   <td><code>webkitIsFullScreen</code></td>
   <td><code>webkitIsFullScreen</code></td>
  </tr>
  <tr>
   <td>{{domxref("Document.fullscreenEnabled")}}</td>
   <td><code>webkitFullscreenEnabled</code></td>
   <td><code>mozFullScreenEnabled</code></td>
   <td><code>msFullscreenEnabled</code></td>
   <td><code>webkitFullscreenEnabled</code></td>
   <td><code>webkitFullscreenEnabled</code></td>
  </tr>
  <tr>
   <td>{{domxref("Document.fullscreenElement")}}</td>
   <td><code>webkitFullscreenElement</code></td>
   <td><code>mozFullScreenElement</code></td>
   <td><code>msFullscreenElement</code></td>
   <td><code>webkitFullscreenElement</code></td>
   <td><code>webkitFullscreenElement</code></td>
  </tr>
  <tr>
   <td>{{domxref("Document.onfullscreenchange")}}</td>
   <td><code>onwebkitfullscreenchange</code></td>
   <td><code>onmozfullscreenchange</code></td>
   <td><code>onmsfullscreenchange</code></td>
   <td><code>onwebkitfullscreenchange</code></td>
   <td><code>onwebkitfullscreenchange</code></td>
  </tr>
  <tr>
   <td>{{domxref("Document.onfullscreenerror")}}</td>
   <td><code>onwebkitfullscreenerror</code></td>
   <td><code>onmozfullscreenerror</code></td>
   <td><code>onmsfullscreenerror</code></td>
   <td><code>onwebkitfullscreenerror</code></td>
   <td><code>onwebkitfullscreenerror</code></td>
  </tr>
  <tr>
   <td>{{domxref("Document.exitFullscreen()")}}</td>
   <td><code>webkitExitFullscreen()</code></td>
   <td><code>mozCancelFullScreen()</code></td>
   <td><code>msExitFullscreen()</code></td>
   <td><code>webkitExitFullscreen()</code></td>
   <td><code>webkitExitFullscreen()</code></td>
  </tr>
  <tr>
   <td>{{domxref("Element.requestFullscreen()")}}</td>
   <td><code>webkitRequestFullscreen()</code></td>
   <td><code>mozRequestFullScreen()</code></td>
   <td><code>msRequestFullscreen()</code></td>
   <td><code>webkitRequestFullscreen()</code></td>
   <td><code>webkitRequestFullscreen()</code></td>
  </tr>
 </thead>
</table>

<h2 id="Especificaciones">Especificaciones</h2>

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">Especificación</th>
   <th scope="col">Estatus</th>
   <th scope="col">Comentarios</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td>{{SpecName("Fullscreen")}}</td>
   <td>{{Spec2("Fullscreen")}}</td>
   <td>Versión inicial.</td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_compatibility" name="Browser_compatibility">Browser compatibility</h2>

<p>All browsers implement this APIs. Nevertheless some implement it with prefixed names we slightly different spelling: e.g. instead of <code>requestFullscreen()</code>, there is a <code>MozRequestFullScreen()</code>.</p>

<p>{{ CompatibilityTable() }}</p>

<div id="compat-desktop">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Característica</th>
   <th>Chrome</th>
   <th>Edge</th>
   <th>Firefox (Gecko)</th>
   <th>Internet Explorer</th>
   <th>Opera</th>
   <th>Safari</th>
  </tr>
  <tr>
   <td>Soporte básico</td>
   <td>15 {{ property_prefix("-webkit") }}</td>
   <td>{{CompatVersionUnknown}}</td>
   <td>{{ CompatGeckoDesktop("9.0") }} {{ property_prefix("-moz") }}<br>
    {{CompatGeckoDesktop("47")}} (behind <code>full-screen-api.unprefix.enabled</code>)</td>
   <td>11 {{ property_prefix("-ms") }}</td>
   <td>12.10</td>
   <td>5.0 {{ property_prefix("-webkit") }}</td>
  </tr>
  <tr>
   <td><code>fullscreenEnabled</code></td>
   <td>20 {{ property_prefix("-webkit") }}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{ CompatGeckoDesktop("10.0") }} {{ property_prefix("-moz") }}<br>
    {{CompatGeckoDesktop("47")}} (behind <code>full-screen-api.unprefix.enabled</code>)</td>
   <td>11 {{ property_prefix("-ms") }}</td>
   <td>12.10</td>
   <td>5.1 {{ property_prefix("-webkit") }}</td>
  </tr>
 </tbody>
</table>
</div>

<div id="compat-mobile">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Característica</th>
   <th>Android</th>
   <th>Chrome</th>
   <th>Edge</th>
   <th>Firefox Mobile (Gecko)</th>
   <th>IE Mobile</th>
   <th>Opera Mobile</th>
   <th>Safari Mobile</th>
  </tr>
  <tr>
   <td>Soporte básico</td>
   <td>{{ CompatUnknown() }}</td>
   <td>28 {{ property_prefix("-webkit") }}</td>
   <td>{{CompatVersionUnknown}}</td>
   <td>{{ CompatGeckoMobile("9.0") }}{{ property_prefix("-moz") }}<br>
    {{CompatGeckoMobile("47")}} (behind <code>full-screen-api.unprefix.enabled</code>)</td>
   <td>{{ CompatUnknown() }}</td>
   <td>{{ CompatUnknown() }}</td>
   <td>{{ CompatUnknown() }}</td>
  </tr>
  <tr>
   <td><code>fullscreenEnabled</code></td>
   <td>{{ CompatUnknown() }}</td>
   <td>28 {{ property_prefix("-webkit") }}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{ CompatGeckoMobile("10.0") }} {{ property_prefix("moz") }}<br>
    {{CompatGeckoMobile("47")}} (behind <code>full-screen-api.unprefix.enabled</code>)</td>
   <td>{{ CompatUnknown() }}</td>
   <td>{{ CompatUnknown() }}</td>
   <td>{{ CompatUnknown() }}</td>
  </tr>
 </tbody>
</table>
</div>

<h2 id="Véase_también">Véase también</h2>

<ul>
 <li>{{ domxref("Element.requestFullscreen()") }}</li>
 <li>{{ domxref("Document.exitFullscreen()") }}</li>
 <li>{{ domxref("Document.fullscreen") }}</li>
 <li>{{ domxref("Document.fullscreenElement") }}</li>
 <li>{{ cssxref(":fullscreen") }}, {{cssxref("::backdrop")}}</li>
 <li>{{ HTMLAttrXRef("allowfullscreen", "iframe") }}</li>
</ul>