feat(bridge): add position parameter in web_app_setup_secondary_butto…

…n. Export SecondaryButtonPosition type
Telegram-Mini-Apps · Oct 1, 2024 · 705e047 · 705e047
1 parent 71aef19
commit 705e047
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 8 deletions.
diff --git a/packages/bridge/src/methods/types/methods.ts b/packages/bridge/src/methods/types/methods.ts
@@ -11,6 +11,7 @@ import {
   OpenLinkBrowser,
   BottomBarColor,
   BackgroundColor,
+  SecondaryButtonPosition,
 } from './misc.js';
 
 interface ButtonParams {
@@ -20,30 +21,30 @@ interface ButtonParams {
    */
   has_shine_effect?: boolean;
   /**
-   * Should the Main Button be displayed.
+   * Should the button be displayed.
    */
   is_visible?: boolean;
   /**
-   * Should the Main Button be enabled.
+   * Should the button be enabled.
    */
   is_active?: boolean;
   /**
-   * Should loader inside the Main Button be displayed. Use this property in case, some
+   * Should loader inside the button be displayed. Use this property in case, some
    * operation takes time. This loader will make user notified about it.
    */
   is_progress_visible?: boolean;
   /**
-   * Text inside the Main Button.
+   * Text inside the button.
    */
   text?: string;
   /**
-   * The Main Button background color in `#RRGGBB` format.
+   * The button background color in `#RRGGBB` format.
    */
-  color?: string;
+  color?: RGB;
   /**
    * The Main Button text color in `#RRGGBB` format.
    */
-  text_color?: string;
+  text_color?: RGB;
 }
 
 /**
@@ -368,7 +369,19 @@ export interface Methods {
    * Updates the secondary button settings.
    * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-setup-secondary-button
    */
-  web_app_setup_secondary_button: CreateParams<ButtonParams>;
+  web_app_setup_secondary_button: CreateParams<ButtonParams & {
+    /**
+     * Position of the secondary button. It applies only if both the main and secondary buttons
+     * are visible.
+     *
+     * Supported values:
+     * - `left`, displayed to the left of the main button.
+     * - `right`, displayed to the right of the main button.
+     * - `top`, displayed above the main button.
+     * - `bottom`, displayed below the main button.
+     */
+    position?: SecondaryButtonPosition;
+  }>;
   /**
    * Updates the current state of the Settings Button.
    * @since v6.10

diff --git a/packages/bridge/src/methods/types/misc.ts b/packages/bridge/src/methods/types/misc.ts
@@ -17,6 +17,11 @@ export type BackgroundColor = KnownColorKey | RGB;
  */
 export type BottomBarColor = KnownColorKey | 'bottom_bar_bg_color' | RGB;
 
+/**
+ * Position of the secondary button related to the main one.
+ */
+export type SecondaryButtonPosition = 'left' | 'right' | 'top' | 'bottom';
+
 /**
  * Values expected by the `web_app_open_link.try_browser` option.
  */