Browser Utilities API reference for browser-specific utility functions globe API Reference
Categories

Browser Utilities

The Browser utilities provide functions for common tasks in browser environments, such as copying text, handling keyboard events, and fetching text content.

Functions

copyText

function copyText(text)

Copies the provided text to the clipboard.

Parameters

NameTypeDescription
textstringThe text to copy to the clipboard

Example

import { copyText } from '@semantic-ui/utils';


copyText('Hello, world!');
console.log('Text copied to clipboard');

Browser Support This function uses the modern navigator.clipboard.writeText API. Ensure compatibility with your target browsers or provide a fallback for older browsers.

getKeyFromEvent

function getKeyFromEvent(event)

Extracts a standardized key representation from a keyboard event.

Parameters

NameTypeDescription
eventKeyboardEventThe keyboard event object

Returns

A string representing the key pressed, including any modifier keys (e.g., “ctrl+a”).

Example

import { getKeyFromEvent } from '@semantic-ui/utils';


document.addEventListener('keydown', (event) => {
  const key = getKeyFromEvent(event);
  console.log(`Key pressed: ${key}`);
});

Modifier Keys This function handles modifier keys (Ctrl, Alt, Shift, Meta) and combines them with the pressed key. It also normalizes some key names for consistency.

getText

async function getText(src)

Fetches text content from a given URL.

Parameters

NameTypeDescription
srcstringThe URL to fetch the text from

Returns

A Promise that resolves with the fetched text content.

Example

import { defineComponent } from '@semantic-ui/core';
import { getText } from '@semantic-ui/utils';


const template = await getText('/templates/component.html');
const css = await getText('/templates/component.css');


defineComponent({
  template,
  css
});

Usage Note This can be used on the server to load static assets like templates or css

function openLink(url, { newWindow = false, target, event } = {})

Opens a URL, optionally in a new window.

Parameters

NameTypeDescription
urlstringThe URL to open
optionsobjectOptional configuration
Options
NameTypeDefaultDescription
newWindowbooleanfalseWhether to open in a new window
targetstringnullTarget attribute for the link
eventEventnullEvent object to prevent default behavior

Example

import { openLink } from '@semantic-ui/utils';


// Open in current window
openLink('https://example.com');


// Open in new window
openLink('https://example.com', { newWindow: true });


// Prevent default event behavior
openLink('https://example.com', { event: clickEvent });

getJSON

async function getJSON(src)

Fetches and parses JSON content from a URL.

Parameters

NameTypeDescription
srcstringThe URL to fetch from

Returns

A Promise that resolves with the parsed JSON content.

Example

import { getJSON } from '@semantic-ui/utils';


const data = await getJSON('https://example.com/data.json');
console.log(data);

getIPAddress

async function getIPAddress({ type = 'public', timeout = 5000, waitAfterLastIP = 50 } = {})

Retrieves the user’s IP address using WebRTC ICE gathering.

Parameters

NameTypeDescription
optionsobjectOptional configuration
Options
NameTypeDefaultDescription
typestring’public’Type of IP to retrieve: ‘local’, ‘public’, or ‘all’
timeoutnumber5000Timeout in milliseconds
waitAfterLastIPnumber50Milliseconds to wait after last IP before resolving (for local/all types)

Returns

A Promise that resolves to:

  • A single IP address string when type is ‘public’
  • An array of IP address strings when type is ‘local’ or ‘all’

Example

import { getIPAddress } from '@semantic-ui/utils';


// Get public IP address (default)
const publicIP = await getIPAddress();
console.log('Public IP:', publicIP); // '203.0.113.45'


// Get local IP addresses
const localIPs = await getIPAddress({ type: 'local' });
console.log('Local IPs:', localIPs); // ['192.168.1.100', '10.0.0.5']


// Get all IP addresses
const allIPs = await getIPAddress({ type: 'all' });
console.log('All IPs:', allIPs); // ['192.168.1.100', '10.0.0.5', '203.0.113.45']

Browser Support This function requires WebRTC support and only works in browser environments. It uses STUN servers to detect public IP addresses.
Previous
Arrays
Next
Cloning