0.0.1 • Published 4 years ago

ionic-device-bars v0.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

Ionic Device Bars

An Ionic 4 Angular module to view & zoom on images and photos without any additional dependencies.

Demo

Installation

npm install ionic-device-bars --save

Usage

Script tag

  • Put a script tag similar to this <script src='https://unpkg.com/ionic-device-bars@0.0.1/dist/ionic-device-bars.js'></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

Node Modules

  • Run npm install ionic-device-bars --save
  • Put a script tag similar to this <script src='node_modules/ionic-device-bars/dist/ionic-device-bars.js'></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

Workspace

Local Development

To start developing the ionic-device-bars web component using Stencil, clone this repo to a new directory:

git clone https://github.com/SimonGolms/ionic-device-bars.git ionic-device-bars
cd ionic-device-bars
git remote rm origin
npm install
npm start

Build

To build ionic-device-bars for production, run:

npm run build

Run Tests

npm test

Release & Publishing

Run npm run release to create a new build & release with release-it. This bumps the version of projects/ngx-ionic-image-viewer/package.json, uses conventional-changelog to update CHANGELOG.md, commits package.json and CHANGELOG.md and tags a new release. The new release gets published to GitHub and npm automatically.

Manual Publishing

After building your library with npm run build, go to the dist folder cd dist and run npm publish.

Further Help

Check out the Stencil docs here.

Committing

Run npx git-cz to generate a valid commit message. It’s easy to forget about the commit convention so to be consistent use commitizen to generate our commits and husky to manage a Git commit-msg hook to validate the commit message. Further information: How to automate versioning and publication of an npm package

Author

Simon Golms

Contributing

Contributions, issues and feature requests are welcome!Feel free to check issues page.

Show Your Support

Give a ⭐️ if this project helped you!

License

Copyright © 2020 Simon Golms. This project is MIT licensed.