{"_id":"@awesome-cordova-library/statusbar","_rev":"1-cd565f673dc442cf68d394f6ff2eeb24","name":"@awesome-cordova-library/statusbar","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@awesome-cordova-library/statusbar","version":"1.0.0","description":"The StatusBar object provides some functions to customize the iOS and Android StatusBar.","main":"lib/index.js","types":"lib/index.d.ts","keywords":["cordova","capacitor","ionic","javascript","mobile","status bar"],"publishConfig":{"access":"public"},"author":{"name":"Jordan AZOULAY","email":"jazoulay@joazco.com","url":"https://github.com/joazco"},"license":"SEE LICENSE IN LICENSE","repository":{"type":"git","url":"git://github.com/joazco/awesome-cordova-library.git"},"bugs":{"url":"https://github.com/joazco/awesome-cordova-library/issues"},"homepage":"https://github.com/joazco/awesome-cordova-library","devDependencies":{"@types/jest":"^27.5.1","@types/react":"~17.0.21","jest":"^28.1.0","prettier":"^2.6.2","ts-jest":"^28.0.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.7.2"},"scripts":{"build":"rm -rf lib/ && tsc","build-yalc":"npm run build; yalc publish --push --private","test":"jest --config jestconfig.json","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json","prepublish":"npm run format; npm run lint; npm test; npm run build"},"directories":{"lib":"lib"},"dependencies":{},"_id":"@awesome-cordova-library/statusbar@1.0.0","_nodeVersion":"14.15.1","_npmVersion":"8.5.2","dist":{"integrity":"sha512-qYBiAb779iR/kVHcvVN7qv9Izs7/856QwET3aMccM5rznA/2UWNXncEVmftq4CtOMm7FnS/QNC0mGIu/i68B1Q==","shasum":"ec5956a4f5338aeb8c68780d46c73f446f217163","tarball":"https://registry.npmjs.org/@awesome-cordova-library/statusbar/-/statusbar-1.0.0.tgz","fileCount":7,"unpackedSize":18485,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDjsUnC1z9IfNj7EGmHKlfqkwmcHzWACko/kCc0tPADFAIgJAaE71Ea1kgA4dwP5PKdRIpkrd397CsUR9o7F/YN8ag="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJil41eACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoJyg//WxsLpHTR23pR+huhjX3NV9isumHSbWmPKUdds5jVSK6scUrT\r\nwESkYfqjm/iExI9GvOhD3mj+86b36R02U0gomqnP1eQzmdRQ4v5gMRwMcufZ\r\n38vDEqw0KoU4S049nqDWLlMr0fjf3BkiVekv6Aul1SX0VXc3vtAjyALeWyo4\r\n21bJ1D0Je7q3+VappFmpk7zMyyIBw6humJIHIAZRkTYHBp6OXrKy5DUuo1Fy\r\nJHeSw3VNrXOUrlp3vP9wH/+ZI+hj2zvTELX3hJIjzjNhzGzp/259hs8rUihQ\r\nz/U4OAu+X0BB+mKU8gbBkeTvcy22/5DLB+vvcM2/8IxWdpQoY8uKKW283t01\r\nDB8mUrIDfN02MwljjrA6nXtqDnj5PqiulitGWekTtR+N1cUP+dtUfn4Hwgyg\r\n1YEZK3bnS/gGbzG+sbONoaYUVTpA6gVfeZXwm2cxk7kmUetBaPDowbWWRyU9\r\n43fYKCtuz3KzdThSu3t7uLNCP7hBiGOiBQxKQpkkKi4YtAsSuIAT1tcuTY2w\r\n812JZR85sFCX8SxX7tQrwRDUGAM5y4/+7IP+c7bwyRWXjZuCztONv7lyDBXF\r\nOvPOwdLJD8x6nX8LaHZ6FPgKk3lq5jpjQoUe7RPyw1IgRx/yKjyNV9AEStu6\r\nOSDwGtqgkOwj37moQNqgswKBPqOTUA1m9gU=\r\n=APoi\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"joazco","email":"jazoulay@joazco.com"},"maintainers":[{"name":"joazco","email":"jazoulay@joazco.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/statusbar_1.0.0_1654099293988_0.49967165718491957"},"_hasShrinkwrap":false},"1.0.1":{"name":"@awesome-cordova-library/statusbar","version":"1.0.1","description":"The StatusBar object provides some functions to customize the iOS and Android StatusBar.","main":"lib/index.js","types":"lib/index.d.ts","keywords":["cordova","capacitor","ionic","javascript","mobile","status bar"],"publishConfig":{"access":"public"},"author":{"name":"Jordan AZOULAY","email":"jazoulay@joazco.com","url":"https://github.com/joazco"},"license":"SEE LICENSE IN LICENSE","repository":{"type":"git","url":"git://github.com/joazco/awesome-cordova-library.git"},"bugs":{"url":"https://github.com/joazco/awesome-cordova-library/issues"},"homepage":"https://github.com/joazco/awesome-cordova-library","devDependencies":{"@types/jest":"^27.5.1","@types/react":"~17.0.21","jest":"^28.1.0","prettier":"^2.6.2","ts-jest":"^28.0.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.7.2"},"scripts":{"build":"rm -rf lib/ && tsc","build-yalc":"npm run build; yalc publish --push --private","test":"jest --config jestconfig.json","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json","prepublish":"npm run format; npm run lint; npm test; npm run build"},"directories":{"lib":"lib"},"dependencies":{},"gitHead":"2a2b9cf007a870056251632315547e6a651d26a0","_id":"@awesome-cordova-library/statusbar@1.0.1","_nodeVersion":"16.20.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-Izdd65SNUvQlb/6dc985uCZs1XqsFFSb/FRt/dSuk56xNX8/zOf4qZRNLNc1Di+h/5OLO7Pv0J4zBEabmXKuOg==","shasum":"7b9f72eae0c72f0989a027deb1d68746de743737","tarball":"https://registry.npmjs.org/@awesome-cordova-library/statusbar/-/statusbar-1.0.1.tgz","fileCount":7,"unpackedSize":18827,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDBv3dZIJY4gnnSSB27gkVWwBXRE7GOATrX1LsE/Xv0IAIhAOT/fzV79mIsYJ9qMsYkOWr5kk4I8fA5+MJgVQTRU/MB"}]},"_npmUser":{"name":"joazco","email":"jazoulay@joazco.com"},"maintainers":[{"name":"joazco","email":"jazoulay@joazco.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/statusbar_1.0.1_1694499531331_0.8490491663862949"},"_hasShrinkwrap":false}},"time":{"created":"2022-06-01T16:01:33.925Z","1.0.0":"2022-06-01T16:01:34.213Z","modified":"2023-09-12T06:18:51.693Z","1.0.1":"2023-09-12T06:18:51.500Z"},"maintainers":[{"name":"joazco","email":"jazoulay@joazco.com"}],"description":"The StatusBar object provides some functions to customize the iOS and Android StatusBar.","homepage":"https://github.com/joazco/awesome-cordova-library","keywords":["cordova","capacitor","ionic","javascript","mobile","status bar"],"repository":{"type":"git","url":"git://github.com/joazco/awesome-cordova-library.git"},"author":{"name":"Jordan AZOULAY","email":"jazoulay@joazco.com","url":"https://github.com/joazco"},"bugs":{"url":"https://github.com/joazco/awesome-cordova-library/issues"},"license":"SEE LICENSE IN LICENSE","readme":"---\nid: plugin-statusbar\ntitle: Statusbar\ntags:\n  - cordova\n  - capacitor\n  - ionic\n  - javascript\n  - typescript\n  - plugin\n  - mobile\n  - statusbar\n---\n\n# Statusbar\n\nThe StatusBar object provides some functions to customize the iOS and Android StatusBar.\n\n[Online documentation](https://awesomecordovalibrary.com)\n\n[Cordova documentation](https://cordova.apache.org/docs/en/11.x/reference/cordova-plugin-statusbar/index.html)\n\n## Installation\n\n### Cordova\n\n```sh\ncordova plugin add cordova-plugin-statusbar\nnpm install @awesome-cordova-library/statusbar\n```\n\n### Capacitor / Ionic\n\n```bash\nnpm install cordova-plugin-statusbar\nnpm install @awesome-cordova-library/statusbar\nnpx cap sync\n```\n\n## Vanilla\n\n### Declaration\n\n```typescript\nclass Statusbar {\n  static overlaysWebView(isOverlay: boolean): void;\n  static styleDefault(): void;\n  static styleLightContent(): void;\n  static styleBlackTranslucent(): void;\n  static styleBlackOpaque(): void;\n  static backgroundColorByName(color: string): void;\n  static backgroundColorByHexString(color: string): void;\n  static show(): void;\n  static hide(): void;\n  static isVisible(): boolean;\n  static warnPluginIsUnInstallOrIncompatible(): void;\n  static changeThemeColor(color: string): void;\n}\n```\n\n### Usages\n\n```typescript\nimport Statusbar from '@awesome-cordova-library/statusbar';\n\n/**\n * On iOS 7, make the statusbar overlay or not overlay the WebView.\n *\n * @param isOverlay - On iOS 7, set to false to make the statusbar appear like iOS 6.\n *                    Set the style and background color to suit using the other functions.\n */\nStatusbar.overlaysWebView(true);\n/**\n * Use the default statusbar (dark text, for light backgrounds).\n */\nStatusbar.styleDefault();\n/**\n * Use the lightContent statusbar (light text, for dark backgrounds).\n */\nStatusbar.styleLightContent();\n/**\n * Use the blackTranslucent statusbar (light text, for dark backgrounds).\n */\nStatusbar.styleBlackTranslucent();\n/**\n * Use the blackOpaque statusbar (light text, for dark backgrounds).\n */\nStatusbar.styleBlackOpaque();\n/**\n   * On iOS 7, when you set StatusBar.statusBarOverlaysWebView to false,\n   * you can set the background color of the statusbar by color name.\n   *\n   * @param color - Supported color names are:\n   *                black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown\n*/\nStatusbar.backgroundColorByName(color: string);\n/**\n   * Sets the background color of the statusbar by a hex string.\n   *\n   * @param color - CSS shorthand properties are also supported.\n   *                On iOS 7, when you set StatusBar.statusBarOverlaysWebView to false, you can set the background color of the statusbar by a hex string (#RRGGBB).\n   *                On WP7 and WP8 you can also specify values as #AARRGGBB, where AA is an alpha value\n*/\nStatusbar.backgroundColorByHexString(color: string);\n/**\n * Shows the statusbar.\n*/\nStatusbar.show();\n/**\n * Hide the statusbar.\n*/\nStatusbar.hide();\n/**\n * Read this property to see if the statusbar is visible or not.\n */\nStatusbar.isVisible();\n/**\n * Sets color of meta balise theme-color\n*/\nStatusbar.changeThemeColor(color: string);\n```\n\n## React\n\n### Declaration\n\n```typescript\nconst useStatusbar: () => {\n  overlaysWebView: (isOverlay: boolean) => void;\n  styleDefault: () => void;\n  styleLightContent: () => void;\n  styleBlackTranslucent: () => void;\n  styleBlackOpaque: () => void;\n  backgroundColorByName: (color: string) => void;\n  backgroundColorByHexString: (color: string) => void;\n  hide: () => void;\n  show: () => void;\n  isVisible: () => boolean;\n};\n```\n\n### Usages\n\n```typescript\nimport { useEffect } from \"react\";\nimport useStatusbar from \"@awesome-cordova-library/statusbar/lib/react\";\n\nfunction App() {\n  const {\n    overlaysWebView,\n    styleDefault,\n    styleLightContent,\n    styleBlackTranslucent,\n    styleBlackOpaque,\n    backgroundColorByName,\n    backgroundColorByHexString,\n    hide,\n    show,\n    isVisible,\n  } = useStatusbar();\n\n  useEffect(() => {\n    styleDefault();\n    overlaysWebView(false);\n    backgroundColorByHexString(\"#FFA500\");\n  }, []);\n\n  return <div />;\n}\n```\n","readmeFilename":"README.md"}