/ionic-package-hooks

Cordova hooks that you can run in Ionic Package

Primary LanguageJavaScriptOtherNOASSERTION

Ionic Package Hooks

The hooks in this repository are hooks that you can run during the packaging of your app. Ionic Package uses Cordova, so these are just standard Cordova Hooks that we've selected/accepted.

To run these hooks in Ionic Package, just put a <hook /> tag in your config.xml, like this:

<hook type="after_prepare" src="package-hooks/add_platform_class.js" />

That's it! Package will run that hook on the server.

Re-enable HTTP for iOS9

This is probably one of the main reasons you're here, so this is how you do that:

  • Put the following in your config.xml:

    <hook type="after_prepare" src="package-hooks/ios9_allow_http.sh" />

  • That's it, actually. Run ionic package build ios ... again and your binary should allow HTTP.

Use these hooks locally

You don't need to download these hooks locally, but local builds won't work without them.

To use them locally, you can clone the repository within your Ionic App, and Cordova will pick up your <hook /> tags within config.xml automatically.

Within your app directory:

$ git clone https://github.com/ionic-team/ionic-package-hooks.git ./package-hooks
$ cd package-hooks
$ npm install

Hooks

These are the available hooks. The type is what you put in type of your <hook /> tag, unless you want to run the hook at a different stage (not recommended). If you want a hook to run before another one, reorder the <hook /> tags.

add_platform_class.js
  • author: Ionic
  • usage: <hook type="after_prepare" src="package-hooks/add_platform_class.js" />
  • function: Adds the various platform CSS classes to the <body> tag of your app such as platform-android, platform-ios, etc.
android_custom_resources.js
  • author: @schmoofer/@dwieeb
  • usage: <hook type="after_prepare" src="package-hooks/android_custom_resources.js" />
  • function: Copies assets in resources/android/custom/ to all drawable-* directories in platforms/android/res. Asset filenames must only use a-z, 0-9, and underscores. Example application: Allows for custom icons to be used in Android notifications (action buttons and the notification icon) when using the Push plugin.
android_custom_values.js
  • author: @Just-Ghali
  • usage: <hook type="after_prepare" src="package-hooks/android_custom_values.js" />
  • function: Copies style files from resources/android/values/ to platforms/android/res/values. Adds the ability to add custom themes.xml and styles.xml to the res/values folder in the android build.
  • credit: @schmoofer/@dwieeb
android_ignore_translation_errors.js
  • author: @carson-drake
  • usage: <hook type="after_prepare" src="package-hooks/android_ignore_translation_errors.js" />
  • function: After Android prepare, add build-extras.gradle to android platform root to allow android-lint to ignore the translation errors introduced when including phonegap-plugin-barcodescanner.
copy_google_services_config_files.js
  • author: @rolandjitsu
  • usage: <hook type="after_prepare" src="package-hooks/copy_google_services_config_files.js" />
  • function: Copy google-services.json and/or GoogleService-Info.plist to Android/iOS platform specific required destinations to enable usage of cordova-plugin-firebase when the build is done in Ionic Cloud. Use @ionic/app-scripts to copy the config files in www at build time (this hook will search for them at that location).
ios9_allow_http.sh
  • author: @daruwanov
  • usage: <hook type="after_prepare" src="package-hooks/ios9_allow_http.sh" />
  • function: Sets NSAllowsArbitraryLoads to true in your .plist file, allowing all regular HTTP connections in your app again for iOS9.
ios9_allow_native_fb.sh
  • author: @carson-drake
  • usage: <hook type="after_prepare" src="package-hooks/ios9_allow_native_fb.sh" />
  • function: Deletes LSApplicationQueriesSchemes and then reads the necessary listings to communicate with Facebook natively to the .plist file, allowing login and other features to occur natively rather than in safari.
  • credit: @mablack
ios9_allow_native_whatsapp.sh
  • author: @alongendler
  • usage: <hook type="after_prepare" src="package-hooks/ios9_allow_native_whatsapp.sh" />
  • function: Adds LSApplicationQueriesSchemes if needed and then adds the required key to communicate with whatsapp natively to the .plist file, allowing to query the presence of WhatsApp on device using canOpenURL.
  • credit: @mablack, @carson-drake
ios_disable_bitcode.js
  • author: @akofman
  • usage: <hook type="after_prepare" src="package-hooks/ios_disable_bitcode.js" />
  • function: Sets ENABLE_BITCODE to NO to fix iOS builds that stopped working after phonegap-plugin-push was updated to 1.5.x.
ios_remove_armv7s.js
  • author: Ionic
  • usage: <hook type="after_prepare" src="package-hooks/ios_remove_armv7s.js" />
  • function: Remove the armv7s architecture from the build process, which causes various build errors, especially with cordova-plugin-facebook4.
iosrtc-swift-support.js
  • author: Iñaki Baz Castillo at eFace2Face, inc.
  • usage: <hook type="after_platform_add" src="package-hooks/iosrtc-swift-support.js" />
  • function: Adds swift support by adding universal objective c bridge to project.

Contributing

See CONTRIBUTING.md for details.