React-SmartBanner
Rewrite Smart App Banner in React.js.
Demo & Examples
Live demo: patw0929.github.io/react-smartbanner
To build the examples locally, run:
npm installnpm start
or
yarnyarn start
Installation
The easiest way to use react-smartbanner is to install it from NPM and include it in your own React build process (using Webpack, etc).
You can also use the standalone build by including dist/main.js
in your page. If you use this, make sure you have already included React, and it is available as a global variable.
npm install react-smartbanner --save
or
yarn add react-smartbanner
Compatibility
react-smartbanner version | React version |
---|---|
4.x.x+ |
^16.0.0 |
3.x.x |
^15.0.0 |
Usage
Remember to add following meta tags in your HTML page: (Use Facebook app as example)
And React-SmartBanner component usage:
;;;; ReactDOM;
Properties
Please see the Demo Page
src
and the build process)
Development (NOTE: The source code for the component is in src
. A UMD bundle is also built to dist
, which can be included without the need for any build system.
To build, watch and serve the examples (which will also watch the component source), run npm start
.
If you want to build to the bundle file to dist/
folder, please run:
npm run build
or
yarn run build
Contributing
To contribute to react-smartbanner, clone this repo locally and commit your code on a separate branch. Please write tests for your code, and run the linter before opening a pull-request:
npm testnpm run lint
or
yarn testyarn run lint
Based on
License
MIT
Copyright (c) 2015-2019 patw.