Utils ​

Implements functionality that doesn't require state and can't be categorized.

Initialization ​

The component constructor accepts the Telegram Mini Apps version, a function to generate a request identifier, and an optional function to call Telegram Mini Apps methods.

import { Utils } from '@tma.js/sdk';

const utils = new Utils(
  '6.10',
  () => Math.random().toString(),
  postEvent,
);

import { Utils } from '@tma.js/sdk';

const utils = new Utils(
  '6.10',
  () => Math.random().toString(),
  postEvent,
);

Links ​

openLink ​

MiniApp class is capable of opening links of different types. For example, it can open a link in an external browser not closing current Mini App, using method openLink:

utils.openLink('https://google.com');

utils.openLink('https://google.com');

openTelegramLink ​

In case, developer would like to open a link related to Telegram (starting with https://t.me) he could utilize such method as openTelegramLink. In this case Telegram application will handle such link on its own side:

utils.openTelegramLink('https://t.me/heyqbnk');

utils.openTelegramLink('https://t.me/heyqbnk');

In this case, Telegram application will open the group with name heyqbnk.

Clipboard ​

Developers are allowed to read the text from the clipboard using the readTextFromClipboard method.

This method reads text from the clipboard and returns a string or null. Null is returned in cases:

• The value in the clipboard is not text.
• Access to the clipboard is not allowed.

utils.readTextFromClipboard().then((data) => {
  console.log('Clipboard data:', data);
  // Output: string or null
});

utils.readTextFromClipboard().then((data) => {
  console.log('Clipboard data:', data);
  // Output: string or null
});

Methods support ​

List of methods, which could be used in supports component instance method:

• readTextFromClipboard

utils.supports('readTextFromClipboard');

utils.supports('readTextFromClipboard');

Method parameters support ​

List of method parameters, which could be used in supportsParam component instance method:

• openLink.tryInstantView

utils.supportsParam('openLink.tryInstantView');

utils.supportsParam('openLink.tryInstantView');