AMP
ID
English Deutsch Français العربية Español Italiano 日本語 한국어 Português Русский Türkçe 中文 Polski Tiếng việt

Important: this documentation is not applicable to your currently selected format stories!

amp-sidebar

 
You can now use this component outside valid AMP documents using the Bento version of this component. Learn more in the Bento guide.

Description

Provides a way to display meta content intended for temporary access such as navigation, links, buttons, menus.

 

Required Scripts

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

Supported Layouts

Deskripsi Sidebar menyediakan cara untuk menampilkan konten meta yang ditujukan untuk akses sementara (link navigasi, tombol, menu, dll.). Sidebar dapat ditampilkan dengan menge-tap tombol sementara konten utama secara visual tetap berada di bawahnya.
Skrip yang Diperlukan <script async custom-element="amp-sidebar" src="https://cdn.ampproject.org/v0/amp-sidebar-0.1.js"></script>
Tata Letak yang Didukung nodisplay
Contoh Lihat contoh amp-sidebar di AMP By Example.

Ringkasan

<amp-sidebar> menyembunyikan konten meta yang ditujukan untuk akses sementara (link navigasi, tombol, menu, dll.). <amp-sidebar> dapat dibuka dan ditutup dengan menge-tap tombol, dan menge-tap di luar amp-sidebar. Namun, atribut opsional yang menerima kueri media dapat digunakan untuk menampilkan konten meta di bagian lain pada situs. Elemen <nav toolbar="(media query)" toolbar-target="elementID"> turunan memungkinkan konten dalam sidebar untuk ditampilkan di bagian lain konten utama.

Perilaku

  • <amp-sidebar> harus merupakan turunan langsung dari <body>.
  • Sidebar hanya dapat muncul di sisi kiri atau kanan halaman.
  • <amp-sidebar> dapat memuat semua elemen HTML yang valid (didukung oleh AMP).
  • <amp-sidebar> dapat memuat salah satu elemen AMP berikut:
    • <amp-accordion>
    • <amp-img>
    • <amp-fit-text>
    • <amp-list>
    • </amp-live-list>
    • <amp-social-share>
  • Tinggi maksimum sidebar adalah 100 vh, jika tinggi melebihi 100 vh maka scrollbar vertikal akan muncul. Tinggi default ditetapkan ke 100 vh di CSS dan dapat diganti dalam CSS.
  • Lebar sidebar dapat disetel dan disesuaikan menggunakan CSS (lebar minimum adalah 45 px).
  • Zoom sentuh dinonaktifkan pada amp-sidebar dan mask-nya saat sidebar terbuka.

Contoh:

Pada contoh berikut, kami menggunakan amp-sidebar untuk memuat item navigasi. Namun, item kedua dan keempat, Nav Item 2 dan Nav Item 4, ditetapkan ke ID elemen yang ada di halaman. Dengan menggunakan atribut on, kami dapat men-scroll dengan lancar ke elemen tersebut, menggunakan ID elemen dan scrollTo.

<amp-sidebar id="sidebar1" layout="nodisplay" side="right">
  <ul>
    <li>Nav item 1</li>
    <li><a href="#idTwo" on="tap:idTwo.scrollTo">Nav item 2</a></li>
    <li>Nav item 3</li>
    <li><a href="#idFour" on="tap:idFour.scrollTo">Nav item 4</a></li>
    <li>Nav item 5</li>
    <li>Nav item 6</li>
  </ul>
</amp-sidebar>

Membuka dan menutup sidebar

Untuk beralih, membuka, atau menutup sidebar saat elemen di-tap atau diklik, tetapkan atribut tindakan on pada elemen tersebut, dan tentukan salah satu metode tindakan berikut:

Tindakan Deskripsi
open (default) Membuka sidebar
close Menutup sidebar
toggle Mengalihkan status sidebar

Jika pengguna menge-tap kembali area konten utama yang terlihat sebagian, tindakan ini akan menutup sidebar.

Atau, menekan tombol escape pada keyboard juga akan menutup sidebar.

Contoh:

<button class="hamburger" on='tap:sidebar1.toggle'></button>
<button on='tap:sidebar1'>Open</button>
<button on='tap:sidebar1.open'>Open</button>
<button on='tap:sidebar1.close'>x</button>

Toolbar

Anda dapat membuat elemen toolbar yang ditampilkan di <body> dengan menentukan atribut toolbar dengan kueri media dan atribut toolbar-target dengan ID elemen pada elemen <nav> yang merupakan turunan dari <amp-sidebar>. toolbar menduplikasi elemen <nav> dan turunannya, serta menambahkan elemen ke dalam elemen toolbar-target.

Perilaku

  • Sidebar dapat mengimplementasikan toolbar dengan menambahkan elemen navigasi dengan atribut toolbar dan atribut toolbar-target.
  • Elemen navigasi harus merupakan turunan dari <amp-sidebar> dan mengikuti format ini: <nav toolbar="(media-query)" toolbar-target="elementID">.
    • Misalnya, berikut ini penggunaan toolbar yang valid: <nav toolbar="(max-width: 1024px)" toolbar-target="target-element">.
  • Navigasi yang memuat atribut toolbar hanya boleh memuat satu elemen <ul>, yang berisi elemen <li>.
    • Elemen <li> dapat memuat semua elemen HTML yang valid (didukung oleh AMP), atau salah satu elemen AMP yang didukung <amp-sidebar>.
  • Perilaku toolbar hanya diterapkan jika kueri media atribut toolbar valid. Selain itu, elemen dengan ID atribut toolbar-target harus ada pada halaman agar toolbar dapat diterapkan.

Contoh: Toolbar Dasar

Pada contoh berikut, kami menampilkan toolbar jika lebar jendela kurang dari atau sama dengan 767 piksel. toolbar memuat elemen input penelusuran. Elemen toolbar akan ditambahkan ke elemen <div id="target-element">.

<amp-sidebar id="sidebar1" layout="nodisplay" side="right">
  <ul>
    <li>Nav item 1</li>
    <li><a href="#idTwo" on="tap:idTwo.scrollTo">Nav item 2</a></li>
    <li>Nav item 3</li>
    <li><a href="#idFour" on="tap:idFour.scrollTo">Nav item 4</a></li>
    <li>Nav item 5</li>
    <li>Nav item 6</li>
  </ul>

  <nav toolbar="(max-width: 767px)" toolbar-target="target-element">
    <ul>
      <li>
        <input placeholder="Telusuri..."/>
      </li>
    </ul>
  </nav>
</amp-sidebar>

<div id="target-element">
</div>

Menata Gaya Toolbar

Elemen toolbar dalam elemen <amp-sidebar> akan memiliki class yang diterapkan ke elemen tersebut, bergantung pada apakah elemen toolbar-target ditampilkan atau disembunyikan. Hal ini berguna untuk menerapkan gaya berbeda pada elemen toolbar dan kemudian elemen toolbar-target. Class-nya adalah amp-sidebar-toolbar-target-shown, dan amp-sidebar-toolbar-target-hidden. Class amp-sidebar-toolbar-target-shown diterapkan ke elemen toolbar jika elemen toolbar-target ditampilkan. Class amp-sidebar-toolbar-target-hidden diterapkan ke elemen toolbar jika elemen toolbar-target disembunyikan.

Contoh: Class Status Toolbar

Pada contoh berikut, kami menampilkan toolbar jika lebar jendela kurang dari atau sama dengan 767 piksel. toolbar memuat elemen input penelusuran. Elemen toolbar akan ditambahkan ke elemen <div id="target-element">. Namun, kami menambahkan beberapa gaya kustom untuk menyembunyikan elemen toolbar, jika elemen <div id="toolbar-target"> ditampilkan.

<style amp-custom="">

  .amp-sidebar-toolbar-target-shown {
      display: none;
  }

</style>

<amp-sidebar id="sidebar1" layout="nodisplay" side="right">
  <ul>
    <li>Nav item 1</li>
    <li><a href="#idTwo" on="tap:idTwo.scrollTo">Nav item 2</a></li>
    <li>Nav item 3</li>
    <li><a href="#idFour" on="tap:idFour.scrollTo">Nav item 4</a></li>
    <li>Nav item 5</li>
    <li>Nav item 6</li>
  </ul>

  <nav toolbar="(max-width: 767px)" toolbar-target="target-element">
    <ul>
      <li>
        <input placeholder="Telusuri..."/>
      </li>
    </ul>
  </nav>
</amp-sidebar>

<div id="target-element">
</div>

Lihat demo langsung di AMP By Example.

Penggunaan amp-sidebar didukung dalam komponen amp-story.

Perilaku

  • <amp-sidebar> harus merupakan turunan langsung dari <amp-story>.
  • Sidebar didefaultkan ke sisi "mulai" untuk dokumen AMP reguler, artinya sebelah kanan untuk bahasa kiri-kanan dan sebelah kiri untuk bahasa kanan-kiri.
  • <amp-sidebar> memiliki warna latar belakang default putih dan dapat diganti di CSS.
  • Lebar maksimum <amp-sidebar> diterapkan pada 280 piksel dan 320 piksel untuk perangkat desktop.
  • Tombol gaya 'hamburger' yang membuka/menutup sidebar akan muncul di UI artikel.

Ada batasan tertentu terkait atribut dan fitur apa saja yang diizinkan untuk memberikan pengalaman UI yang konsisten di seluruh platform artikel. Berikut adalah atribut dan fitur amp-sidebar yang diizinkan dalam amp-story.

Atribut yang Diizinkan

Contoh: Sidebar Dasar dalam Artikel

Contoh berikut menampilkan amp-sidebar sederhana dalam amp-story.

...
<body>
  <amp-story standalone>
  <amp-sidebar id="sidebar1" layout="nodisplay">
    <ul>
      <li><a href="https://amp.dev"> External Link </a></li>
      <li>Nav item 2</li>
      <li>Nav item 3</li>
    </ul>
  </amp-sidebar>
  <amp-story-page id="cover">
    <amp-story-grid-layer template="fill">
      <h1>Hello World</h1>
      <p>This is the cover page of this story.</p>
    </amp-story-grid-layer>
  </amp-story-page>
  ...
</body>

Atribut

side

Menunjukkan dari sisi halaman mana sidebar akan dibuka, left atau right. Jika side tidak ditentukan, nilai side akan diturunkan dari atribut dir tag body (ltr => left , rtl => right); jika tidak ada dir, side didefaultkan ke left.

layout

Menentukan tata letak tampilan sidebar, yang harus berupa nodisplay.

open

Atribut ini ada saat sidebar terbuka.

data-close-button-aria-label

Atribut opsional yang digunakan untuk menetapkan label ARIA untuk tombol tutup yang ditambahkan untuk aksesibilitas.

toolbar

Atribut ini ada di elemen <nav toolbar="(media-query)" toolbar-target="elementID"> turunan, dan menerima kueri media tentang kapan toolbar ditampilkan. Lihat bagian Toolbar untuk informasi selengkapnya tentang cara menggunakan toolbar.

toolbar-target

Atribut ini ada di elemen <nav toolbar="(media-query)" toolbar-target="elementID"> turunan, dan menerima ID dari elemen yang ada di halaman itu. Atribut toolbar-target akan menempatkan toolbar dalam ID yang ditentukan untuk elemen di halaman tersebut, tanpa penataan gaya toolbar default. Lihat bagian Toolbar untuk informasi selengkapnya tentang cara menggunakan toolbar.

atribut umum

Elemen ini mencakup atribut umum yang diperluas ke komponen AMP.

Penataan gaya

Komponen amp-sidebar dapat ditata gayanya menggunakan CSS standar.

  • width dari amp-sidebar dapat disetel untuk menyesuaikan lebar antara nilai min (45 piksel) dan maks (80 vw) pra-setel.
  • Tinggi amp-sidebar dapat disetel untuk menyesuaikan tinggi sidebar, jika perlu. Jika tingginya melebihi 100 vw, sidebar akan memiliki scrollbar vertikal. Tinggi preset sidebar adalah 100 vw dan dapat diganti di CSS untuk membuatnya lebih pendek.
  • Status sidebar saat ini ditunjukkan melalui atribut open yang ditetapkan pada tag amp-sidebar saat sidebar terbuka di halaman.

Kunjungi Memulai AMP untuk menu navigasi responsif dengan gaya bawaan yang dapat digunakan di halaman AMP.

Scroll otomatis dalam area tambahan

amp-sidebar dapat otomatis men-scroll container tambahan ke elemen pertama yang dilengkapi atribut autoscroll baik pada kasus sidebar maupun toolbar.

Fitur ini berguna saat menangani daftar navigasi yang panjang dan menginginkan sidebar men-scroll ke item navigasi terbaru saat halaman dimuat.

Saat menggunakan fitur toolbar, autoscroll hanya berfungsi jika elemen <nav toolbar> ditetapkan ke overflow: auto atau overflow: scroll.

<style amp-custom="">

  nav [toolbar] {
    overflow: auto;
  }

</style>

<amp-sidebar id="sidebar1" layout="nodisplay" side="right">
  <nav toolbar="(max-width: 767px)" toolbar-target="target-element">
    <ul>
      <li>Nav item 1</li>
      <li>Nav item 2</li>
      <li>Nav item 3</li>
      <li autoscroll class="currentPage">Nav item 4</li>
      <li>Nav item 5</li>
      <li>Nav item 6</li>
    </ul>
  </nav>
</amp-sidebar>

<div id="target-element">
</div>

Lihat file contoh ini untuk kode contoh yang berfungsi.

Pertimbangan UX

Saat menggunakan <amp-sidebar>, perlu diingat bahwa pengguna akan sering menampilkan halaman Anda di perangkat seluler pada AMP viewer, yang mungkin menampilkan header posisi tetap. Selain itu, browser sering kali menampilkan header tetapnya sendiri di bagian atas halaman. Menambahkan elemen posisi tetap lainnya di bagian atas layar akan memerlukan banyak ruang layar seluler dengan konten yang tidak memberikan informasi baru kepada pengguna.

Karena alasan ini, sebaiknya kemampuan untuk membuka sidebar tidak ditempatkan dalam header lebar-penuh yang tetap.

Validasi

Lihat aturan amp-sidebar dalam spesifikasi validator AMP.

Perlu bantuan lainnya?

Anda telah membaca dokumen ini belasan kali, tetapi belum semua pertanyaan Anda terjawab? Mungkin orang lain merasakan hal yang sama. Berinteraksilah dengan mereka di Stack Overflow.

Kunjungi Stack Overflow
Menemukan bug atau ada fitur yang kurang?

Proyek AMP sangat menganjurkan partisipasi dan kontribusi Anda! Kami berharap Anda akan terus ambil bagian dalam komunitas sumber terbuka kami, tetapi kami juga menerima kontribusi satu kali untuk topik tertentu yang Anda minati.

Kunjungi GitHub