Do you build things with AMP? Fill out the AMP Developer Survey!
AMP
  • email

amp-lightbox

Introduction

The amp-lightbox component allows for a “lightbox” or similar experience - where upon user interaction a component expands to fill the viewport, until it is closed again by the user.

Setup

Import the amp-lightbox component in the header

<script async custom-element="amp-lightbox" src="https://cdn.ampproject.org/v0/amp-lightbox-0.1.js"></script>

You can combine the lightbox component with amp-bind.

<script async custom-element="amp-bind" src="https://cdn.ampproject.org/v0/amp-bind-0.1.js"></script>

Basic usage

The amp-lightbox component defines the child elements that will be displayed in a full-viewport overlay. To close the lightbox via click or tap use the on attribute on one or more elements inside the lightbox. In this example the user can click anywhere in the lightbox to close it.

The lighbox is shown when the user taps or clicks on an element with on attribute that targets the id of an amp-lightbox element.

<amp-lightbox id="my-lightbox"
  layout="nodisplay">
  <div class="lightbox"
    on="tap:my-lightbox.close"
    role="button"
    tabindex="0">
    <h1>Hello World!</h1>
  </div>
</amp-lightbox>
<button on="tap:my-lightbox">
  Open lightbox
</button>

For showing images in a lightbox, AMP also features the amp-image-lightbox component, which doesn't need the image to specified twice.

Combination with amp-bind

amp-lightbox can be opened as a result of amp-bind evaluations by binding a boolean value to the open attribute. Note that we're also listening to the lightboxClose event to reset the state of the variable.

<amp-lightbox id="my-bindable-lightbox"
  [open]="showLightbox"
  layout="nodisplay"
  on="lightboxClose:AMP.setState({showLightbox: false})">
  <div class="lightbox"
    role="button"
    tabindex="0"
    on="tap:my-bindable-lightbox.close">
    <h1>Hello World!</h1>
  </div>
</amp-lightbox>
<button on="tap:AMP.setState({showLightbox: true})">
  Open lightbox
</button>
Bạn cần được giải thích thêm?

Nếu bạn vẫn còn thắc mắc sau khi đọc hướng dẫn trên trang này, hãy liên hệ với những người dùng AMP khác để thảo luận về trường hợp sử dụng cụ thể của bạn.

Truy cập Stack Overflow
Một tính năng chưa được giải thích?

Dự án AMP đặc biệt khuyến khích sự tham gia và đóng góp của bạn! Chúng tôi hi vọng bạn sẽ trở thành một người tham gia tích cực trong cộng đồng mã nguồn mở của chúng tôi, nhưng chúng tôi cũng chào mừng các đóng góp đơn lẻ về vấn đề mà bạn đặc biệt quan tâm.

Chỉnh sửa mẫu trên GitHub