fullscreen.mdx 955 B

12345678910111213141516171819202122232425262728
  1. The FullScreen plugin toggles the browser's native fullscreen mode.
  2. ##### Usage
  3. This plugin is activated via data attributes.
  4. **Data API**
  5. Add `data-lte-toggle="fullscreen"` to a button element. Use `data-lte-icon="maximize"` and `data-lte-icon="minimize"` on child icon elements to toggle their visibility.
  6. ```html
  7. <button type="button" class="btn" data-lte-toggle="fullscreen">
  8. <i data-lte-icon="maximize" class="bi bi-arrows-fullscreen"></i>
  9. <i data-lte-icon="minimize" class="bi bi-fullscreen-exit" style="display: none"></i>
  10. </button>
  11. ```
  12. ##### Events
  13. | Event | Description |
  14. |-------|-------------|
  15. | `maximized.lte.fullscreen` | Fired when entering fullscreen mode. |
  16. | `minimized.lte.fullscreen` | Fired when exiting fullscreen mode. |
  17. ##### Notes
  18. - Requires browser support for the Fullscreen API (`document.fullscreenEnabled`).
  19. - The maximize icon is hidden when in fullscreen mode, and the minimize icon is shown (and vice versa).