Okna i paski boczne w przypadku dodatków do edytora

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

W przypadku większości dodatków do edycji głównymi interfejsami dodatków są okna i panele boczne. Oba te elementy można w pełni dostosowywać za pomocą standardowych kodów HTML i CSS, a Ty możesz korzystać z modelu komunikacji między serwerem a Apps Script, aby uruchamiać funkcje Apps Script, gdy użytkownik korzysta z paska bocznego lub okna. Dodatek może definiować wiele pasków bocznych i okien, ale może wyświetlać tylko jeden naraz.

Jeśli nie chcesz, aby użytkownik wchodził w interakcję z edytorem, dopóki nie dokona on wyboru w interfejsie dodatku, użyj okna dialogowego. W przeciwnym razie użyj paska bocznego.

Okna

Okna to panele okien pokrywające główną zawartość edytora. Okna Apps Script są modalne. Po otwarciu użytkownik nie może wchodzić w interakcję z innymi elementami interfejsu edytora. Możesz dostosować zawartość i rozmiar okien.

Okna dodatków tworzy się w taki sam sposób jak okna niestandardowe Apps Script. Ogólna procedura jest taka:

  1. Utwórz plik projektu skryptu określający strukturę kodu JavaScript i okna oraz kod JavaScript po stronie klienta. Podczas definiowania okna zapoznaj się ze wskazówkami dotyczącymi dodatków w edytorze.
  2. W kodzie po stronie serwera, w którym chcesz otworzyć okno, wywołaj obiekt HtmlService.createHtmlOutputFromFile(filename), aby utworzyć obiekt HtmlOutput reprezentujący okno. Możesz też użyć szablonu HTML, aby wywołać szablon HtmlService.createTemplateFromFile(filename), a potem przekonwertować go na obiekt HtmlOutput.
  3. Wywołaj Ui.showModalDialog(htmlOutput, dialogTitle), aby wyświetlić okno z tym obiektem: HtmlOutput.

Okna nie zawieszają skryptu po stronie serwera, gdy są otwarte. JavaScript po stronie klienta może wykonywać asynchroniczne wywołania po stronie serwera za pomocą google.script.run() i powiązanych funkcji obsługi. Więcej informacji znajdziesz w artykule na temat komunikacji między serwerami.

Okna otwierania plików

Okna otwierania plików to gotowe okna, które umożliwiają użytkownikom wybieranie plików z Dysku Google. Możesz dodać okno z otwartymi plikami do dodatku bez konieczności jego projektowania, ale wymaga to dodatkowej konfiguracji. Aby włączyć interfejs Google Selecter API, musisz też mieć dostęp do projektu Cloud Platform.

Szczegółowe informacje znajdziesz w artykule Okna otwierania plików.

paski boczne to panele wyświetlane po prawej stronie interfejsu edytora i stanowią najczęściej spotykany typ interfejsu dodatku. W przeciwieństwie do okien dialogowych możesz nadal korzystać z innych elementów interfejsu edytora, gdy pasek boczny jest otwarty. Paski boczne mają stałą szerokość, ale możesz dostosować ich treść.

Pasek boczny dodatku jest tworzony w taki sam sposób jak niestandardowe paski boczne w Apps Script. Ogólna procedura jest taka:

  1. Utwórz plik projektu skryptu, który określa strukturę kodu HTML, kod CSS i zachowanie JavaScriptu po stronie klienta. Definiując pasek boczny, zapoznaj się ze wskazówkami dotyczącymi dodatków w edytorze.
  2. W kodzie po stronie serwera, w którym ma się otwierać pasek boczny, wywołaj HtmlService.createHtmlOutputFromFile(filename), aby utworzyć obiekt HtmlOutput reprezentujący pasek boczny. Możesz też użyć szablonu HTML, aby wywołać szablon HtmlService.createTemplateFromFile(filename), a potem przekonwertować go na obiekt HtmlOutput.

  3. Wywołaj Ui.showSidebar(htmlOutput), aby wyświetlić pasek boczny za pomocą tego elementu: HtmlOutput.

Pasek boczny nie zawiesza zawieszenia skryptu po stronie serwera. JavaScript po stronie klienta może wykonywać asynchroniczne wywołania po stronie serwera za pomocą google.script.run() i powiązanych funkcji obsługi. Więcej informacji znajdziesz w artykule na temat komunikacji między serwerami.