Editor add-on user interfaces
Editor add-ons
enable user interaction through customized menus, dialogs, and
sidebars. The following links provide information building these types of
interfaces.
Add-on menus are created using
Apps Script's base Ui service.
Menus items provide initial starting points for using your add-on,
but you must design them to take into account the add-on
authorization lifecycle.
Sidebars and dialogs are created using
Apps Script's HTML service. This service
lets you define the interface structure and appearence using HTML and CSS.
See Create and serve HTML for more details.
- You can also set up client-server communication
calls so that user actions in the interface result in actions taken on the
Google servers where the editor file resides, or vice versa.
- Apps Script also provides a template syntax
to make building dynamic interfaces easier.
When building HTML interfaces for Editor add-ons, you should use the
Editor add-on CSS package to help your add-on
look and feel like the Google Workspace editors
they extend.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-13 UTC.
[null,null,["Last updated 2025-02-13 UTC."],[[["Editor add-ons enhance user interaction with custom menus, dialogs, and sidebars, built using Apps Script's UI and HTML services."],["Add-on menus initiate add-on usage and should be designed considering the add-on authorization lifecycle."],["Sidebars and dialogs, created with HTML service, allow for defining the add-on's interface structure and appearance using HTML, CSS, and client-server communication for dynamic interactions."],["The Editor add-on CSS package ensures visual consistency with Google Workspace editors."]]],["Editor add-ons allow user interaction via custom menus, dialogs, and sidebars. Menus, built with the Ui service, serve as starting points, requiring design consideration for the add-on authorization lifecycle. Sidebars and dialogs, created using the HTML service, utilize HTML and CSS for interface design. Client-server communication enables actions on the server based on user interface interactions. The editor add-on CSS package maintains a consistent look and feel with Google Workspace editors. Dynamic interface creation is supported via a template syntax.\n"]]
