npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sveltekit-device-detector

v1.1.3

Published

Detect device type and render your component according to it

Downloads

279

Readme

sveltekit-device-detector

npm

Detect device, and render view according to the detected device type.

When to use this library

This library uses a technique called user agent sniffing to detect device information. That means it works by examining the User Agent string given by a browser and comparing it to a list of browser and device names it knows about. This technique works, but has drawbacks and may or may not be the right approach, depending on what you're trying to achieve. If you need to detect a specific browser type (e.g. Chrome, Safari, Internet Explorer) or specific category of device (e.g. all iPods), this library can do that.

Flags

You can use these flags to detect the device type.

interface DeviceType {
	isMobile: boolean;
	isBrowser: boolean;
	isAndroid: boolean;
	isIOS: boolean;
	isSmartTV: boolean;
	isConsole: boolean;
	isWearable: boolean;
	isEmbedded: boolean;
	isMobileSafari: boolean;
	isChromium: boolean;
	isTablet: boolean;
	isDesktop: boolean;
	isWinPhone: boolean;
	isChrome: boolean;
	isFirefox: boolean;
	isSafari: boolean;
	isOpera: boolean;
	isIE: boolean;
	osVersion: string;
	fullBrowserVersion: string;
	browserVersion: string;
	mobileVendor: string;
	mobileModel: string;
	getUA: string;
	isEdge: boolean;
	isYandex: boolean;
	isIOS13: boolean;
	isIPad13: boolean;
	isIPhone13: boolean;
	isIPod13: boolean;
	isElectron: boolean;
	isEdgeChromium: boolean;
	isLegacyEdge: boolean;
	isWindows: boolean;
	isMacOs: boolean;
	isMIUI: boolean;
	isSamsungBrowser: boolean;
	isWebView: boolean;
	isCrawler: boolean;
}

interface DevicePayload extends DeviceType {
	browserMajorVersion?: string;
	browserFullVersion?: string;
	browserName?: string;
	engineName?: string;
	engineVersion?: string;
	osName?: string;
	osVersion: string;
	userAgent?: string;
	vendor?: string;
	model?: string;
	os?: string;
	ua?: string;
}

Installation

To install, you can use npm or yarn:

npm install sveltekit-device-detector --save

or

yarn add sveltekit-device-detector

Update your app.d.ts file to look something like:

import type { DevicePayload } from 'sveltekit-device-detector/dist/types';
// See https://kit.svelte.dev/docs#typescript
// for information about these interfaces
declare namespace App {
	interface Locals {
		deviceType: DevicePayload;
	}

	interface PageData {
		deviceType: DevicePayload;
	}

	interface Platform {}

	interface PrivateEnv {}

	interface PublicEnv {}
}

Create a +layout.server.js file at the root and returning the DeviceType from there.

/** @type {import('./$types').LayoutServerLoad} */
export const load = ({ locals }) => {
	return {
		deviceType: locals.deviceType
	};
};

You'll now have access to the deviceType data by using $page.data.deviceType or via the parent function from other +page.server.js load functions.

<script>
	import { page } from '$app/stores';
	$: deviceType = $page.data.deviceType;
</script>

Initializing

src/hooks.server.ts

import { handleDeviecDetector } from 'sveltekit-device-detector';

// You can do it like this, without passing a own handle function
export const handle = handleDeviecDetector({});

// Or pass your handle function as second argument to handleDeviecDetector

export const handle = handleSession({}, ({ event, resolve }) => {
	// event.locals is populated with the deviceType `event.locals.deviceType`

	// Do anything you want here
	return resolve(event);
});

In case you're using sequence(), do this

const deviceDetector = handleDeviecDetector({});
export const handle = sequence(deviceDetector, ({ resolve, event }) => {
	// event.locals is populated with the deviceType `event.locals.deviceType`
	// Do anything you want here
	return resolve(event);
});