superbig/craft3-mobiledetect

Use Mobile_Detect for detecting mobile devices (including tablets)

2.0.0 2022-10-03 21:09 UTC

Requires

• craftcms/cms: ^4.0.0
• mobiledetect/mobiledetectlib: ^2.8

MIT

• Superbig

• cms
• mobiledetect
• Craft
• craftcms
• craft-plugin

README

Use Mobile_Detect for detecting mobile devices (including tablets)

Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later.

Installation

To install the plugin, follow these instructions.

1. Open your terminal and go to your Craft project:

    cd /path/to/project
   

2. Then tell Composer to load the plugin:

    composer require superbig/craft3-mobiledetect
   

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for MobileDetect.

MobileDetect Overview

fairly complete wrapper for the Mobile_Detect library by @serbanghita.**

Using MobileDetect

The plugin exposes most of Mobile_Detect's methods, and can be used in your Twig:

{{ craft.mobileDetect.isMobile ? 'I am mobile.' : 'I am not mobile.' }}

...or as a PHP service:

<?php
$isMobile = MobileDetect::$plugin->mobileDetect->isMobile();

Methods/usage

Device detection

isMobile

Detects all mobile devices, both phones and tablets

isTablet
isPhone

Mobile OS detection

isiOS
isAndroidOS
isBlackBerryOS
isPalmOS
isSymbianOS
isWindowsMobileOS
isWindowsPhoneOS

Other methods

is(key)

Test for anything, e.g. is('iphone')

match(pattern)

Test using regular expressions

version(component)

Get the version of a component, e.g. version('iPhone')

mobileGrade

Get browser grade (e.g. "A")

getScriptVersion

Prints the MobileDetect library's version

getUserAgent
setUserAgent(userAgent)
getMobileHeaders
getHttpHeaders
setHttpHeaders(httpHeaders)
getCfHeaders
setCfHeaders(cfHeaders)

Brought to you by Superbig