Dokumentation

Anpassa Sidekick

Last update: Tue Mar 05 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Du kan anpassa sidbrytaren för ditt projekt. Du kan lägga till en /tools/sidekick/config.json konfigurationsfil till ditt projekts GitHub-databas:

<script src=“https://gist.github.com/rofe/491772e7e3f706cb4aca5f9f6451e516.js”></script>

Information om alla tillgängliga konfigurationsalternativ finns i Sidekick API-dokumentation eller config schema. Här är några grunder att komma igång:

Plugins

  • id och title är obligatoriska. title visas på plugin-programknappen. Du kan ange lokaliserade titlar i en titleI18n object
  • Hur du anger plugin-åtgärden beror på avsikten:
    • Om du bara vill öppna en URL i ett nytt fönster kan du använda url -egenskap. Du kan också öppna den på en palett genom att ange isPalette till true.
      /tools/sidekick/config.json:
      <script src=“https://gist.github.com/rofe/8a0961575d434fb86ce4fdda3bea60f5.js”></script>
  • Kodkörningen måste göras i sidans sammanhang (stöds inte i redigerings- och administratörsmiljön). Du kan använda event för att ange namnet på en händelse som ska utlösas när plugin-knappen klickas. Du kan sedan reagera på den i programkoden som i följande exempel:
    /tools/sidekick/config.json:
    <script src=“https://gist.github.com/rofe/e5f215be84acc51ffe87002408d4e107.js”></script>
    <script src=“https://gist.github.com/rofe/4d38d9ec8253cc2f4bec3dad757c33fc.js”></script>
  • The environments array anger var plugin-programmet ska visas (dev, edit, admin, preview, live eller prod). Du kan också definiera exclude_paths och include_paths arrayer för att begränsa plug-ins utseende baserat på banan.
  • isContainer gör om ett plugin-program till en listruta. Du kan sedan lägga till andra plugin-program till den genom att ange dess ID i containerId -egenskap.
  • override kan anges till true för att utöka ett befintligt plugin-program.

Specialvyer

  • path och viewer är obligatoriska. Du kan också ange en title som visas längst upp och du kan ange lokaliserade titlar i en titleI18n objekt:
    <script src=“https://gist.github.com/rofe/9170d068a7b3ab727a8745774e430aca.js”></script>
  • Lägg till en HTML-fil enligt konfigurationen i path till projektets GitHub-databas:
    <script src=“https://gist.github.com/rofe/0de48b1696c7334f6fdbd9f63993aad2.js”></script>
  • Lägg till en valfri CSS-fil i samma katalog och en JS-fil med din logik:
    <script src=“https://gist.github.com/rofe/8357f72407683cf4bd27c5d364b71af7.js”></script>
  • Öppna en projekt-URL som matchar den konfigurerade path och klicka på sidosparken för att se hur ditt visningsprogram fungerar.
recommendation-more-help
10a6ce9d-c5c5-48d9-8ce1-9797d2f0f3ec