Lewati ke isi

Dokumentasi pengembang API v1.0 · v1.1

Membangun pola kerja lengkap, aman.

Eyivo tema mendefinisikan sistem visual selesai: struktur halaman, typografi, komponen dan styling. Pemilik bisnis kemudian mengisi dalam konten yang disetujui di App - tanpa pindah blok, menyunting kode atau merusak desain.

Prinsip inti

Cairan memutuskan bagaimana situs web terlihat; Eyivo Inti memutuskan yang Isi perusahaan muncul di sana.

1. Model mental

Ada tiga tanggung jawab terpisah, membuat mereka terpisah adalah kunci untuk memahami V1.

Eyivo Core

Toko rincian perusahaan, halaman, media, SEO, keadaan navigasi dan penerbitan. Ini adalah sumber kebenaran bagi isi.

Paket tema

Mendefinisikan bentuk halaman tetap, daerah yang diijinkan, skema komponen kustom dan CSSTidak pernah mencari data atau mengeksekusi kode aplikasi.

Penyunting App

Menghasilkan bentuk aman dari skema. Pemilik dapat memutakhirkan teks, gambar, halaman dan urutan daerah di dalam suatu area.

Bukan pembuat halaman: pemilik dapat menambahkan bagian yang diizinkan ke main dan memilih posisi angkanya. Pemilik tidak dapat membuat area baru, memindahkan hero ke footer, atau mengubah file tema Anda. Pemilik dapat menambahkan CSS situs sendiri yang dimuat setelah stylesheet Anda, dan memberi nama kelas pada bagian (lihat CSS kustom situs).

2. Awal cepat: template minimal yang dapat digunakan

Setiap tema v1 memiliki tata letak lengkap, gaya, dan skrip, dan dapat mengatur mereka dalam desain apapun yang penulis pilih. Tema tidak pernah mewarisi tata letak atau aset dari tema lain. Biasa eyivo: komponen dan tujuh fallback tipe halaman berasal theme-core; sebuah tema hanya menyimpan tipe halaman yang menimpa dan komponen yang mendeklarasikan di theme: namespace.

Setiap tema v1 membutuhkan sebuah berkas tata letak baku. Keduanya page-types/ dan components/ adalah opsional ketika paket hanya menggunakan latar belakang inti:

acme-industrial/
├── theme.json
├── layouts/default.liquid
├── page-types/
│   └── home.liquid        # optional override
├── components/
│   └── featured_course.liquid
├── locales/
│   ├── en.json
│   └── tr.json
├── screenshots/
│   └── home-desktop.png   # demo-data screenshot
└── assets/
    ├── css/theme.css
    └── js/theme.js        # Theme API 1.1, reviewed

layouts/default.liquid Selalu datang dari tema aktif dan memiliki dokumen publik lengkap. Eyivo pertama mencari tipe halaman yang diminta dalam tema itu, kemudian kembali ke theme-core/page-typesInti tidak pernah menyediakan tata letak atau aset, sehingga fallback halaman konten masih dibungkus dan styled oleh tema aktif.

3. theme.json

Muatan adalah baik sebuah kapabilitas deklarasi dan kontrak digunakan untuk menghasilkan bentuk App. Ini menjawab tiga pertanyaan: struktur halaman ada, yang daerah masing-masing struktur memiliki, dan apa komponen diperbolehkan untuk menyimpan. Tema bawaan secara eksplisit mendeklarasikan kesepuluh jenis halaman standar dan menyertakan berkas Liquid terkait. Tema khusus tetap dapat memakai templat fallback inti untuk jenis halaman yang tidak dideklarasikan.

{
  "name": "Acme Industrial",
  "version": "1.0.0",
  "eyivo_theme_api": "1.0",
  "settings": {
    "primary_color": { "type": "color" },
    "button_radius": { "type": "number" }
  },
  "page_types": {
    "home": {
      "areas": {
        "hero": {
          "allowed_components": ["eyivo:hero"],
          "min": 0,
          "max": 1
        },
        "main": {
          "allowed_components": ["eyivo:rich_text", "eyivo:image_text", "theme:featured_course"]
        }
      }
    },
    "page": { "areas": { "main": { "allowed_components": ["eyivo:rich_text"] } } }
  },
  "components": {
    "featured_course": {
      "variants": ["card", "compact"],
      "schema": {
        "heading": { "type": "text", "required": true, "translatable": true },
        "summary": { "type": "textarea", "translatable": true }
      }
    }
  }
}
KunciArtinyaContoh
keyLabel opsional untuk rujukan Anda sendiri. Eyivo memberi setiap tema yang diunggah ID-nya sendiri, jadi key tidak pernah menentukan tema mana yang menerima unggahan.acme-industrial
versionAnda versi rilis tema yang tidak dapat diubah (semantik versi).1.2.0
eyivo_theme_apiPublik Eyivo API kontrak dukungan paket Anda.1.0
areasbernama slot yang file Liquid halaman Anda render di tempat-tempat tetap.hero, main, bottom
allowed_componentsKomponen mana yang dapat ditambahkan ke satu area.["eyivo:hero"]
componentsTema aktif gubahan theme: definisi komponen. Dibagikan eyivo: definisi tinggal di theme-core.featured_course
min/maxBatas opsional pada jumlah daerah di daerah itu.max: 1

Page- tipe fallback: tipe built- dalam home, page, gallery, contact, products, product dan videosAbaikan salah satu dari mereka untuk menggunakan definisi dan file Cair dari theme-coreMenentukan tipe hanya ketika tema juga menyediakan pencocokan page-types/<type>.liquid override.

Penyunting menerima merged page-type API: definisi tema aktive- menggantikan definisi inti yang cocok, sedangkan setiap tipe diabaikan tetap tersedia dari inti.

4. Isi demo lengkap dalam demo.json

Setiap upload harus termasuk portabel, draft- saja demo.json fixture dan setidaknya satu screenshot ditangkap dengan fixture yang dimuat. Built -in tema menggunakan skema yang sama. Jangan sertakan basis data ID, domain penyewa, kredensial, atau kredensial-penyimpanan objektif.

{
  "schema_version": 2,
  "default_locale": "en",
  "label": "Northline Build Co.",
  "summary": "Thoughtful construction for the way life happens.",
  "media": {
    "media/hero.jpg": {
      "public_url": "https://cdn.eyivo.com/demo/hero.jpg",
      "mime_type": "image/jpeg",
      "original_name": "hero.jpg",
      "bytes": 184000,
      "width": 1600,
      "height": 900
    },
    "assets/images/team.jpg": {
      "mime_type": "image/jpeg",
      "original_name": "team.jpg"
    }
  },
  "company": { "display_name": "Northline Build Co.", "logo_asset": "media/hero.jpg" },
  "theme_settings": { "settings": { "header_cta_url": "/contact" } },
  "pages": [],
  "catalog": [],
  "galleries": [],
  "videos": []
}
KunciTujuan
mediaURL sumber publik dan metadata diketemukan oleh identifikasi aset portabel. Gunakan kembali identifier untuk hero_asset, cover_asset, media_asset, gallery- item asset, logo_asset, dan favicon_asset.
companyProfil perusahaan, tautan sosial, merek, aset logo / favicon opsional, dan terjemahan lokal.
theme_settingsPengaturan tema awal, dengan pilihan locale-keyed terjemahan.
pagesTipe, pengurutan, keadaan navigasi, SEO, pengaturan halaman, komponen, dan isi lokal-keyed.
catalogMasukan katalog dengan konten lokal -keyed dan sebuah opsional cover_asset.
galleriesMetadata galeri dan gambar item. Setiap butir galeri membutuhkan asset dan tidak kosong alt_text.
videosSebuah eksternal source_url atau media_asset, mode presentasi, dan lokal -keyed konten.

Setiap entri media memerlukan public_url dengan https pada host yang diizinkan (host media demo Eyivo cdn.eyivo.com atau images.pexels.com), atau file yang dikemas dalam tema di bawah assets/, dirujuk dengan path-nya dan tanpa public_url. Host lain, http, alamat IP, port lain, dan pengalihan ditolak dengan diagnostik unggahan demo_media_url. mime_type, width, dan height hanya petunjuk: Eyivo mendeteksi jenis sebenarnya dari isi file yang diunduh, yang harus berupa gambar atau video yang diizinkan dengan ukuran maksimal 20 MB.

Formulir demo memakai pengikatan formulir portabel, yang diselesaikan Eyivo secara terpisah untuk setiap situs yang mengimpor demo. Gambar demo yang diimpor menjadi referensi media biasa di situs itu; menghapusnya di sana tidak pernah menghapus aslinya yang dibagikan.

Halaman dan komponen

{
  "type": "home",
  "sort_order": 0,
  "navigation_visible": true,
  "hero_asset": "media/hero.jpg",
  "translations": {
    "en": { "slug": "home", "title": "Home", "meta_title": "Home | Northline" },
    "tr": { "slug": "ana-sayfa", "title": "Ana sayfa", "meta_title": "Ana sayfa | Northline" }
  },
  "components": [{
    "component_type": "eyivo:hero",
    "area": "hero",
    "position": 100,
    "variant": "split",
    "data": { "primary_url": "/contact" },
    "translations": {
      "en": { "heading": "Built for real life", "primary_label": "Contact us" },
      "tr": { "heading": "Gerçek yaşam için tasarlandı", "primary_label": "Bize ulaşın" }
    }
  }]
}

Tipe dan area komponen harus dideklarasikan dalam manifes tema aktif atau theme-core. Gunakan jalur relatif seperti /contact untuk tautan dalam situs yang sama. Demo beranda bawaan memakai gambar hero yang sudah ada sebagai latar selebar halaman, dengan lapisan agar teks terbaca dan tata teks responsif: immersive pada sebagian besar tema, serta centered bergambar pada Compact. Varian hero lainnya tetap memakai tata letaknya sendiri.

Bahasa demo dan fallback

Bahasa Inggris adalah bahasa dasar yang diperlukan: set default_locale ke en. Nilai yang diberikan dalam fixtures lama juga berarti bahasa Inggris. Setiap bahasa situs yang didukung lainnya adalah opsional; jangan salin teks Inggris ke lokal lain dan menyajikan sebagai terjemahan.

Menyediakan translations.en dan objek lokal opsional untuk menyalin perusahaan, pengaturan tema, halaman, komponen, produk, galeri, judul item dan teks alt, video, dan posting blog. Legacy unkeyed bahasa Inggris tetap didukung. Membuat memilih situs tersebut bahasa asli dan jatuh kembali ke bahasa Inggris untuk setiap bidang yang hilang. Array menggantikan seluruh array Inggris; eksplisit nilai-nilai kosong dipertahankan. Hanya bahasa situs yang dipilih diimpor, tanpa otomatis memungkinkan bahasa Inggris atau lokal lainnya.

Gunakan gambar sumber bahasa Inggris dalam link same-site dan entri menu portabel. Impor peta mereka ke selongsong terjemahan yang dipilih, termasuk link dalam dokumen teks dan blog kaya. Masukan menu dapat memasok eksplisit slugs dan labels Peta. Kehilangan overrides label kembali ke Inggris. URL eksternal tidak berubah.

{
  "company": {
    "translations": {
      "en": { "display_name": "Northline", "description": "Built around your needs." },
      "tr": { "display_name": "Northline", "description": "İhtiyaçlarınıza göre tasarlandı." }
    }
  },
  "theme_settings": {
    "settings": { "header_cta_url": "/contact" },
    "translations": {
      "en": { "header_cta_label": "Contact us" },
      "tr": { "header_cta_label": "Bize ulaşın" }
    }
  },
  "menus": {
    "footer": [{ "type": "page", "slug": "contact",
      "slugs": { "en": "contact", "tr": "iletisim" },
      "labels": { "en": "Contact us", "tr": "Bize ulaşın" }
    }]
  }
}

Impor dan keamanan media

Situs dashboard baru termasuk data demo secara baku dan segera menerbitkan bahasa yang dipilih; pemilik dapat memeriksa opsi ini. Memuat demo dari Branding di situs yang ada masih membuat draf dan simpan konten yang diterbitkan. App pusat menyalin gambar ke dalam pustaka media situs baru dan mengirimkan referensi melalui Internal APIMasters dan tema tidak pernah menerima tujuan - mandat penyimpanan. media.public_url.

Menyatakan cuplikan layar dalam theme.json.preview dengan data_source: "demo_data"Paket harus berisi setiap menyatakan preview gambar.

5. Tulis semua tata letak yang diperlukan tema Anda

Layout default memiliki seluruh dokumen HTML. Tidak ada apa pun di luar tema aktif yang menyediakan header, footer, stylesheet, atau struktur visualnya. Platform hanya menambahkan skripnya sendiri untuk formulir, verifikasi manusia, persetujuan, dan lencana Eyivo; skrip tema memerlukan Theme API 1.1.

<!doctype html>
<html lang="{{ locale.code }}" dir="{{ locale.direction }}">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  {% eyivo_head %}
  <link rel="stylesheet" href="{{ 'css/theme.css' | asset_url }}">
</head>
<body>
  <header class="site-header">
    <a href="{{ locale.home_url }}">{{ company.name }}</a>
    <nav>
      {% for item in navigation.main %}
        <a href="{{ item.url }}">{{ item.label }}</a>
      {% endfor %}
    </nav>
  </header>

  {{ content | raw }}
</body>
</html>

Sebuah berkas jenis pawai kemudian memutuskan persis di mana daerah dinamis muncul. Komponen area telah dirender HTML string, jadi masukkan mereka dengan | mentahNilai-nilai biasa yang melarikan diri secara default.

<main class="home-layout">
  <section class="home-layout__hero">{{ areas.hero | raw }}</section>
  <div class="home-layout__content">{{ areas.main | raw }}</div>
  <aside class="home-layout__footer-cta">{{ areas.bottom | raw }}</aside>
</main>

Menyewa komponen secara langsung

Seorang desainer dapat menempatkan komponen yang terdaftar langsung dalam sebuah layout atau jenis berkas. Penempatan ini tetap oleh tema dan tidak diurut ulang atau dihapus dalam panel. Berikan sebuah objek melalui data:, ruas skema individu, atau keduanya; ruas bernama menimpa kunci yang cocok dari data:.

{% eyivo_component "eyivo:cta",
  eyebrow: "Let’s talk",
  heading: page.title,
  text: company.description,
  button_label: "Contact us",
  button_url: routes.contact
%}

{% eyivo_component "theme:featured_course",
  data: page.settings.featured_course,
  variant: "compact"
%}

Tipe mesti berupa namespace literal yang dikutip. Rendering langsung memakai skema yang sama, varian, berkas komponen, dan normalisasi component objek sebagai sebuah instansi daerah. Berkas componen tidak dapat membuat komponen lain.

Aset: selalu gunakan {{ 'css / theme.css.' | asset _ url }}Eyivo melayani dari paket aktif sebagai /theme-assets/<theme>/css/theme.css; jangan hard- kode nama tema lain atau jalur sistem berkas.

Head, route and interface dictionaries

Setiap tata letak harus dirender {% eyivo_head %} Eyivo kemudian memiliki judul, deskripsi, robot, kanonikal, pantul, Grafik Terbuka dan struktur-data keluaran. Gunakan routes.home, routes.contact, routes.catalog, routes.gallery dan routes.videos bukan hardcode jalur publik. URL konfigurasi melalui | localized _ url begitu dikenal jalur internal mendapatkan prefiks lokal aktif sementara URL eksternal tetap tidak berubah.

{{ 'Menu' | t }}
{{ theme.settings.header_cta_url | localized_url }}

Buat opsional locales/<locale>.json berkas untuk interface labels diperkenalkan oleh tema. Urutan pencarian adalah core English, core locale, tema English, kemudian lokal tema. Label bersama dari theme-core Oleh karena itu bekerja tanpa menyalin berkas. Salinan bisnis milik dalam konten dapat diterjemahkan, bidang komponen, atau daerah pengaturan-tema - bukan kamus.

Berkas komponen gubahan

<article class="featured-course featured-course--{{ component.variant }}">
  <div class="featured-course__content">
    <h1>{{ component.data.heading }}</h1>
    {% if component.data.summary %}<p>{{ component.data.summary }}</p>{% endif %}
  </div>
</article>

Untuk bidang yang dapat diterjemahkan, Eyivo memilih lokal pengunjung sebelum rendering. component.data.heading nilai.

7. 6 Data Cair aman yang dapat Anda gunakan

Liquid menerima data biasa, normalisasi - bukan model Laravel atau basis data.

ObjekField yang bergunaPenggunaan khas
sitename, localeSet- level label dan lokal asli.
companyname, legal_name, description, address, phone, emailKepala, kaki dan informasi kontak.
pageid, type, title, slug, body, settingsIsi halaman generik dan pengaturan per-page.
seotitle, description, kanonikal / robot / Open Graph nilai ketika diberikanKepala dokumen.
navigation.mainSetiap butir memiliki label, url, activeMenu situs.
localecode, name, native_name, direction, is_default, home_url, availableBahasa dokumen, RTL arah, links rumah lokal dan pemilih bahasa.
routeshome, contact, catalog, gallery, videos, blogURL sistem yang benar; jangan pernah membuat prefix dalam Liquid.
blogtitle, url, categories, category, posts, post, paginationDaftar blog gratis, arsip kategori, dan halaman artikel. Posts mengekspos judul, ringkasan, URL, tanggal, kategori, dan media sampul saja. blog.post.body_html berisi artikel aman server-dihasilkan HTML dan harus menggunakan rawPersediaan pemujaan previous_url dan next_url.
theme.settingsPengaturan manifest AndaGunakan warna yang dikonfigurasi, spasi atau opsi desain.
products/productJudul terjemahan, URL, ringkasan dan tubuhJenis halaman / detail daftar produk.
galleriesJudul dan deskripsi diterjemahkanJenis halaman galeri.
videostitle, description, source_type, source_url, playback_url, mediaGunakan playback_url untuk berkas video yang diunggah dan source_url untuk video HTTP(S) eksternal, sesuai source_type. Gambar terlampir tidak pernah menjadi sumber video. Jangan gunakan berkas video itu sendiri sebagai gambar poster.
componentid, type, variant, dataDi dalam berkas komponen saja.

Contoh tata letak Locale-safe

<html lang="{{ locale.code }}" dir="{{ locale.direction }}">
<a href="{{ locale.home_url }}">{{ company.name }}</a>
{% if locale.available.size > 1 %}
  <nav aria-label="Language">
    {% for language in locale.available %}
      <a href="{{ language.url }}" lang="{{ language.code }}"
         {% if language.current %}aria-current="page"{% endif %}>
        {{ language.native_name }}
      </a>
    {% endfor %}
  </nav>
{% endif %}

Setiap isi bahasa juga terbuka label, direction, is_default, current, dan has_translationPersediaan Eyivo hanya setara terjemahan diterbitkan, sehingga tema harus menggunakan language.url daripada membangun /en atau awalan lainnya.

Contoh dari token settling-driven: style="--brand: {{ theme.settings.primary_color }}"Pengaturan pertama harus dideklarasikan di theme.json.

8. 7 Komponen: langsung dan dinamis

Komponen memiliki satu render kontrak dengan dua pilihan penempatan. Sebuah komponen langsung dikendalikan oleh perancang dalam tata letak atau tipe halaman. Sebuah komponen dinamis disimpan sebagai contoh area-dan dikendalikan melalui penyunting. Sinyalnya memiliki ID stabil, tipe naespace, daerah, posisi, varian opsional, data dan terjemahan. Posisi hanya memesan - bukan identitas.

Tipe ruas

text, textarea, richtext, number, boolean, select, url, email, image, video, file, color, icon, page, product dan repeater.

Namespace

eyivo: pemecahan dari theme-core/components, theme: menyelesaikan dari tema aktif, dan plugin: direserve untuk plugin masa depan. Gunakan tipe namespace yang tepat dalam sebuah daerah atau eyivo_component Tandai.

Komponen universal: set "universal": true pada sebuah definisi komponen untuk mengizinkannya dalam seluruh area dari tipe halaman yang kompatibel. Ini masih harus memiliki skema yang valid dan berkas Cair.

Tautan tindakan bersama menyesuaikan jalur internal yang dikenal dengan bahasa aktif sambil mempertahankan parameter kueri dan fragmen. Teks kaya mempertahankan pemformatan aman di dalam wadah editor bertingkat. Gambar galeri kosong diabaikan, gambar peta tanpa tujuan bukan tautan, dan label slide serta pencarian menggunakan bahasa antarmuka pengunjung.

9. CSS kustom situs dan kelas bagian

Pemilik dapat menambahkan CSS sendiri ke situs dan memberi nama kelas pada bagian (Desain → CSS kustom). Tulis tema agar hal ini berjalan baik:

  • Urutan pemuatan: CSS situs ditambahkan sebagai <style id="eyivo-custom-css"> tepat sebelum </head>, setelah semua stylesheet tema. Pertahankan </head> di layout Anda, dan jangan bergantung pada CSS Anda dimuat terakhir.
  • Kelas bagian: renderer menambahkan nama kelas bagian ke elemen pertama keluaran komponen, jadi beri setiap template komponen satu elemen akar. Nama-nama itu juga tersedia sebagai {{ component.css_class }} jika Anda ingin menempatkannya di tempat lain.
  • Pengait stabil: pertahankan kelas body.theme-{key} dan layout-{name} serta satu kelas akar yang stabil per komponen, agar CSS pemilik tetap berfungsi di seluruh versi Anda. Sebutkan setiap penggantian nama di catatan rilis versi.
  • Tema yang diunggah: juga mendapat CSS kustom situs. Semua versi dari satu tema yang diunggah berbagi satu stylesheet per situs, dan stylesheet itu dihapus saat versi terakhir tema di situs dipensiunkan atau dihapus.
  • Nama yang dicadangkan: awalan kelas eyivo- dan ID eyivo-custom-css milik platform.

10. Skrip tema (Theme API 1.1)

Tema dapat menyertakan JavaScript sendiri untuk menu, slider, tab, filter, dan fitur serupa. Skrip bersifat opsional: setiap tema tetap harus berfungsi tanpanya, dan paket Theme API 1.0 tetap berjalan seperti biasa tanpa skrip.

  • Deklarasikan: atur "eyivo_theme_api": "1.1" dan "capabilities": {"custom_javascript": true} di theme.json, lalu letakkan setiap file langsung di assets/js/. Paket dengan file .js tanpa deklarasi akan ditolak.
  • Muat: gunakan hanya <script src="{{ 'js/theme.js' | asset_url }}" defer></script> (atau type="module") untuk file dalam paket. Tag berjalan sesuai urutan kemunculannya.
  • Beberapa file: setiap file ditinjau dan diizinkan secara terpisah, sehingga import dan export tidak diizinkan. Bagikan kode melalui satu global, seperti window.AcmeTheme, dan muat file yang mendefinisikannya terlebih dahulu.
  • Batas: paling banyak 20 file, 100 KB per file dan total 300 KB, hanya teks UTF-8.
  • Ditolak dalam template: skrip inline, sumber skrip eksternal, atribut event handler on…=, URL javascript:, serta elemen <iframe>, <object>, <embed>, dan <base>.
  • Hanya kode yang dapat dibaca: unggah kode sumber, bukan kode yang diminifikasi, dikemas, atau dienkode. Bundler dapat menghasilkan keluaran tanpa minifikasi.
  • Status: versi baru berstatus Menunggu tinjauan sampai pemeriksaan selesai, lalu Disetujui atau Ditolak. Hanya versi yang disetujui yang dapat dipratinjau atau digunakan. Versi yang disetujui kemudian bisa Diblokir: situs web tetap memakai tema tanpa skripnya.
  • Tiga pemeriksaan otomatis, berurutan: kode yang dapat dibaca; aturan kode (tanpa eval, new Function, document.write, pengalihan halaman, window.open, cookie atau penyimpanan browser, WebAssembly, timer string, elemen script atau frame yang dibuat, atau nilai formulir yang dikirim melalui jaringan); dan tinjauan keamanan AI. Untuk tinjauan itu, skrip dan baris template yang memuatnya dikirim ke layanan AI. Temuan apa pun menolak versi tersebut, beserta file dan barisnya.

Lolos: tombol menu

(function () {
  document.querySelectorAll('[data-menu-toggle]').forEach(function (button) {
    button.addEventListener('click', function () {
      document.body.classList.toggle('menu-open');
    });
  });
})();

Ditolak: mengirim nilai formulir ke luar

form.addEventListener('submit', function () {
  fetch('/collect', { method: 'POST', body: form.elements.email.value });
});
  • Hanya pemilik: skrip yang disetujui hanya berjalan di situs web milik akun yang mengunggah tema, dan hanya selama platform dan pemilik situs web mengizinkannya.
  • Kebijakan keamanan: halaman yang menjalankan skrip tema hanya mengizinkan file yang telah ditinjau, dikunci dengan hash SHA-256-nya, dengan connect-src 'self', tanpa frame atau worker, dan tanpa eval. Mengubah file memerlukan versi baru. Gambar dan stylesheet masih dapat dimuat dari https:, sehingga tinjauan juga menolak data yang dikirim melalui URL gambar atau stylesheet.
  • Setelah disetujui: browser melaporkan upaya melanggar kebijakan. Laporan dari tiga pengunjung dalam 24 jam memblokir versi; laporan penyalahgunaan dari tiga pengunjung dalam 7 hari menonaktifkan skrip di situs web itu dan memeriksa ulang versi. Pemilik menerima email saat versi disetujui, ditolak, atau diblokir.
  • Fitur platform: skrip tidak boleh mengganti, membungkus, atau menyembunyikan formulir dan kolom tersembunyinya, verifikasi manusia, banner persetujuan, lencana Eyivo, atau bilah pemilik.

11. Katalog komponen tersedia

Ini 30 bersama eyivo: komponen bentuk lengkap perpustakaan v1 dan menyelesaikan dari theme-core. Sebuah tema mungkin tambahan menyatakan dan mengimplementasikan sendiri theme: Komponen.

Variabel: spliteditorialcenteredimmersive

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Ya Ya —
summary textarea Tidak Ya —
image_url url Tidak Tidak —
image_alt text Tidak Ya —
primary_label text Tidak Ya —
primary_url url Tidak Tidak —
secondary_label text Tidak Ya —
secondary_url url Tidak Tidak —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
body richtext Tidak Ya —

Variabel: image_leftimage_rightoverlap

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
body richtext Tidak Ya —
image_url url Tidak Tidak —
image_alt text Tidak Ya —
badge text Tidak Ya —
button_label text Tidak Ya —
button_url url Tidak Tidak —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
intro textarea Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
intro textarea Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
intro textarea Tidak Ya —
button_label text Tidak Ya —
button_url url Tidak Tidak —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
text textarea Tidak Ya —
submit_label text Tidak Ya —
form_binding select Tidak Tidak —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
heading text Tidak Ya —
text textarea Tidak Ya —
whatsapp_url url Tidak Tidak —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
address textarea Tidak Ya —
map_url url Tidak Tidak —
image_url url Tidak Tidak —
image_alt text Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
heading text Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
heading text Tidak Ya —
placeholder text Tidak Ya —
categories repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
summary textarea Tidak Ya —
video_url url Tidak Tidak —
poster_url url Tidak Tidak —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
price text Tidak Ya —
period text Tidak Ya —
features repeater Tidak Ya —
button_label text Tidak Ya —
button_url url Tidak Tidak —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
label text Tidak Ya —
heading text Tidak Ya —
body textarea Tidak Ya —
button_label text Tidak Ya —
button_url url Tidak Tidak —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

Komponen bersama eyivo:faq mempertahankan bidang dan markup yang sama di setiap tema. Setiap tema menampilkannya dengan tipografi, jarak, dan warna tema itu sendiri.

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
heading text Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
heading text Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
text textarea Tidak Ya —
button_label text Tidak Ya —
button_url url Tidak Tidak —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
heading text Tidak Ya —
items repeater Tidak Ya —

Variabel: kosong

RuasTipeDiperlukanDapat diterjemahkanOpsi
eyebrow text Tidak Ya —
heading text Tidak Ya —
intro textarea Tidak Ya —
items repeater Tidak Ya —

12. Bentuk dan riwayat pengajuan

Bentuk API 1 menyediakan tujuh prosesor yang disetujui. Tema memiliki tata letak dan gaya; plugin memiliki skema, validasi, dan alur kerja. Host menangani kegigihan, verifikasi, dan pemberitahuan.

Plugin sistemTipe formulir
eyivo/contactKontak contact
eyivo/quote-requestPermintaan Kutipan quote_request
eyivo/product-inquiryProses penyelidikan product_inquiry
eyivo/appointment-requestPermintaan pertemuan appointment
eyivo/course-applicationAplikasi kursus course_application
eyivo/reservation-requestPermintaan pemesanan reservation
eyivo/property-inquiryPenyelidikan properti property_inquiry

Satu bentuk, placements dapat digunakan kembali

Penyiapan membuat sebuah baku yang ditahan UUID per situs / plugin / type. Mengganti penempatan membuat identitas itu; membuat sebuah bentuk nama memberikan terpisah UUIDTema perubahan dan plugin memasang ulang riwayat. Tema menyatakan alias portabel; pemilihan penyunting menyimpan formulir tanpa meminta pelanggan untuk mengetik UUID.

{
  "plugins": ["eyivo/contact", "eyivo/quote-request"],
  "forms": {
    "contact": {"plugin":"eyivo/contact","type":"contact","schema_version":1,"instance":"default"},
    "quote": {"plugin":"eyivo/quote-request","type":"quote_request","schema_version":1,"instance":"default"}
  }
}

Gunakan forms.contact dalam template kontak dan component.form dalam bagian lead. Ganti formulir _ preset dengan format _ binding. Render diberikan field dan bimbingan, aksi, CSRF, signed form _ context dan verifikasi _ html. Hanya dideklarasikan presentasi overrides dan bidang tambahan diijinkan diterima; dibutuhkan validasi tidak dapat melemah.

forms.contact · component.form · form_binding · form.fields · form.action · form.csrf_token · form.context · form.verification_html

Dua tampilan inbox, satu rekaman

Inbox situs bersama dan setiap bentuk plugin sendiri daftar / detail halaman menampilkan catatan yang sama. Paket formulir membutuhkan Panel API 2 submisi- daftar / submission- komponen detail dan link menu datar. Panel API 1 tetap didukung. Viewing tidak menandai catatan yang dibaca; baca / archive / workflow menyatakan terpisah dan edits menggunakan record _ revisi. Plugin yang tidak aktif kehilangan menu / halaman, sedangkan inbox yang berbagi mempertahankan snapshot historis.

{"components":[{"type":"submission-list","form_type":"contact","detail_page":"submission"}]}
{"components":[{"type":"submission-detail","form_type":"contact","list_page":"submissions"}]}

Data dan perizinan pelanggan

Catatan formulir tetap dalam basis data konten yang diberikan dan berbagi paket max _ db _ bytes yang ada dengan konten lain. Tidak ada submission terpisah -count atau retention quota ditambahkan. Konfigurasi tetap dalam basis data master dengan batas dari 50 field, 32 KB dan tiga tingkat. Anggota dapat melihat; pemilik / pengelolaan perubahan ijin. Plugin tidak menerima akses basis data langsung, dan PHP/ Blade tidak pernah bergerak ke aplikasi.

Diverifikasi penyimpanan dan pemberitahuan

Host memvalidasi konteks yang ditandatangani, menyatakan jawaban dan dibutuhkan Verifikasi Manusia, kemudian melakukan catatan, penggunaan, dan pemberitahuan bekerja bersama. Percobaan identik dan pembayaran pulih selama 24 jam tanpa menabung dua kali. SMTP pengiriman berjalan sesudahnya dan mungkin mencoba lagi; kegagalan surel tidak membatalkan catatan tersimpan. Penerima formulir yang tidak diatur kembali ke email perusahaan; jika alamat tidak valid, pengajuan disimpan tanpa email.

Semua tema dikirim menggunakan kontrak ini. Kontak legacy POSTs kembali 410; kontekt- halaman GET link masih bekerja. Permintaan pendahuluan dan reservasi tidak mengkonfirmasi booking. Ketiga-partai formulir prosesor, file upload dan aksi eksternal sewenang-wenang tidak termasuk.

POST /__eyivo/forms/{UUID}/submissions
GET /__eyivo/forms/{UUID}/challenge

13. Navigasi sekunder dan sidebar

Daftarkan menu header, secondary, sidebar, footer, dan useful_links di theme.json sesuai kebutuhan. Tampilkan navigation.secondary di bilah utilitas dan navigation.sidebar di samping halaman biasa. Pemilik mengedit dan menerbitkan setiap menu melalui editor menu standar. Buat menu utama tetap singkat; di layar kecil sidebar harus pindah ke bawah konten halaman.

Sidebar adalah area tata letak, bukan komponen. Deklarasikan area sidebar pada setiap jenis halaman yang memakainya, dengan allowed_components (misalnya rich_text, announcement, download_list, dan contact_actions) dan max, lalu tampilkan areas.sidebar di dalam <aside> di samping navigation.sidebar:

{% if navigation.secondary.size > 0 %}
<nav aria-label="{{ 'Useful information' | t }}">
  {% for item in navigation.secondary %}
    <a href="{{ item.url }}"{% if item.active %} aria-current="page"{% endif %}>{{ item.label }}</a>
  {% endfor %}
</nav>
{% endif %}
<aside aria-label="{{ 'More information' | t }}">
  {% for item in navigation.sidebar %}
    <a href="{{ item.url }}">{{ item.label }}</a>
  {% endfor %}
  {{ areas.sidebar | raw }}
</aside>

15. Template halaman dan cadangan inti

Ada sepuluh jenis halaman standar: home, page, contact, products, product, gallery, videos, blog, blog_category, dan blog_post. Tema dapat menyediakan kesepuluhnya atau hanya sebagian; theme-core menyediakan template yang berfungsi untuk setiap jenis yang tidak dideklarasikan tema. Pertahankan nama area dan pengikatan formulir jenis halaman inti saat menggantinya, agar konten yang ada dan formulir terdaftar tetap berfungsi setelah tema diganti.

16. Hero halaman

Hero subhalaman memiliki dua bentuk. Tanpa gambar, gunakan banner ringkas dengan breadcrumb, eyebrow opsional, dan judul halaman. Dengan gambar, letakkan judul, breadcrumb, dan ringkasan di atas gambar dan lapisan kontras agar teks tetap terbaca di foto apa pun, dan cerminkan arah lapisan pada tata letak kanan-ke-kiri.

17. Gambar, galeri, dan video

Simpan gambar yang diunggah di dalam bingkai berbatas: gambar katalog mempertahankan proporsinya, dan foto detail boleh memenuhi bingkai dengan potongan tengah. Galeri dapat membuka gambar asli dalam dialog yang ditutup dengan Escape dan mengembalikan fokus ke tautan gambar; tanpa skrip, tautkan gambar asli agar terbuka di tab baru. Slider gambar sebaiknya mendukung sentuhan, tombol, keyboard, dan gerakan yang dikurangi.

18. Teks kaya dan aturan tampilan bersama

Komponen bersama eyivo:rich_text menerima isi bertanda editor maupun isi HTML lama. Keduanya melewati daftar izin pemformatan platform: paragraf, judul, daftar, dan tautan aman tampil sebagai konten, sedangkan skrip, event handler, dan tautan tidak aman dihapus. Kolom teks lain tetap di-escape. Tampilkan teks kaya dengan filter yang disediakan, bukan dengan penanganan HTML Anda sendiri.

19. Pembuka, area orientasi, dan halaman panjang

Jenis halaman dapat memadukan hero dengan area orientasi opsional untuk tautan cepat atau fakta penting; jika area itu kosong, pembuka sebaiknya memakai lebar penuh. Halaman editorial panjang perlu menjaga panjang baris yang mudah dibaca dan jarak judul yang jelas, serta dapat menempatkan bagian pendukung, seperti daftar periksa atau catatan, di samping artikel pada layar lebar dan sesudahnya pada layar kecil. Setiap tata letak harus tetap terbaca tanpa skrip.

20. Gerakan dan gerakan yang dikurangi

Gerakan dekoratif bersifat opsional. Hormati prefers-reduced-motion untuk transisi, slider, dan bagian beranimasi, serta jeda konten bergerak saat pengunjung mengarahkan kursor ke atasnya atau berfokus di dalamnya.

21. Daftar periksa tema lengkap

Tema lengkap menyediakan kesepuluh template halaman, menata semua komponen bersama eyivo:, mendukung setiap pengikatan formulir portabel melalui plugin formulir yang ada dan Verifikasi Manusia, serta berfungsi di desktop, seluler, dan tata letak kanan-ke-kiri. Filter katalog, tab, slider, dan menu lipat adalah peningkatan opsional di atas konten yang berfungsi tanpanya.

22. / Apa yang terjadi dari aktivasi template sampai penerbitan?

  1. Pasang / aktifkan templat. Eyivo memvalidasi paket, merekam kunci / versi dan mengekspos pengaturan dan komponen skema di App.
  2. Pilih tipe halaman. Eyivo menggunakan tema aktif pencocokan berkas Cair dan definisi daerah ketika ada, jika tidak cocok theme-core mundur.
  3. Tambahkan bagian yang diijinkan. App hanya menawarkan jenis terdaftar dalam allowed_componentsIni menyimpan teks, referensi media dan terjemahan terhadap komponen terpilih.
  4. Render aman. Eyivo menyelesaikan perusahaan / halaman /SEO/ data navigasi, merender disimpan komponen daerah, merender komponen langsung di mana desainer ditempatkan mereka, kemudian render aktif tipe halaman dan tata letak.
  5. Terbitkan. Pengunjung menerima Anda HTML dan CSS, tapi tidak ada kredensial database, model internal atau kode aplikasi.
  6. Perbarui dengan versi baru. Mengunggah ZIP di Tema kustom membuat tema baru. Untuk mengubah tema yang ada, buka tema itu, naikkan version di theme.json, lalu unggah versi baru. Setiap situs beralih saat Anda memakai versi baru sebagai draf lalu menerbitkannya; versi sebelumnya tetap tersedia untuk dikembalikan selama 30 hari.

23. Validasi dan kesalahan umum

Jika kau lihat...Periksa ini dulu
"Tidak didukung Eyivo Tema API versi "Set "eyivo_theme_api": "1.0".
Hilang galat tipe halaman / tata letak / komponenSetiap tipe halaman atau komponen dideklarasikan oleh tema membutuhkan pencocokan .liquid berkas. Tema aktif harus selalu menyediakan layouts/default.liquid; awet built-in tipe halaman jatuh kembali ke dalam inti.
Komponen tidak tersedia di penyuntingTipe namespace nya harus di daerah itu allowed_components daftar, atau definisi harus universal.
Komponen langsung tidak diketahuiGunakan kutipan eyivo: tipe dari katalog terbagi atau mendeklarasikan kecocokan theme: definisi dan berkas Cair dalam tema aktif.
Ruas ditolakMasukkan dalam skema komponen dan gunakan satu tipe ruas yang didukung. Gunakan translatable: true untuk teks lokal-spesifik.
Template muncul unstyledGunakan asset_url filter untuk CSS dan mengkonfirmasi berkas berada di bawah assets/.
Paket ditolak untuk sintaks yang tidak amanHapus PHP/ Blade, env, config, DB /HTTP panggilan dan sistem berkas akses. Liquid adalah presentation-saja.
Aturan skrip: custom_javascript_declaration, script_file, script_tag, script_import, script_sizeIkuti Skrip tema. Temuan tinjauan muncul di halaman versi beserta file dan barisnya; perbaiki lalu unggah versi baru.

24. FAQ

Bisakah pelanggan membuat tata letak baru atau memindahkan pahlawan di bawah kaki?

No Mereka dapat mengubah konten yang disetujui dan memesan komponen yang disetujui dalam area.

Dapatkah seorang desainer menggunakan komponen tanpa area yang dapat disunting?

Ya, gunakan. eyivo_component dalam tata letak atau tipe halaman. Gunakan area ketika pemilik situs harus mengontrol instansi komponen dan perintah.

Harus tema mengimplementasi setiap tipe halaman?

Dukungan blog diperlukan untuk setiap tema. Jenis built-dalam blog, blog_category, dan blog_post dapat menggunakan definisi yang cocok dan berkas Cair dari theme-core, di dalam tata letak tema aktif. Nyatakan sebuah tipe hanya ketika memberikan berkas penimpa yang cocok. Paket tema yang ada tetap kompatibel. Penggunaan rute Blog /blog, /blog/category/{slug}, dan /blog/{slug}, dengan awalan lokal Eyivo dimana dibutuhkan. Simpan eyivo_head untuk metadata aman, gaya blog responsif, dan kartu gambar berbatasan.

Dapatkah query tema halaman, panggil API atau membaca variabel lingkungan?

Tidak Data sengaja dilewatkan sebagai objek yang aman.

Bagaimana cara merilis pembaruan?

Publikasikan versi tema semantik baru. Jangan diam-diam bermutasi rilis yang diterbitkan; situs harus pindah ke versi baru secara eksplisit.

Dimana seharusnya gambar hidup?

Gunakan media Eyivo URL dalam data komponen, atau sebuah aset paket direferensikan melalui asset_url. Jangan gunakan jalur sistem berkas server secara acak.

25. Catatan perubahan

  • 31 Oktober 2026. Theme API 1.1: tema dapat menyertakan JavaScript yang ditinjau di assets/js/ dengan kapabilitas custom_javascript. Versi baru ditinjau otomatis dan menampilkan Menunggu tinjauan, Disetujui, Ditolak, atau Diblokir. Paket Theme API 1.0 tidak berubah.
  • 31 Oktober 2026. Pemilik dapat menambahkan CSS kustom situs yang dimuat setelah stylesheet Anda, dan memberi nama kelas pada bagian, yang ditambahkan ke elemen pertama setiap komponen dan tersedia sebagai {{ component.css_class }}. Lihat CSS kustom situs dan kelas bagian.
  • 31 Oktober 2026. Media demo dalam demo.json harus memakai host https yang diizinkan (cdn.eyivo.com atau images.pexels.com) atau file yang dikemas di bawah assets/. Eyivo mendeteksi jenis setiap file dari isinya. Ini perbaikan keamanan; Theme API tetap 1.0.
  • 30 Oktober 2026. Eyivo memberi setiap tema yang diunggah ID-nya sendiri, dan key di theme.json bersifat opsional. Unggah perubahan sebagai versi baru dari halaman tema. Repositori contoh menyimpan tema di folder sample-theme/, yang Anda kompres lalu unggah. Contoh paket tidak lagi menampilkan assets/js/, karena unggahan Theme API 1.0 tidak boleh berisi file JavaScript.