refactor: Slides image and UI dialog samples into individual files

Author: jpoehnelt

.github/scripts/biome-gs.ts

@@ -88,8 +88,7 @@ async function main() {
     }
 
     // 2. Run Biome
-    const biomeArgs =
-      command === "format" ? "check --write ." : "check .";
+    const biomeArgs = command === "format" ? "check --write ." : "check .";
     console.log(`Running biome ${biomeArgs}...`);
     try {
       const { stdout, stderr } = await execAsync(

GEMINI.md

@@ -7,7 +7,7 @@ This guide outlines best practices for developing Google Apps Script projects, f
 * For new sample directories, ensure the top-level folder is included in the [`test.yaml`](.github/workflows/test.yaml) GitHub workflow's matrix configuration.
 * Do not move or delete snippet tags: `[END apps_script_... ]` or `[END apps_script_... ]`.
 * Keep code within snippet tags self-contained. Avoid depending on helper functions defined outside the snippet tags if the snippet is intended to be copied and pasted.
-
+* Avoid function name collisions (e.g., multiple `onOpen` or `main` functions) by placing separate samples in their own directories or files. Do not append suffixes like `_2`, `_3` to function names. For variables, replace collisions with a more descriptive name.
 
 ## Tools
 

slides/imageSlides/add_image/add_image.gs

@@ -0,0 +1,27 @@
+/**
+ * Copyright Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// [START apps_script_slides_image_add_image]
+/**
+ * Adds an image to a presentation at a given slide index.
+ * @param {string} imageUrl The image URL
+ * @param {number} index The slide index to add the image to
+ */
+function addImageSlide(imageUrl, index) {
+  const slide = deck.appendSlide(SlidesApp.PredefinedLayout.BLANK);
+  const image = slide.insertImage(imageUrl);
+}
+// [END apps_script_slides_image_add_image]

slides/imageSlides/add_image_slide/add_image_slide.gs

@@ -0,0 +1,35 @@
+/**
+ * Copyright Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// [START apps_script_slides_image_add_image_slide]
+/**
+ * Creates a single slide using the image from the given link;
+ * used directly by foreach(), hence the parameters are fixed.
+ * @param {string} imageUrl A String object representing an image URL
+ * @param {number} index The index into the array; unused (req'd by forEach)
+ */
+function addImageSlide(imageUrl, index) {
+  const slide = deck.appendSlide(SlidesApp.PredefinedLayout.BLANK);
+  const image = slide.insertImage(imageUrl);
+  const imgWidth = image.getWidth();
+  const imgHeight = image.getHeight();
+  const pageWidth = deck.getPageWidth();
+  const pageHeight = deck.getPageHeight();
+  const newX = pageWidth / 2 - imgWidth / 2;
+  const newY = pageHeight / 2 - imgHeight / 2;
+  image.setLeft(newX).setTop(newY);
+}
+// [END apps_script_slides_image_add_image_slide]

slides/imageSlides/create/create.gs

@@ -0,0 +1,20 @@
+/**
+ * Copyright Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// [START apps_script_slides_image_create]
+const NAME = "My favorite images";
+const deck = SlidesApp.create(NAME);
+// [END apps_script_slides_image_create]

slides/imageSlides/full/full.gs

@@ -0,0 +1,61 @@
+/**
+ * Copyright Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// [START apps_script_slides_image_full_script]
+const NAME = "My favorite images";
+const presentation = SlidesApp.create(NAME);
+
+/**
+ * Creates a single slide using the image from the given link;
+ * used directly by foreach(), hence the parameters are fixed.
+ * @param {string} imageUrl A String object representing an image URL
+ * @param {number} index The index into the array; unused (req'd by forEach)
+ */
+function addImageSlide(imageUrl, index) {
+  const slide = presentation.appendSlide(SlidesApp.PredefinedLayout.BLANK);
+  const image = slide.insertImage(imageUrl);
+  const imgWidth = image.getWidth();
+  const imgHeight = image.getHeight();
+  const pageWidth = presentation.getPageWidth();
+  const pageHeight = presentation.getPageHeight();
+  const newX = pageWidth / 2 - imgWidth / 2;
+  const newY = pageHeight / 2 - imgHeight / 2;
+  image.setLeft(newX).setTop(newY);
+}
+
+/**
+ * The driver application features an array of image URLs, setting of the
+ * main title & subtitle, and creation of individual slides for each image.
+ */
+function main() {
+  const images = [
+    "http://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png",
+    "http://www.google.com/services/images/phone-animation-results_2x.png",
+    "http://www.google.com/services/images/section-work-card-img_2x.jpg",
+    "http://gsuite.google.com/img/icons/product-lockup.png",
+    "http://gsuite.google.com/img/home-hero_2x.jpg",
+  ];
+  const [title, subtitle] = presentation.getSlides()[0].getPageElements();
+  title.asShape().getText().setText(NAME);
+  subtitle
+    .asShape()
+    .getText()
+    .setText("Google Apps Script\nSlides Service demo");
+  for (const imageUrl of images) {
+    addImageSlide(imageUrl);
+  }
+}
+// [END apps_script_slides_image_full_script]

slides/imageSlides/imageSlides.gs

@@ -0,0 +1,39 @@
+/**
+ * Copyright Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// [START apps_script_slides_image_main]
+/**
+ * Adds images to a slides presentation.
+ */
+function main() {
+  const images = [
+    "https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png",
+    "http://www.google.com/services/images/phone-animation-results_2x.png",
+    "http://www.google.com/services/images/section-work-card-img_2x.jpg",
+    "http://gsuite.google.com/img/icons/product-lockup.png",
+    "http://gsuite.google.com/img/home-hero_2x.jpg",
+  ];
+  const [title, subtitle] = deck.getSlides()[0].getPageElements();
+  title.asShape().getText().setText(NAME);
+  subtitle
+    .asShape()
+    .getText()
+    .setText("Google Apps Script\nSlides Service demo");
+  for (const imageUrl of images) {
+    addImageSlide(imageUrl);
+  }
+}
+// [END apps_script_slides_image_main]

slides/imageSlides/main/main.gs

@@ -0,0 +1,49 @@
+/**
+ * Copyright Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// [START apps_script_alert_dialogs]
+/**
+ * Creates a custom menu when a user opens a Spreadsheet.
+ */
+function onOpen() {
+  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
+    .createMenu("Custom Menu")
+    .addItem("Show alert", "showAlert")
+    .addToUi();
+}
+
+/**
+ * Shows an alert dialog.
+ */
+function showAlert() {
+  const ui = SpreadsheetApp.getUi(); // Same variations.
+
+  const result = ui.alert(
+    "Please confirm",
+    "Are you sure you want to continue?",
+    ui.ButtonSet.YES_NO,
+  );
+
+  // Process the user's response.
+  if (result === ui.Button.YES) {
+    // User clicked "Yes".
+    ui.alert("Confirmation received.");
+  } else {
+    // User clicked "No" or X in the title bar.
+    ui.alert("Permission denied.");
+  }
+}
+// [END apps_script_alert_dialogs]