Documentación

Personalización del Sidekick

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

Puede personalizar la barra de tareas del proyecto. Puede añadir un /tools/sidekick/config.json Archivo de configuración al repositorio de GitHub del proyecto:

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

Para ver todas las opciones de configuración disponibles, consulte la Documentación de API de Sidekick o el esquema de configuración. A continuación se indican algunos aspectos básicos para empezar:

Plugins

  • id y title son obligatorios. title se mostrará en el botón del complemento. Puede proporcionar títulos localizados en una titleI18n objeto
  • La forma de especificar la acción del complemento depende de la intención:
    • Para abrir una dirección URL en una nueva ventana, utilice el icono url propiedad. Si lo desea, puede abrirlo en una paleta estableciendo isPalette hasta true.
      /tools/sidekick/config.json:
      <script src=“https://gist.github.com/rofe/8a0961575d434fb86ce4fdda3bea60f5.js”></script>
  • La ejecución del código debe realizarse en el contexto de la página (no se admite en el entorno de edición y administración). Puede usar el complemento event para especificar el nombre de un evento que se activará cuando se haga clic en el botón del complemento. A continuación, puede reaccionar en el código de la aplicación como en el siguiente ejemplo:
    /tools/sidekick/config.json:
    <script src=“https://gist.github.com/rofe/e5f215be84acc51ffe87002408d4e107.js”></script>
    <script src=“https://gist.github.com/rofe/4d38d9ec8253cc2f4bec3dad757c33fc.js”></script>
  • El environments matriz especifica dónde debe aparecer el complemento (dev, edit, admin, preview, live o prod). También puede definir lo siguiente exclude_paths y include_paths matrices para reducir el aspecto del complemento en función de la ruta.
  • isContainer convierte un complemento en una lista desplegable. A continuación, puede agregarle otros complementos especificando su ID en la containerId propiedad.
  • override se puede establecer en true para ampliar un complemento existente.

Vistas especiales

  • path y viewer son obligatorios. Si lo desea, puede especificar un title que se mostrarán en la parte superior y puede proporcionar títulos localizados en una titleI18n objeto:
    <script src=“https://gist.github.com/rofe/9170d068a7b3ab727a8745774e430aca.js”></script>
  • Añada un archivo de HTML como se ha configurado en path al repositorio de GitHub de su proyecto:
    <script src=“https://gist.github.com/rofe/0de48b1696c7334f6fdbd9f63993aad2.js”></script>
  • Agregue un archivo CSS opcional en el mismo directorio y un archivo JS con su lógica:
    <script src=“https://gist.github.com/rofe/8357f72407683cf4bd27c5d364b71af7.js”></script>
  • Abra una dirección URL de proyecto que coincida con el path y haga clic en la barra de tareas para ver a su espectador en acción.
recommendation-more-help
10a6ce9d-c5c5-48d9-8ce1-9797d2f0f3ec