Device Bars

Add the appropriate device status and navigation bar to your web application and bring your mocks/prototypes/screenshots to the next level.

Demo

Live Demo | Stackblitz

Installation

Option 1: Node Modules

npm install device-bars --save

<!-- index.html -->
<html>
  <head>
    <script src='node_modules/device-bars/dist/device-bars.js'></script>
  </head>
  ...
</html>

Option 2: Script Tag (via `unpkg`)

<!-- index.html -->
<html>
  <head>
    <script type="module" src="https://unpkg.com/[email protected]/dist/device-bars/device-bars.esm.js"></script>
    <script nomodule src="https://unpkg.com/[email protected]/dist/device-bars/device-bars.js"></script>
  </head>
  ...
</html>

Usage

Use the elements <device-status-bar /> and <device-navigation-bar /> anywhere in your template, JSX, html etc

<!-- index.html -->
<html>
  <body>
    <device-status-bar device="iPhone 11" color="#000" background="transparent"></device-status-bar>
    <div id="root"></div>
    <device-navigation-bar device="iPhone 11"></device-navigation-bar>
  </body>
</html>

device-status-bar

Properties

Property	Attribute	Description	Type	Default
`background`	`background`	Sets the background color of the status bar	`string`	`undefined`
`color`	`color`	Set the color of the status bar text	`string`	`undefined`
`date`	`date`	The date to be displayed	`string`	`undefined`
`device`	`device`	Predefined device descriptor name, such as "iPhone X" or "Pixel 2". For a complete list please see: `DEVICES` at ./../utils/device.ts	`string`	`undefined`
`height`	`height`	Sets the height of the navigation bar. By default, the height is derived from the specified device safe-area, but it can also be adjusted manually.	`string`	`undefined`
`hide`	`hide`	Hides the Statusbar	`boolean`	`false`
`inline`	`inline`	Set the Statusbar inline	`boolean`	`false`
`mode`	`mode`	The mode determines which platform styles to use.	`string`	`undefined`
`safeArea`	`safe-area`	Adds an additional safe-area for the status and navigation bar. The respective height is derived from the specified device. By default, the safe-area is implemented via padding on the body. If an element is detected, the css variable --ion-safe-area-* will be set.	`boolean`	`true`
`time`	`time`	The time to be displayed	`string`	`undefined`

CSS Custom Properties

Name	Description
`--background`	Background color of the status bar.
`--color`	Color of the status bar.
`--height`	Height of the status bar.

device-navigation-bar

Properties

Property	Attribute	Description	Type	Default
`background`	`background`	Sets the background color of the navigation bar	`string`	`undefined`
`color`	`color`	Set the color of the navigation bar	`string`	`undefined`
`device`	`device`	Predefined device descriptor name, such as "iPhone X" or "Pixel 2". For a complete list please see: `DEVICES` at ./../utils/device.ts	`string`	`undefined`
`fill`	`fill`	(Android only) Sets the color to fill the icons in the navigation bar.	`string`	`undefined`
`height`	`height`	Sets the height of the navigation bar. By default, the height is derived from the specified device safe-area, but it can also be adjusted manually.	`string`	`undefined`
`hide`	`hide`	Hides the Statusbar	`boolean`	`false`
`inline`	`inline`	Set the Statusbar inline.	`boolean`	`false`
`safeArea`	`safe-area`	Adds an additional safe-area for the status and navigation bar. The respective height is derived from the specified device. By default, the safe-area is implemented via padding on the body. If an element is detected, the css variable --ion-safe-area-* will be set.	`boolean`	`true`

CSS Custom Properties

Name	Description
`--background`	Background color of the status bar.
`--color`	Color of the status bar.
`--fill`	Height of the status bar.
`--height`	Height of the status bar.

Supported Devices

Android

Galaxy Note 3, Galaxy Note 3 landscape
Galaxy Note II, Galaxy Note II landscape
Galaxy S III, Galaxy S III landscape
Galaxy S5, Galaxy S5 landscape
Nexus 10, Nexus 10 landscape
Nexus 4, Nexus 4 landscape
Nexus 5, Nexus 5 landscape, Nexus 5X, Nexus 5X landscape
Nexus 6, Nexus 6 landscape, Nexus 6P, Nexus 6P landscape
Nexus 7, Nexus 7 landscape
Pixel 2, Pixel 2 landscape, Pixel 2 XL, Pixel 2 XL landscape

iOS

iPad (gen 6), iPad (gen 6) landscape
iPad (gen 7), iPad (gen 7) landscape
iPad Mini, iPad Mini landscape
iPad Pro 11, iPad Pro 11 landscape
iPad Pro 13, iPad Pro 13 landscape
iPhone 6, iPhone 6 landscape, iPhone 6 Plus, iPhone 6 Plus landscape
iPhone 7, iPhone 7 landscape, iPhone 7 Plus, iPhone 7 Plus landscape
iPhone 8, iPhone 8 landscape, iPhone 8 Plus, iPhone 8 Plus landscape
iPhone SE, iPhone SE landscape
iPhone X, iPhone X landscape
iPhone XR, iPhone XR landscape
iPhone 11, iPhone 11 landscape
iPhone 11 Pro, iPhone 11 Pro landscape, iPhone 11 Pro Max, iPhone 11 Pro Max landscape

Workspace

Local Development

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

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

npm install
npm start

Build

To build device-bars for production, run:

npm run build

Run Tests

npm test

Repair

This command may be useful when obscure errors or issues are encountered. It removes and recreates dependencies of your project.

npm run repair

Release & Publishing

Run npm run release to create a new build & release with semantic-release. This bumps the version of package.json, uses conventional-changelog to update CHANGELOG.md and references in the README.md, commits package.json, CHANGELOG.md and tags a new release.
The new release gets published to GitHub and npm automatically.

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

Digital Card: npx simongolms
Github: @SimonGolms
Website: gol.ms

Roadmap

Support Status (e.g. Call, GPS, Record)
Angular Component
React Component

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

Resources

The automated release is failing 🚨

🚨 The automated release from the `master` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Cannot push to the Git repository.

semantic-release cannot push the version tag to the branch master on the remote Git repository with URL https://x-access-token:[secure]@github.com/SimonGolms/device-bars.git.

This can be caused by:

a misconfiguration of the repositoryUrl option
the repository being unavailable
or missing push permission for the user configured via the Git credentials on your CI environment

Good luck with your project ✨

Your semantic-release bot 📦🚀

simongolms / device-bars Goto Github PK

device-bars's Introduction

Device Bars

Demo

Installation

Option 1: Node Modules

Option 2: Script Tag (via unpkg)

Usage

device-status-bar

Properties

CSS Custom Properties

device-navigation-bar

Properties

CSS Custom Properties

Supported Devices

Android

iOS

Workspace

Local Development

Build

Run Tests

Repair

Release & Publishing

Further Help

Committing

Author

Roadmap

Contributing

Show Your Support

License

Resources

device-bars's People

Contributors

Stargazers

Watchers

Forkers

device-bars's Issues

🚨 The automated release from the master branch failed. 🚨

Cannot push to the Git repository.

Recommend Projects

Recommend Topics

Recommend Org

Option 2: Script Tag (via `unpkg`)

🚨 The automated release from the `master` branch failed. 🚨