Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

begiresh

Package Overview
Dependencies
Maintainers
2
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

begiresh

A mobile application smart banner for Iranian markets

  • 1.3.2
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
13
increased by333.33%
Maintainers
2
Weekly downloads
 
Created
Source

Begiresh

Begiresh is a lightweight none-jQuery, smart application banner targeting major Iranian android markets. A live demo can be seen at roozame.com.

For having more information, demo and how-to instructions, visit inb-co.github.io/Begiresh (currently only Farsi).

This project was inspired by jquery.smartbanner.

Installation

Yarn

$ yarn add begiresh

NPM

$ npm install --save begiresh

CDN

https://unpkg.com/begiresh/dist/begiresh.js

https://unpkg.com/begiresh/dist/begiresh.css

Usage

  1. Add Meta and Begiresh.css to <head> of your HTML:
  <head>

    <title>Roozame.com</title>

    <meta name="cafe-bazaar-app" content="app-id=com.inb.roozame"> <!-- And/Or -->
    <meta name="google-play-app" content="app-id=com.inb.roozame"> <!-- And/Or -->
    <meta name="myket-app" content="app-id=com.inb.roozame">

    <link rel="android-touch-icon" href="roozame-android-icon.png"> <!-- And/Or -->
    <link rel="apple-touch-icon" href="roozame-apple-touch-icon.png"> <!-- And/Or -->
    <link rel="apple-touch-icon-precomposed" href="roozame-apple-touch-icon-precomposed.png">

    <link rel="stylesheet" href="path/to/begiresh.css" media="screen" title="Begiresh Smart Banner CSS">

    <!-- Other Stuff Here -->
  </head>
  1. Add Begiresh.js to <body> of your HTML:
  <body>

    <!-- Other Stuff Here -->

    <script src="path/to/begiresh.js"></script>
  </body>
  1. Create a new banner from your JS:
  new Begiresh({
    title: 'روزامه Roozame',
    author: 'ایده نگاران بینا'
  });

Options

you can use these options for having a customized smart banner:

OptionDefault ValueTypeDescriptionRequired
titlenonestringTitle of appYep
authornonestringAuthor of appYep
priceرایگانstringPrice of appNop
iconSite's FaviconstringAddress to app's iconNop
daysHidden15numberNumber of days banner hides after dismissNop
daysReminder90numberNumber of days banner hides after downloadNop
storeLangUser's LanguagestringUser and store's language (on ISO Language Codes)Nop
storegooglePlaystringStore's IDNop
buttonبگیرشstringText on download buttonNop
themedefaultstringBegiresh ThemeNop
forcefalsebooleanForce to have banner on every platform and ignoring cookiesNop
onDownloadnonefunctionrun a function after downloadNop
onClosenonefunctionrun a function after dismissNop

These stores are currently supported:

NameID on InstanceID on Meta
Googel Play (گوگل‌پلی)googlePlaygoogle-play-app
Cafe Bazaar (کافه‌بازار)cafeBazaarcafe-bazaar-app
Myket (مایکت)myketmyket-app

Development

To customize and develop the project you could use following npm commands:

To build whole project
  npm run build
To bundle and minify JS
  npm run build-js
To transpile LESS and parse CSS
  npm run build-css

License

Begiresh is a free and open project developed and maintained by Javid Izadfar at INB Co., published under MIT license.

Keywords

FAQs

Package last updated on 13 Sep 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc