❤
npm
Sign UpSign In

react-osm-auth

0.1.2 • Public • Published

react-osm-auth Build Status

A React component for authentication with OpenStreetMap. This is based on osm-auth created by osmlab.

Installation

npm install react-osm-auth --save

Usage

import  ReactOSMAuth from 'react-osm-auth';
 
const options = {
    url : 'https://master.apis.dev.openstreetmap.org',
    oauth_consumer_key: 'your consumer key',
    oauth_secret: 'your secret key',
    auto: true,
};
 
 
class Test extends React.Component {
    
  onAuthenticated(details){
          console.log('details',details) // an XML DOM of user details
  }
  
  authInstance(authInstance){
      console.log('>>>',authInstance) // authInstance of osm-auth
  }
  
  render() {
          return (
              <div>
                  <ReactOSMAuth {...options} onAuthenticated={this.onAuthenticated.bind(this)} authInstance={this.authInstance.bind(this)}/>
              </div>
          );
      }
}

This component exposes 'onAuthenticated' method to handle user details on authentication. 'authInstance' method acquires instance of osm-auth through which all original APIs in 'osmlab/osm-auth' can be consumed. For eg:

    authInstance.xhr({
        method: 'GET',
        path: '/api/0.6/user/details'
    }, function(err, details) {
        ...
    });

Required Landing page

For this component to work(as with osm-auth by osmlab) , you need to add a HTML landing page for the Auth Popup. The default name for the popup is 'land.html' and is also included in this repo. Add that html file in the same directory where your 'index.html' for the app resides. The "land.html" page should have the following content.

<!DOCTYPE html>
<html><head></head>
    <body>
        <script>
            opener.authComplete(window.location.href);
            window.close();
        </script> 
    </body>
</html>

Available methods

name type description
onAuthenticated function Invoked on successful authentication of user
authInstance function Acquires access to osm-auth instance

Readme

Keywords

none

Package Sidebar

Install

npm i react-osm-auth

Repository

github.com/drklrd/react-osm-auth

Homepage

github.com/drklrd/react-osm-auth#readme

Weekly Downloads

6

Version

0.1.2

License

none

Last publish

Collaborators

  • drklrd
Try on RunKit
Report malware