Skip to content

Latest commit

 

History

History
84 lines (54 loc) · 3.11 KB

README.md

File metadata and controls

84 lines (54 loc) · 3.11 KB
Raw

svelte-system-info

determines name and version of underlying browser and operating system (not only for Svelte)

NPM users: please consider the Github README for the latest description of this package (as updating the docs would otherwise always require a new NPM package version)

Just a small note: if you like this module and plan to use it, consider "starring" this repository (you will find the "Star" button on the top right of this page), so that I know which of my repositories to take most care of.

Installation

svelte-system-info may be used as an ECMAScript module (ESM), a CommonJS or AMD module or from a global variable.

You may either install the package into your build environment using NPM with the command

npm install svelte-system-info

or load the plain script file directly

<script src="https://unpkg.com/svelte-system-info"></script>

Access

How to access the package depends on the type of module you prefer

  • ESM (or Svelte): import System from 'svelte-system-info'
  • CommonJS: const System = require('svelte-system-info')
  • AMD: require(['svelte-system-info'], (System) => {...})

Alternatively, you may access the global variable System directly.

Usage within Svelte

For Svelte, it is recommended to import the package in a module context:

<script context="module">
  import Device from 'svelte-system-info'
</script>

<script>
  console.log('BrowserName',    System.BrowserName)
  console.log('BrowserVersion', System.BrowserVersion)
  console.log('OSName',         System.OSName)
  console.log('OSVersion',      System.OSVersion)
</script>

Usage as ECMAscript, CommonJS or AMD Module (or as a global Variable)

Let's assume that you already "required" or "imported" (or simply loaded) the module according to your local environment. In that case, you may use it as follows:

console.log('BrowserName',    System.BrowserName)
console.log('BrowserVersion', System.BrowserVersion)
console.log('OSName',         System.OSName)
console.log('OSVersion',      System.OSVersion)

Example

An example is available on the Svelte REPL - feel free to play with it!

Build Instructions

You may easily build this package yourself.

Just install NPM according to the instructions for your platform and follow these steps:

  1. either clone this repository using git or download a ZIP archive with its contents to your disk and unpack it there
  2. open a shell and navigate to the root directory of this repository
  3. run npm install in order to install the complete build environment
  4. execute npm run build to create a new build

You may also look into the author's build-configuration-study for a general description of his build environment.

License

MIT License