useismobile

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

useIsMobile is a custom hook for React. It gives you a boolean for the screen is mobile or not.

(back to top)

Built With

• React.js
• Babel
• Jest
• Semantic Release

(back to top)

Getting Started

Prerequisites

React and ReactDOM must be installed in your project.

• npm

  npm install react react-dom

Installation

1. Install via npm

   npm install useismobile

2. Install via yarn

   yarn add useismobile

(back to top)

Usage

You can see a basic usage example at codespace demo

(back to top)

Contributing

Any contribution is welcome.

Commitizen standardizes to commit messages, just don't forget to use npm commit command.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Make your changes.
4. Commit your Changes with npm (npm run commit)
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Tufantunc - @tufant

Project Link: https://github.com/tufantunc/useismobile

(back to top)