@mobiloud/ml-css-injector

MobiLoud CSS Injector

CSS injector with regex functionality

Features

CSS Injector features:

• Inject CSS in your site globally selectively for your pages with regex
• os method available: its a function that can be called to get the current browser OS, useful for triggering external functions'. It returns a string containing "android" | "ios" | "windows" | "desktop"
• isMobile, isCanvas exposed for filtering
• Code written in Typescript and minified/bundled with Vite

📖 How to use

CSS Injector can be used importing the JS code via CDN or as a module using NPM

🚀 With CDN

<script src="https://cdn.jsdelivr.net/npm/@mobiloud/ml-css-injector/dist/ml-css-injector.min.js"></script>
<script>
    (function(){
      addStyle({css: `a{color: red !important}`});
      addStyle({css: `a{color: yellow !important}`, regex: /\/\?param$/});
      addStyle({css: `a{color: green !important}`, regex: /.*/, name: "Global Styles"});
      addStyle({css: `a{color: green !important}`, regex: /.*/, name: "Global Styles", logs: true});
    })()
  </script>

Configuration options:

// accepts any styles as a string

let style = `
a{
  color: green;
  background-color: yellow
} 
.className {
  font-size: 2rem
}
`
// accepts regex enclosed within slashes
let regex = /.*/

// accepts string
let name = "Style name"

//boolean --> Prints logs in console for debugging

addStyle({css: string, regex: string, name: string, logs: boolean});
addStyle({css: `color: red !important`}) // if no regex passed, the styles applies to every page

Recipe for multiple styles:

// accepts any styles as a string

let styles = [
  {
    css: `
          a{
            color: green;
            background-color: yellow
          } 
          `,
    regex: /.*/,
    name: "Global Styles"
  },
  {
    css: `
          .cart{
            color: green;
            background-color: yellow
          } 
          `,
    regex: /.*\/cart/,
    name: "Cart page"
  },
  {
    css: "div.login{display: none}",
    regex: /.*\/login/,
    name: "Login page"
  }
]
// accepts regex enclosed within slashes

styles.forEach(e => { 
    addStyle({
      css: e.css,
      regex: e.regex,
      name: e.name,
      logs: true
    })
} )

Methods

deviceData.os // returns current os "android" | "ios" | "windows" | "desktop"
deviceData.isCanvas // returns true or false
deviceData.isMobile // returns true or false

Development

• npm run build produces a production version into /dist folder
• npm run dev runs dev version and starts a dev server

Testing the Injector

You will definitely want to test the CSS Injector once you deploy them to your website, to make sure that everything works and looks as you want.

Running these tests on real mobile devices can get overwhelming, so we recommend that you run your tests on your desktop browser.

To do this, you will need to emulate a mobile device by adjusting your browser’s user agent. We recommend using the following Chrome extension to do this: User Agent Switcher and Manager

Once you have installed the extension, set it up as follows:

Step 1

Select “Chrome” as the browser and “Android” as the platform if you want to test the Android version of the Button, or “Safari” and “iOS” in case you want to test the iOS version:

Step 2

Select one of the options that will appear, any will work:

Step 3

Click “Apply” to make sure the user agent is properly set up on your browser:

Step 4

You can now press “F5” while viewing your website to refresh the browser window with the updated user agent.

Reset

If you want to revert the changes to the user agent, as some websites might start behaving differently after doing so, you can click the “Reset” button:

License

Copyright (c) MobiLoud